# NetBox API API

> NetBox API API on Apizie: 386 endpoints (Call to super to allow for caching, POST /circuits/circuit-terminations/, Call to super to allow for caching, PUT /circuits/circuit-terminations/{id}/, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/cloud:netboxdemo/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:netboxdemo`
- Category: Cloud
- Status: byok
- Source: https://netboxdemo.com
- Page: https://www.apizie.tech/api/cloud/netboxdemo
- OpenAPI: https://www.apizie.tech/api/cloud/netboxdemo/openapi.json

API to access NetBox

## Endpoints

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/circuits-circuit-terminations-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| term_side | string | no |  |
| port_speed | string | no |  |
| upstream_speed | string | no |  |
| xconnect_id | string | no |  |
| q | string | no |  |
| circuit_id | string | no |  |
| site_id | string | no |  |
| site | string | no |  |
| term_side__n | string | no |  |
| port_speed__n | string | no |  |
| port_speed__lte | string | no |  |
| port_speed__lt | string | no |  |
| port_speed__gte | string | no |  |
| port_speed__gt | string | no |  |
| upstream_speed__n | string | no |  |
| upstream_speed__lte | string | no |  |
| upstream_speed__lt | string | no |  |
| upstream_speed__gte | string | no |  |
| upstream_speed__gt | string | no |  |
| xconnect_id__n | string | no |  |
| xconnect_id__ic | string | no |  |
| xconnect_id__nic | string | no |  |
| xconnect_id__iew | string | no |  |
| xconnect_id__niew | string | no |  |
| xconnect_id__isw | string | no |  |
| xconnect_id__nisw | string | no |  |
| xconnect_id__ie | string | no |  |
| xconnect_id__nie | string | no |  |
| circuit_id__n | string | no |  |
| site_id__n | string | no |  |
| site__n | string | no |  |
| limit | integer | no | Number of results to return per page. |
| offset | integer | no | The initial index from which to return the results. |

### POST /circuits/circuit-terminations/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/circuits-circuit-terminations-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/circuits-circuit-terminations-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this circuit termination. |

### PUT /circuits/circuit-terminations/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/circuits-circuit-terminations-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this circuit termination. |
| body | object | yes | JSON request body |

### PATCH /circuits/circuit-terminations/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/circuits-circuit-terminations-partial-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this circuit termination. |
| body | object | yes | JSON request body |

### DELETE /circuits/circuit-terminations/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/circuits-circuit-terminations-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this circuit termination. |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/circuits-circuit-types-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no |  |
| name | string | no |  |
| slug | string | no |  |
| q | string | no |  |
| id__n | string | no |  |
| id__lte | string | no |  |
| id__lt | string | no |  |
| id__gte | string | no |  |
| id__gt | string | no |  |
| name__n | string | no |  |
| name__ic | string | no |  |
| name__nic | string | no |  |
| name__iew | string | no |  |
| name__niew | string | no |  |
| name__isw | string | no |  |
| name__nisw | string | no |  |
| name__ie | string | no |  |
| name__nie | string | no |  |
| slug__n | string | no |  |
| slug__ic | string | no |  |
| slug__nic | string | no |  |
| slug__iew | string | no |  |
| slug__niew | string | no |  |
| slug__isw | string | no |  |
| slug__nisw | string | no |  |
| slug__ie | string | no |  |
| slug__nie | string | no |  |
| limit | integer | no | Number of results to return per page. |
| offset | integer | no | The initial index from which to return the results. |

### POST /circuits/circuit-types/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/circuits-circuit-types-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/circuits-circuit-types-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this circuit type. |

### PUT /circuits/circuit-types/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/circuits-circuit-types-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this circuit type. |
| body | object | yes | JSON request body |

### PATCH /circuits/circuit-types/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/circuits-circuit-types-partial-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this circuit type. |
| body | object | yes | JSON request body |

### DELETE /circuits/circuit-types/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/circuits-circuit-types-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this circuit type. |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/circuits-circuits-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no |  |
| cid | string | no |  |
| install_date | string | no |  |
| commit_rate | string | no |  |
| tenant_group_id | string | no |  |
| tenant_group | string | no |  |
| tenant_id | string | no |  |
| tenant | string | no |  |
| created | string | no |  |
| created__gte | string | no |  |
| created__lte | string | no |  |
| last_updated | string | no |  |
| last_updated__gte | string | no |  |
| last_updated__lte | string | no |  |
| q | string | no |  |
| provider_id | string | no |  |
| provider | string | no |  |
| type_id | string | no |  |
| type | string | no |  |
| status | string | no |  |
| site_id | string | no |  |
| site | string | no |  |
| region_id | string | no |  |
| region | string | no |  |
| tag | string | no |  |
| id__n | string | no |  |
| id__lte | string | no |  |
| id__lt | string | no |  |
| id__gte | string | no |  |
| id__gt | string | no |  |
| cid__n | string | no |  |
| cid__ic | string | no |  |
| cid__nic | string | no |  |
| cid__iew | string | no |  |
| cid__niew | string | no |  |
| cid__isw | string | no |  |
| cid__nisw | string | no |  |
| cid__ie | string | no |  |
| cid__nie | string | no |  |
| install_date__n | string | no |  |
| install_date__lte | string | no |  |
| install_date__lt | string | no |  |
| install_date__gte | string | no |  |
| install_date__gt | string | no |  |
| commit_rate__n | string | no |  |
| commit_rate__lte | string | no |  |
| commit_rate__lt | string | no |  |
| commit_rate__gte | string | no |  |
| commit_rate__gt | string | no |  |
| tenant_group_id__n | string | no |  |
| tenant_group__n | string | no |  |
| tenant_id__n | string | no |  |
| tenant__n | string | no |  |
| provider_id__n | string | no |  |
| provider__n | string | no |  |
| type_id__n | string | no |  |
| type__n | string | no |  |
| status__n | string | no |  |
| site_id__n | string | no |  |
| site__n | string | no |  |
| region_id__n | string | no |  |
| region__n | string | no |  |
| tag__n | string | no |  |
| limit | integer | no | Number of results to return per page. |
| offset | integer | no | The initial index from which to return the results. |

### POST /circuits/circuits/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/circuits-circuits-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/circuits-circuits-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this circuit. |

### PUT /circuits/circuits/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/circuits-circuits-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this circuit. |
| body | object | yes | JSON request body |

### PATCH /circuits/circuits/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/circuits-circuits-partial-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this circuit. |
| body | object | yes | JSON request body |

### DELETE /circuits/circuits/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/circuits-circuits-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this circuit. |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/circuits-providers-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no |  |
| name | string | no |  |
| slug | string | no |  |
| asn | string | no |  |
| account | string | no |  |
| created | string | no |  |
| created__gte | string | no |  |
| created__lte | string | no |  |
| last_updated | string | no |  |
| last_updated__gte | string | no |  |
| last_updated__lte | string | no |  |
| q | string | no |  |
| region_id | string | no |  |
| region | string | no |  |
| site_id | string | no |  |
| site | string | no |  |
| tag | string | no |  |
| id__n | string | no |  |
| id__lte | string | no |  |
| id__lt | string | no |  |
| id__gte | string | no |  |
| id__gt | string | no |  |
| name__n | string | no |  |
| name__ic | string | no |  |
| name__nic | string | no |  |
| name__iew | string | no |  |
| name__niew | string | no |  |
| name__isw | string | no |  |
| name__nisw | string | no |  |
| name__ie | string | no |  |
| name__nie | string | no |  |
| slug__n | string | no |  |
| slug__ic | string | no |  |
| slug__nic | string | no |  |
| slug__iew | string | no |  |
| slug__niew | string | no |  |
| slug__isw | string | no |  |
| slug__nisw | string | no |  |
| slug__ie | string | no |  |
| slug__nie | string | no |  |
| asn__n | string | no |  |
| asn__lte | string | no |  |
| asn__lt | string | no |  |
| asn__gte | string | no |  |
| asn__gt | string | no |  |
| account__n | string | no |  |
| account__ic | string | no |  |
| account__nic | string | no |  |
| account__iew | string | no |  |
| account__niew | string | no |  |
| account__isw | string | no |  |
| account__nisw | string | no |  |
| account__ie | string | no |  |
| account__nie | string | no |  |
| region_id__n | string | no |  |
| region__n | string | no |  |
| site_id__n | string | no |  |
| site__n | string | no |  |
| tag__n | string | no |  |
| limit | integer | no | Number of results to return per page. |
| offset | integer | no | The initial index from which to return the results. |

### POST /circuits/providers/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/circuits-providers-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/circuits-providers-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this provider. |

### PUT /circuits/providers/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/circuits-providers-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this provider. |
| body | object | yes | JSON request body |

### PATCH /circuits/providers/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/circuits-providers-partial-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this provider. |
| body | object | yes | JSON request body |

### DELETE /circuits/providers/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/circuits-providers-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this provider. |

### A convenience method for rendering graphs for a particular provider.
`GET https://www.apizie.tech/v1/cloud:netboxdemo/circuits-providers-graphs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this provider. |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-cables-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no |  |
| label | string | no |  |
| length | string | no |  |
| length_unit | string | no |  |
| q | string | no |  |
| type | string | no |  |
| status | string | no |  |
| color | string | no |  |
| device_id | string | no |  |
| device | string | no |  |
| rack_id | string | no |  |
| rack | string | no |  |
| site_id | string | no |  |
| site | string | no |  |
| tenant_id | string | no |  |
| tenant | string | no |  |
| id__n | string | no |  |
| id__lte | string | no |  |
| id__lt | string | no |  |
| id__gte | string | no |  |
| id__gt | string | no |  |
| label__n | string | no |  |
| label__ic | string | no |  |
| label__nic | string | no |  |
| label__iew | string | no |  |
| label__niew | string | no |  |
| label__isw | string | no |  |
| label__nisw | string | no |  |
| label__ie | string | no |  |
| label__nie | string | no |  |
| length__n | string | no |  |
| length__lte | string | no |  |
| length__lt | string | no |  |
| length__gte | string | no |  |
| length__gt | string | no |  |
| length_unit__n | string | no |  |
| type__n | string | no |  |
| status__n | string | no |  |
| color__n | string | no |  |
| limit | integer | no | Number of results to return per page. |
| offset | integer | no | The initial index from which to return the results. |

### POST /dcim/cables/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-cables-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-cables-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this cable. |

### PUT /dcim/cables/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-cables-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this cable. |
| body | object | yes | JSON request body |

### PATCH /dcim/cables/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-cables-partial-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this cable. |
| body | object | yes | JSON request body |

### DELETE /dcim/cables/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-cables-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this cable. |

### This endpoint allows a user to determine what device (if any) is connected to a given peer device and peer…
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-connected-device-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| peer_device | string | yes | The name of the peer device |
| peer_interface | string | yes | The name of the peer interface |

### GET /dcim/console-connections/
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-connections-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | no |  |
| connection_status | string | no |  |
| site | string | no |  |
| device_id | string | no |  |
| device | string | no |  |
| name__n | string | no |  |
| name__ic | string | no |  |
| name__nic | string | no |  |
| name__iew | string | no |  |
| name__niew | string | no |  |
| name__isw | string | no |  |
| name__nisw | string | no |  |
| name__ie | string | no |  |
| name__nie | string | no |  |
| connection_status__n | string | no |  |
| limit | integer | no | Number of results to return per page. |
| offset | integer | no | The initial index from which to return the results. |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-port-templates-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no |  |
| name | string | no |  |
| type | string | no |  |
| q | string | no |  |
| devicetype_id | string | no |  |
| id__n | string | no |  |
| id__lte | string | no |  |
| id__lt | string | no |  |
| id__gte | string | no |  |
| id__gt | string | no |  |
| name__n | string | no |  |
| name__ic | string | no |  |
| name__nic | string | no |  |
| name__iew | string | no |  |
| name__niew | string | no |  |
| name__isw | string | no |  |
| name__nisw | string | no |  |
| name__ie | string | no |  |
| name__nie | string | no |  |
| type__n | string | no |  |
| devicetype_id__n | string | no |  |
| limit | integer | no | Number of results to return per page. |
| offset | integer | no | The initial index from which to return the results. |

### POST /dcim/console-port-templates/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-port-templates-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-port-templates-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this console port template. |

### PUT /dcim/console-port-templates/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-port-templates-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this console port template. |
| body | object | yes | JSON request body |

### PATCH /dcim/console-port-templates/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-port-templates-partial-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this console port template. |
| body | object | yes | JSON request body |

### DELETE /dcim/console-port-templates/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-port-templates-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this console port template. |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-ports-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no |  |
| name | string | no |  |
| description | string | no |  |
| connection_status | string | no |  |
| q | string | no |  |
| region_id | string | no |  |
| region | string | no |  |
| site_id | string | no |  |
| site | string | no |  |
| device_id | string | no |  |
| device | string | no |  |
| tag | string | no |  |
| type | string | no |  |
| cabled | string | no |  |
| id__n | string | no |  |
| id__lte | string | no |  |
| id__lt | string | no |  |
| id__gte | string | no |  |
| id__gt | string | no |  |
| name__n | string | no |  |
| name__ic | string | no |  |
| name__nic | string | no |  |
| name__iew | string | no |  |
| name__niew | string | no |  |
| name__isw | string | no |  |
| name__nisw | string | no |  |
| name__ie | string | no |  |
| name__nie | string | no |  |
| description__n | string | no |  |
| description__ic | string | no |  |
| description__nic | string | no |  |
| description__iew | string | no |  |
| description__niew | string | no |  |
| description__isw | string | no |  |
| description__nisw | string | no |  |
| description__ie | string | no |  |
| description__nie | string | no |  |
| connection_status__n | string | no |  |
| region_id__n | string | no |  |
| region__n | string | no |  |
| site_id__n | string | no |  |
| site__n | string | no |  |
| device_id__n | string | no |  |
| device__n | string | no |  |
| tag__n | string | no |  |
| type__n | string | no |  |
| limit | integer | no | Number of results to return per page. |
| offset | integer | no | The initial index from which to return the results. |

### POST /dcim/console-ports/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-ports-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-ports-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this console port. |

### PUT /dcim/console-ports/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-ports-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this console port. |
| body | object | yes | JSON request body |

### PATCH /dcim/console-ports/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-ports-partial-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this console port. |
| body | object | yes | JSON request body |

### DELETE /dcim/console-ports/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-ports-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this console port. |

### Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-ports-trace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this console port. |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-server-port-templates-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no |  |
| name | string | no |  |
| type | string | no |  |
| q | string | no |  |
| devicetype_id | string | no |  |
| id__n | string | no |  |
| id__lte | string | no |  |
| id__lt | string | no |  |
| id__gte | string | no |  |
| id__gt | string | no |  |
| name__n | string | no |  |
| name__ic | string | no |  |
| name__nic | string | no |  |
| name__iew | string | no |  |
| name__niew | string | no |  |
| name__isw | string | no |  |
| name__nisw | string | no |  |
| name__ie | string | no |  |
| name__nie | string | no |  |
| type__n | string | no |  |
| devicetype_id__n | string | no |  |
| limit | integer | no | Number of results to return per page. |
| offset | integer | no | The initial index from which to return the results. |

### POST /dcim/console-server-port-templates/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-server-port-templates-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-server-port-templates-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this console server port template. |

### PUT /dcim/console-server-port-templates/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-server-port-templates-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this console server port template. |
| body | object | yes | JSON request body |

### PATCH /dcim/console-server-port-templates/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-server-port-templates-partial-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this console server port template. |
| body | object | yes | JSON request body |

### DELETE /dcim/console-server-port-templates/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-server-port-templates-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this console server port template. |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-server-ports-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no |  |
| name | string | no |  |
| description | string | no |  |
| connection_status | string | no |  |
| q | string | no |  |
| region_id | string | no |  |
| region | string | no |  |
| site_id | string | no |  |
| site | string | no |  |
| device_id | string | no |  |
| device | string | no |  |
| tag | string | no |  |
| type | string | no |  |
| cabled | string | no |  |
| id__n | string | no |  |
| id__lte | string | no |  |
| id__lt | string | no |  |
| id__gte | string | no |  |
| id__gt | string | no |  |
| name__n | string | no |  |
| name__ic | string | no |  |
| name__nic | string | no |  |
| name__iew | string | no |  |
| name__niew | string | no |  |
| name__isw | string | no |  |
| name__nisw | string | no |  |
| name__ie | string | no |  |
| name__nie | string | no |  |
| description__n | string | no |  |
| description__ic | string | no |  |
| description__nic | string | no |  |
| description__iew | string | no |  |
| description__niew | string | no |  |
| description__isw | string | no |  |
| description__nisw | string | no |  |
| description__ie | string | no |  |
| description__nie | string | no |  |
| connection_status__n | string | no |  |
| region_id__n | string | no |  |
| region__n | string | no |  |
| site_id__n | string | no |  |
| site__n | string | no |  |
| device_id__n | string | no |  |
| device__n | string | no |  |
| tag__n | string | no |  |
| type__n | string | no |  |
| limit | integer | no | Number of results to return per page. |
| offset | integer | no | The initial index from which to return the results. |

### POST /dcim/console-server-ports/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-server-ports-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-server-ports-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this console server port. |

### PUT /dcim/console-server-ports/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-server-ports-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this console server port. |
| body | object | yes | JSON request body |

### PATCH /dcim/console-server-ports/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-server-ports-partial-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this console server port. |
| body | object | yes | JSON request body |

### DELETE /dcim/console-server-ports/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-server-ports-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this console server port. |

### Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-console-server-ports-trace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this console server port. |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-device-bay-templates-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no |  |
| name | string | no |  |
| q | string | no |  |
| devicetype_id | string | no |  |
| id__n | string | no |  |
| id__lte | string | no |  |
| id__lt | string | no |  |
| id__gte | string | no |  |
| id__gt | string | no |  |
| name__n | string | no |  |
| name__ic | string | no |  |
| name__nic | string | no |  |
| name__iew | string | no |  |
| name__niew | string | no |  |
| name__isw | string | no |  |
| name__nisw | string | no |  |
| name__ie | string | no |  |
| name__nie | string | no |  |
| devicetype_id__n | string | no |  |
| limit | integer | no | Number of results to return per page. |
| offset | integer | no | The initial index from which to return the results. |

### POST /dcim/device-bay-templates/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-device-bay-templates-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-device-bay-templates-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this device bay template. |

### PUT /dcim/device-bay-templates/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-device-bay-templates-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this device bay template. |
| body | object | yes | JSON request body |

### PATCH /dcim/device-bay-templates/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-device-bay-templates-partial-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this device bay template. |
| body | object | yes | JSON request body |

### DELETE /dcim/device-bay-templates/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-device-bay-templates-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this device bay template. |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-device-bays-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no |  |
| name | string | no |  |
| description | string | no |  |
| q | string | no |  |
| region_id | string | no |  |
| region | string | no |  |
| site_id | string | no |  |
| site | string | no |  |
| device_id | string | no |  |
| device | string | no |  |
| tag | string | no |  |
| id__n | string | no |  |
| id__lte | string | no |  |
| id__lt | string | no |  |
| id__gte | string | no |  |
| id__gt | string | no |  |
| name__n | string | no |  |
| name__ic | string | no |  |
| name__nic | string | no |  |
| name__iew | string | no |  |
| name__niew | string | no |  |
| name__isw | string | no |  |
| name__nisw | string | no |  |
| name__ie | string | no |  |
| name__nie | string | no |  |
| description__n | string | no |  |
| description__ic | string | no |  |
| description__nic | string | no |  |
| description__iew | string | no |  |
| description__niew | string | no |  |
| description__isw | string | no |  |
| description__nisw | string | no |  |
| description__ie | string | no |  |
| description__nie | string | no |  |
| region_id__n | string | no |  |
| region__n | string | no |  |
| site_id__n | string | no |  |
| site__n | string | no |  |
| device_id__n | string | no |  |
| device__n | string | no |  |
| tag__n | string | no |  |
| limit | integer | no | Number of results to return per page. |
| offset | integer | no | The initial index from which to return the results. |

### POST /dcim/device-bays/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-device-bays-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-device-bays-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this device bay. |

### PUT /dcim/device-bays/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-device-bays-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this device bay. |
| body | object | yes | JSON request body |

### PATCH /dcim/device-bays/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-device-bays-partial-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this device bay. |
| body | object | yes | JSON request body |

### DELETE /dcim/device-bays/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-device-bays-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this device bay. |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-device-roles-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no |  |
| name | string | no |  |
| slug | string | no |  |
| color | string | no |  |
| vm_role | string | no |  |
| q | string | no |  |
| id__n | string | no |  |
| id__lte | string | no |  |
| id__lt | string | no |  |
| id__gte | string | no |  |
| id__gt | string | no |  |
| name__n | string | no |  |
| name__ic | string | no |  |
| name__nic | string | no |  |
| name__iew | string | no |  |
| name__niew | string | no |  |
| name__isw | string | no |  |
| name__nisw | string | no |  |
| name__ie | string | no |  |
| name__nie | string | no |  |
| slug__n | string | no |  |
| slug__ic | string | no |  |
| slug__nic | string | no |  |
| slug__iew | string | no |  |
| slug__niew | string | no |  |
| slug__isw | string | no |  |
| slug__nisw | string | no |  |
| slug__ie | string | no |  |
| slug__nie | string | no |  |
| color__n | string | no |  |
| color__ic | string | no |  |
| color__nic | string | no |  |
| color__iew | string | no |  |
| color__niew | string | no |  |
| color__isw | string | no |  |
| color__nisw | string | no |  |
| color__ie | string | no |  |
| color__nie | string | no |  |
| limit | integer | no | Number of results to return per page. |
| offset | integer | no | The initial index from which to return the results. |

### POST /dcim/device-roles/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-device-roles-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-device-roles-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this device role. |

### PUT /dcim/device-roles/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-device-roles-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this device role. |
| body | object | yes | JSON request body |

### PATCH /dcim/device-roles/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-device-roles-partial-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this device role. |
| body | object | yes | JSON request body |

### DELETE /dcim/device-roles/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-device-roles-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this device role. |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-device-types-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no |  |
| model | string | no |  |
| slug | string | no |  |
| part_number | string | no |  |
| u_height | string | no |  |
| is_full_depth | string | no |  |
| subdevice_role | string | no |  |
| created | string | no |  |
| created__gte | string | no |  |
| created__lte | string | no |  |
| last_updated | string | no |  |
| last_updated__gte | string | no |  |
| last_updated__lte | string | no |  |
| q | string | no |  |
| manufacturer_id | string | no |  |
| manufacturer | string | no |  |
| console_ports | string | no |  |
| console_server_ports | string | no |  |
| power_ports | string | no |  |
| power_outlets | string | no |  |
| interfaces | string | no |  |
| pass_through_ports | string | no |  |
| device_bays | string | no |  |
| tag | string | no |  |
| id__n | string | no |  |
| id__lte | string | no |  |
| id__lt | string | no |  |
| id__gte | string | no |  |
| id__gt | string | no |  |
| model__n | string | no |  |
| model__ic | string | no |  |
| model__nic | string | no |  |
| model__iew | string | no |  |
| model__niew | string | no |  |
| model__isw | string | no |  |
| model__nisw | string | no |  |
| model__ie | string | no |  |
| model__nie | string | no |  |
| slug__n | string | no |  |
| slug__ic | string | no |  |
| slug__nic | string | no |  |
| slug__iew | string | no |  |
| slug__niew | string | no |  |
| slug__isw | string | no |  |
| slug__nisw | string | no |  |
| slug__ie | string | no |  |
| slug__nie | string | no |  |
| part_number__n | string | no |  |
| part_number__ic | string | no |  |
| part_number__nic | string | no |  |
| part_number__iew | string | no |  |
| part_number__niew | string | no |  |
| part_number__isw | string | no |  |
| part_number__nisw | string | no |  |
| part_number__ie | string | no |  |
| part_number__nie | string | no |  |
| u_height__n | string | no |  |
| u_height__lte | string | no |  |
| u_height__lt | string | no |  |
| u_height__gte | string | no |  |
| u_height__gt | string | no |  |
| subdevice_role__n | string | no |  |
| manufacturer_id__n | string | no |  |
| manufacturer__n | string | no |  |
| tag__n | string | no |  |
| limit | integer | no | Number of results to return per page. |
| offset | integer | no | The initial index from which to return the results. |

### POST /dcim/device-types/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-device-types-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-device-types-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this device type. |

### PUT /dcim/device-types/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-device-types-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this device type. |
| body | object | yes | JSON request body |

### PATCH /dcim/device-types/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-device-types-partial-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this device type. |
| body | object | yes | JSON request body |

### DELETE /dcim/device-types/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-device-types-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this device type. |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-devices-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no |  |
| name | string | no |  |
| asset_tag | string | no |  |
| face | string | no |  |
| position | string | no |  |
| vc_position | string | no |  |
| vc_priority | string | no |  |
| tenant_group_id | string | no |  |
| tenant_group | string | no |  |
| tenant_id | string | no |  |
| tenant | string | no |  |
| local_context_data | string | no |  |
| created | string | no |  |
| created__gte | string | no |  |
| created__lte | string | no |  |
| last_updated | string | no |  |
| last_updated__gte | string | no |  |
| last_updated__lte | string | no |  |
| q | string | no |  |
| manufacturer_id | string | no |  |
| manufacturer | string | no |  |
| device_type_id | string | no |  |
| role_id | string | no |  |
| role | string | no |  |
| platform_id | string | no |  |
| platform | string | no |  |
| region_id | string | no |  |
| region | string | no |  |
| site_id | string | no |  |
| site | string | no |  |
| rack_group_id | string | no |  |
| rack_id | string | no |  |
| cluster_id | string | no |  |
| model | string | no |  |
| status | string | no |  |
| is_full_depth | string | no |  |
| mac_address | string | no |  |
| serial | string | no |  |
| has_primary_ip | string | no |  |
| virtual_chassis_id | string | no |  |
| virtual_chassis_member | string | no |  |
| console_ports | string | no |  |
| console_server_ports | string | no |  |
| power_ports | string | no |  |
| power_outlets | string | no |  |
| interfaces | string | no |  |
| pass_through_ports | string | no |  |
| device_bays | string | no |  |
| tag | string | no |  |
| id__n | string | no |  |
| id__lte | string | no |  |
| id__lt | string | no |  |
| id__gte | string | no |  |
| id__gt | string | no |  |
| name__n | string | no |  |
| name__ic | string | no |  |
| name__nic | string | no |  |
| name__iew | string | no |  |
| name__niew | string | no |  |
| name__isw | string | no |  |
| name__nisw | string | no |  |
| name__ie | string | no |  |
| name__nie | string | no |  |
| asset_tag__n | string | no |  |
| asset_tag__ic | string | no |  |
| asset_tag__nic | string | no |  |
| asset_tag__iew | string | no |  |
| asset_tag__niew | string | no |  |
| asset_tag__isw | string | no |  |
| asset_tag__nisw | string | no |  |
| asset_tag__ie | string | no |  |
| asset_tag__nie | string | no |  |
| face__n | string | no |  |
| position__n | string | no |  |
| position__lte | string | no |  |
| position__lt | string | no |  |
| position__gte | string | no |  |
| position__gt | string | no |  |
| vc_position__n | string | no |  |
| vc_position__lte | string | no |  |
| vc_position__lt | string | no |  |
| vc_position__gte | string | no |  |
| vc_position__gt | string | no |  |
| vc_priority__n | string | no |  |
| vc_priority__lte | string | no |  |
| vc_priority__lt | string | no |  |
| vc_priority__gte | string | no |  |
| vc_priority__gt | string | no |  |
| tenant_group_id__n | string | no |  |
| tenant_group__n | string | no |  |
| tenant_id__n | string | no |  |
| tenant__n | string | no |  |
| manufacturer_id__n | string | no |  |
| manufacturer__n | string | no |  |
| device_type_id__n | string | no |  |
| role_id__n | string | no |  |
| role__n | string | no |  |
| platform_id__n | string | no |  |
| platform__n | string | no |  |
| region_id__n | string | no |  |
| region__n | string | no |  |
| site_id__n | string | no |  |
| site__n | string | no |  |
| rack_group_id__n | string | no |  |
| rack_id__n | string | no |  |
| cluster_id__n | string | no |  |
| model__n | string | no |  |
| status__n | string | no |  |
| mac_address__n | string | no |  |
| mac_address__ic | string | no |  |
| mac_address__nic | string | no |  |
| mac_address__iew | string | no |  |
| mac_address__niew | string | no |  |
| mac_address__isw | string | no |  |
| mac_address__nisw | string | no |  |
| mac_address__ie | string | no |  |
| mac_address__nie | string | no |  |
| virtual_chassis_id__n | string | no |  |
| tag__n | string | no |  |
| limit | integer | no | Number of results to return per page. |
| offset | integer | no | The initial index from which to return the results. |

### POST /dcim/devices/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-devices-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-devices-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this device. |

### PUT /dcim/devices/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-devices-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this device. |
| body | object | yes | JSON request body |

### PATCH /dcim/devices/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-devices-partial-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this device. |
| body | object | yes | JSON request body |

### DELETE /dcim/devices/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-devices-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this device. |

### A convenience method for rendering graphs for a particular Device.
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-devices-graphs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this device. |

### Execute a NAPALM method on a Device
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-devices-napalm` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this device. |
| method | string | yes |  |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-front-port-templates-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no |  |
| name | string | no |  |
| type | string | no |  |
| q | string | no |  |
| devicetype_id | string | no |  |
| id__n | string | no |  |
| id__lte | string | no |  |
| id__lt | string | no |  |
| id__gte | string | no |  |
| id__gt | string | no |  |
| name__n | string | no |  |
| name__ic | string | no |  |
| name__nic | string | no |  |
| name__iew | string | no |  |
| name__niew | string | no |  |
| name__isw | string | no |  |
| name__nisw | string | no |  |
| name__ie | string | no |  |
| name__nie | string | no |  |
| type__n | string | no |  |
| devicetype_id__n | string | no |  |
| limit | integer | no | Number of results to return per page. |
| offset | integer | no | The initial index from which to return the results. |

### POST /dcim/front-port-templates/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-front-port-templates-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-front-port-templates-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this front port template. |

### PUT /dcim/front-port-templates/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-front-port-templates-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this front port template. |
| body | object | yes | JSON request body |

### PATCH /dcim/front-port-templates/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-front-port-templates-partial-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this front port template. |
| body | object | yes | JSON request body |

### DELETE /dcim/front-port-templates/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-front-port-templates-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this front port template. |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-front-ports-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no |  |
| name | string | no |  |
| type | string | no |  |
| description | string | no |  |
| q | string | no |  |
| region_id | string | no |  |
| region | string | no |  |
| site_id | string | no |  |
| site | string | no |  |
| device_id | string | no |  |
| device | string | no |  |
| tag | string | no |  |
| cabled | string | no |  |
| id__n | string | no |  |
| id__lte | string | no |  |
| id__lt | string | no |  |
| id__gte | string | no |  |
| id__gt | string | no |  |
| name__n | string | no |  |
| name__ic | string | no |  |
| name__nic | string | no |  |
| name__iew | string | no |  |
| name__niew | string | no |  |
| name__isw | string | no |  |
| name__nisw | string | no |  |
| name__ie | string | no |  |
| name__nie | string | no |  |
| type__n | string | no |  |
| description__n | string | no |  |
| description__ic | string | no |  |
| description__nic | string | no |  |
| description__iew | string | no |  |
| description__niew | string | no |  |
| description__isw | string | no |  |
| description__nisw | string | no |  |
| description__ie | string | no |  |
| description__nie | string | no |  |
| region_id__n | string | no |  |
| region__n | string | no |  |
| site_id__n | string | no |  |
| site__n | string | no |  |
| device_id__n | string | no |  |
| device__n | string | no |  |
| tag__n | string | no |  |
| limit | integer | no | Number of results to return per page. |
| offset | integer | no | The initial index from which to return the results. |

### POST /dcim/front-ports/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-front-ports-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-front-ports-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this front port. |

### PUT /dcim/front-ports/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-front-ports-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this front port. |
| body | object | yes | JSON request body |

### PATCH /dcim/front-ports/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-front-ports-partial-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this front port. |
| body | object | yes | JSON request body |

### DELETE /dcim/front-ports/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-front-ports-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this front port. |

### Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-front-ports-trace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this front port. |

### GET /dcim/interface-connections/
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-interface-connections-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| connection_status | string | no |  |
| site | string | no |  |
| device_id | string | no |  |
| device | string | no |  |
| connection_status__n | string | no |  |
| limit | integer | no | Number of results to return per page. |
| offset | integer | no | The initial index from which to return the results. |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-interface-templates-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no |  |
| name | string | no |  |
| type | string | no |  |
| mgmt_only | string | no |  |
| q | string | no |  |
| devicetype_id | string | no |  |
| id__n | string | no |  |
| id__lte | string | no |  |
| id__lt | string | no |  |
| id__gte | string | no |  |
| id__gt | string | no |  |
| name__n | string | no |  |
| name__ic | string | no |  |
| name__nic | string | no |  |
| name__iew | string | no |  |
| name__niew | string | no |  |
| name__isw | string | no |  |
| name__nisw | string | no |  |
| name__ie | string | no |  |
| name__nie | string | no |  |
| type__n | string | no |  |
| devicetype_id__n | string | no |  |
| limit | integer | no | Number of results to return per page. |
| offset | integer | no | The initial index from which to return the results. |

### POST /dcim/interface-templates/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-interface-templates-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-interface-templates-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this interface template. |

### PUT /dcim/interface-templates/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-interface-templates-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this interface template. |
| body | object | yes | JSON request body |

### PATCH /dcim/interface-templates/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-interface-templates-partial-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this interface template. |
| body | object | yes | JSON request body |

### DELETE /dcim/interface-templates/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-interface-templates-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this interface template. |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-interfaces-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no |  |
| name | string | no |  |
| connection_status | string | no |  |
| type | string | no |  |
| enabled | string | no |  |
| mtu | string | no |  |
| mgmt_only | string | no |  |
| mode | string | no |  |
| description | string | no |  |
| q | string | no |  |
| region_id | string | no |  |
| region | string | no |  |
| site_id | string | no |  |
| site | string | no |  |
| device_id | string | no |  |
| device | string | no |  |
| tag | string | no |  |
| cabled | string | no |  |
| kind | string | no |  |
| lag_id | string | no |  |
| mac_address | string | no |  |
| vlan_id | string | no |  |
| vlan | string | no |  |
| id__n | string | no |  |
| id__lte | string | no |  |
| id__lt | string | no |  |
| id__gte | string | no |  |
| id__gt | string | no |  |
| name__n | string | no |  |
| name__ic | string | no |  |
| name__nic | string | no |  |
| name__iew | string | no |  |
| name__niew | string | no |  |
| name__isw | string | no |  |
| name__nisw | string | no |  |
| name__ie | string | no |  |
| name__nie | string | no |  |
| connection_status__n | string | no |  |
| type__n | string | no |  |
| mtu__n | string | no |  |
| mtu__lte | string | no |  |
| mtu__lt | string | no |  |
| mtu__gte | string | no |  |
| mtu__gt | string | no |  |
| mode__n | string | no |  |
| description__n | string | no |  |
| description__ic | string | no |  |
| description__nic | string | no |  |
| description__iew | string | no |  |
| description__niew | string | no |  |
| description__isw | string | no |  |
| description__nisw | string | no |  |
| description__ie | string | no |  |
| description__nie | string | no |  |
| region_id__n | string | no |  |
| region__n | string | no |  |
| site_id__n | string | no |  |
| site__n | string | no |  |
| tag__n | string | no |  |
| lag_id__n | string | no |  |
| mac_address__n | string | no |  |
| mac_address__ic | string | no |  |
| mac_address__nic | string | no |  |
| mac_address__iew | string | no |  |
| mac_address__niew | string | no |  |
| mac_address__isw | string | no |  |
| mac_address__nisw | string | no |  |
| mac_address__ie | string | no |  |
| mac_address__nie | string | no |  |
| limit | integer | no | Number of results to return per page. |
| offset | integer | no | The initial index from which to return the results. |

### POST /dcim/interfaces/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-interfaces-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-interfaces-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this interface. |

### PUT /dcim/interfaces/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-interfaces-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this interface. |
| body | object | yes | JSON request body |

### PATCH /dcim/interfaces/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-interfaces-partial-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this interface. |
| body | object | yes | JSON request body |

### DELETE /dcim/interfaces/{id}/
`POST https://www.apizie.tech/v1/cloud:netboxdemo/dcim-interfaces-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this interface. |

### A convenience method for rendering graphs for a particular interface.
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-interfaces-graphs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this interface. |

### Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-interfaces-trace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique integer value identifying this interface. |

### Call to super to allow for caching
`GET https://www.apizie.tech/v1/cloud:netboxdemo/dcim-inventory-items-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no |  |
| name | string | no |  |
| part_id | string | no |  |
| asset_tag | string | no |  |
| discovered | string | no |  |
| q | string | no |  |
| region_id | string | no |  |
| region | string | no |  |
| site_id | string | no |  |
| site | string | no |  |
| device_id | string | no |  |
| device | string | no |  |
| tag | string | no |  |
| parent_id | string | no |  |
| manufacturer_id | string | no |  |
| manufacturer | string | no |  |
| serial | string | no |  |
| id__n | string | no |  |
| id__lte | string | no |  |
| id__lt | string | no |  |
| id__gte | string | no |  |
| id__gt | string | no |  |
| name__n | string | no |  |
| name__ic | string | no |  |
| name__nic | string | no |  |
| name__iew | string | no |  |
| name__niew | string | no |  |
| name__isw | string | no |  |
| name__nisw | string | no |  |
| name__ie | string | no |  |
| name__nie | string | no |  |
| part_id__n | string | no |  |
| part_id__ic | string | no |  |
| part_id__nic | string | no |  |
| part_id__iew | string | no |  |
| part_id__niew | string | no |  |
| part_id__isw | string | no |  |
| part_id__nisw | string | no |  |
| part_id__ie | string | no |  |
| part_id__nie | string | no |  |
| asset_tag__n | string | no |  |
| asset_tag__ic | string | no |  |
| asset_tag__nic | string | no |  |
| asset_tag__iew | string | no |  |
| asset_tag__niew | string | no |  |
| asset_tag__isw | string | no |  |
| asset_tag__nisw | string | no |  |
| asset_tag__ie | string | no |  |
| asset_tag__nie | string | no |  |
| region_id__n | string | no |  |
| region__n | string | no |  |
| site_id__n | string | no |  |
| site__n | string | no |  |
| device_id__n | string | no |  |
| device__n | string | no |  |
| tag__n | string | no |  |
| parent_id__n | string | no |  |
| manufacturer_id__n | string | no |  |
| manufacturer__n | string | no |  |
| limit | integer | no | Number of results to return per page. |
| offset | integer | no | The initial index from which to return the results. |

…and 266 more. See the OpenAPI spec.

## Example
```
curl "https://www.apizie.tech/v1/cloud:netboxdemo/circuits-circuit-terminations-list" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the NetBox API API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/cloud:netboxdemo/circuits-circuit-terminations-list with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the NetBox API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. NetBox API itself also needs your own key from netboxdemo.com.

### Can AI agents use the NetBox API API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:netboxdemo.

### What is the status of the NetBox API API?
Needs your own provider key (bring your own key)