NetBox Platform List
CertifiedEnterprise EditionList platforms from NetBox
NetBox Platform List
List platforms from NetBox
Fetches platforms from NetBox with optional filters, selected fields, and pagination. Defaults to a page size of 100 and fetchType=FETCH. STORE writes results to internal storage and returns a URI, while NONE only reports counts.
type: io.kestra.plugin.ee.netbox.platform.ListExamples
List Cisco IOS-XE platforms.
id: list_ios_xe_platforms
namespace: company.team
tasks:
- id: list_platforms
type: io.kestra.plugin.ee.netbox.platform.List
url: "{{ secret('NETBOX_URL') }}"
token: "{{ secret('NETBOX_API_TOKEN') }}"
filters:
manufacturer: "cisco"
name__ic: "IOS-XE"
fields:
- "id"
- "name"
- "slug"
- "manufacturer"
fetchType: FETCH
Installation
This Enterprise plugin requires an Enterprise image and access to the plugin registry. Install it with the following command:
kestractl plugins get io.kestra.plugin.ee:plugin-ee-netbox --compatible-for $KESTRA_VERSION For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.
For Kestra CLI, replace LATEST with a specific version or version range to pin the plugin version.
Properties
token *string
NetBox API token
Personal API token sent as Authorization: Token <value> for all requests.
url *string
NetBox base URL
Base URL of the NetBox instance (for example: https://netbox.example.com). Must be reachable from the worker; trailing slash is optional.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150fetchType string
FETCHSTOREFETCHFETCH_ONENONEFetch type
FETCH_ONE outputs the first row, FETCH outputs all rows, STORE saves rows to internal storage and returns a URI, NONE returns only counts. Defaults to FETCH. FETCH keeps every row in the execution outputs, so use STORE for large or unfiltered lists.
fields array
Fields
Optional list of fields to request from NetBox, which reduces the payload. When omitted, NetBox returns all fields. Nested objects and custom_fields are returned as maps.
filters object
Filters
Query filters passed to NetBox as-is, using the filter names of the listed object type. Custom field filters use the cf_<name> form. A list value is sent as a repeated key, so name: [a, b] becomes name=a&name=b. Empty map fetches all rows.
limit integerstring
100Page size
Page size of each NetBox request with FETCH and STORE. Minimum 1, defaults to 100. NetBox caps larger values at its MAX_PAGE_SIZE (1000 by default), and all pages are still fetched. FETCH_ONE and NONE make a single one-row request instead. It does not cap the result, so use fetchType: STORE for full inventories.
options
HTTP client configuration
Optional HTTP client overrides (timeouts, TLS, proxies). Uses platform defaults when omitted.
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).
Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.
trueWhether redirects should be followed automatically.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
Retry strategy for HTTP requests.
retry is disabled by default.
Constant retry
Retry with a fixed delay between attempts.
durationRETRY_FAILED_TASKRETRY_FAILED_TASKCREATE_NEW_EXECUTION>= 1durationfalseExponential retry
Retry with exponentially increasing delays between attempts.
durationdurationRETRY_FAILED_TASKRETRY_FAILED_TASKCREATE_NEW_EXECUTION>= 1durationfalseRandom retry
Retry with a random delay within a configurable range between attempts.
durationdurationRETRY_FAILED_TASKRETRY_FAILED_TASKCREATE_NEW_EXECUTION>= 1durationfalse[502,503,504]HTTP status codes that should be retried.
Used for idempotent methods (GET, HEAD) without their own entry in retryOnStatusCodesByMethod. Non-idempotent methods are never retried on a status code unless listed in retryOnStatusCodesByMethod. Defaults to 502, 503 and 504 for idempotent methods (GET, HEAD) only.
Per-HTTP-method overrides for which status codes should be retried.
Keys are HTTP methods (e.g. GET, POST). A method with no entry here falls back to retryOnStatusCodes. This lets a caller retry more broadly for safe, read-only methods (for example, every 5xx and a 429 for GET/HEAD) while keeping a narrower list for methods that write, where retrying a request that may have already been processed by the origin risks duplicating the effect. Example: {GET: [429, 500, 502, 503, 504], HEAD: [429, 500, 502, 503, 504]}.
["GET","HEAD"]HTTP methods for which any transport-level failure may be retried.
A transport-level failure is a connection or timeout error rather than an HTTP response (e.g. a read timeout or a connection reset mid-request). For a method listed here, any such failure is retried. Defaults to GET and HEAD HTTP methods.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
Whether to disable checking of the remote SSL certificate.
Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
Outputs
row object
First row
Populated only when fetchType=FETCH_ONE.
rows array
Fetched rows
Populated only when fetchType=FETCH.
size integer
Rows fetched
Number of rows fetched. With NONE, the number of matching rows, the same as total.
total integer
Total rows available
Total number of rows available without pagination.
uri string
uriStored data URI
Populated only when fetchType=STORE.
