Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

NetBox Labs

NetBox Labs core API

The core API from NetBox Labs — 21 operation(s) for core.

Documentation Provider Profile APIs.io OpenAPI GitHub

NetBox Labs core API is one of 13 APIs that NetBox Labs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include core. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 28 operations across 21 paths, and defines 21 schemas. It is described by OpenAPI 3.0.3, at version 4.6.5 (4.6).

Requests are made against the base URL https://demo.netbox.dev/api/.

28 operations 21 paths 21 schemas 2 DELETE16 GET2 PATCH6 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
4.6.5 (4.6)
Base URL
https://demo.netbox.dev/api/
Authentication
API Key, API Key
License
Apache v2 License
Resource Areas
1

Authentication & Security 2

NetBox Labs core API declares 2 security schemes for authenticating requests. An API key is passed in the cookie as sessionid (cookieAuth). An API key is passed in the header as Authorization (tokenAuth).

  • tokenAuth — Token (v1) or Bearer . (v2)

Paths & Operations 28

Across 21 paths, the API surfaces 28 operations — 2 DELETE, 16 GET, 2 PATCH, 6 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

core 28
GET
/api/core/background-queues/
Retrieve a list of RQ Queues. Note: Queue names are not URL safe, so not returning a detail view.
core_background_queues_retrieve 3 params → 200
GET
/api/core/background-queues/{name}/
Retrieve a list of RQ Queues. Note: Queue names are not URL safe, so not returning a detail view.
core_background_queues_retrieve_by_name 4 params → 200
GET
/api/core/background-tasks/
Retrieve a list of RQ Tasks.
core_background_tasks_retrieve 3 params → 200
GET
/api/core/background-tasks/{id}/
Retrieve a list of RQ Tasks.
core_background_tasks_retrieve_by_id 4 params → 200
POST
/api/core/background-tasks/{id}/delete/
Retrieve a list of RQ Tasks.
core_background_tasks_delete_create 1 param body → 200
POST
/api/core/background-tasks/{id}/enqueue/
Retrieve a list of RQ Tasks.
core_background_tasks_enqueue_create 1 param body → 200
POST
/api/core/background-tasks/{id}/requeue/
Retrieve a list of RQ Tasks.
core_background_tasks_requeue_create 1 param body → 200
POST
/api/core/background-tasks/{id}/stop/
Retrieve a list of RQ Tasks.
core_background_tasks_stop_create 1 param body → 200
GET
/api/core/background-workers/
Retrieve a list of RQ Workers.
core_background_workers_retrieve 3 params → 200
GET
/api/core/background-workers/{name}/
Retrieve a list of RQ Workers.
core_background_workers_retrieve_by_name 4 params → 200
GET
/api/core/data-files/
Get a list of data file objects.
core_data_files_list 69 params → 200
GET
/api/core/data-files/{id}/
Get a data file object.
core_data_files_retrieve 4 params → 200
GET
/api/core/data-sources/
Get a list of data source objects.
core_data_sources_list 129 params → 200
POST
/api/core/data-sources/
Post a list of data source objects.
core_data_sources_create body → 201
PUT
/api/core/data-sources/
Put a list of data source objects.
core_data_sources_bulk_update body → 200
PATCH
/api/core/data-sources/
Patch a list of data source objects.
core_data_sources_bulk_partial_update body → 200
DELETE
/api/core/data-sources/
Delete a list of data source objects.
core_data_sources_bulk_destroy body → 204
GET
/api/core/data-sources/{id}/
Get a data source object.
core_data_sources_retrieve 4 params → 200
PUT
/api/core/data-sources/{id}/
Put a data source object.
core_data_sources_update 1 param body → 200
PATCH
/api/core/data-sources/{id}/
Patch a data source object.
core_data_sources_partial_update 1 param body → 200
DELETE
/api/core/data-sources/{id}/
Delete a data source object.
core_data_sources_destroy 1 param → 204
POST
/api/core/data-sources/{id}/sync/
Enqueue a job to synchronize the DataSource.
core_data_sources_sync_create 1 param body → 200
GET
/api/core/jobs/
Retrieve a list of job results
core_jobs_list 102 params → 200
GET
/api/core/jobs/{id}/
Retrieve a list of job results
core_jobs_retrieve 4 params → 200
GET
/api/core/object-changes/
Retrieve a list of recent changes.
core_object_changes_list 81 params → 200
GET
/api/core/object-changes/{id}/
Retrieve a list of recent changes.
core_object_changes_retrieve 4 params → 200
GET
/api/core/object-types/
Read-only list of ObjectTypes.
core_object_types_list 43 params → 200
GET
/api/core/object-types/{id}/
Read-only list of ObjectTypes.
core_object_types_retrieve 4 params → 200

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are BackgroundTask (27 properties), BackgroundTaskRequest (22 properties), Job (21 properties), DataSource (20 properties). Each schema is shown below with its type and property counts.

PatchedWritableDataSourceRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties
BriefOwnerRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
2 properties 1 required
PaginatedObjectChangeList
object
4 properties 2 required
Job
object
21 properties 13 required
ObjectChange
object
16 properties 16 required
BriefUser
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
4 properties 4 required
WritableDataSourceRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 3 required
BriefDataSource
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 4 required
BackgroundTaskRequest
object
22 properties 22 required
PaginatedJobList
object
4 properties 2 required
PatchedBulkDataSourceRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties 1 required
PaginatedDataSourceList
object
4 properties 2 required
ObjectType
object
13 properties 13 required
DataSource
object
Base serializer class for models inheriting from PrimaryModel.
20 properties 12 required
BackgroundTask
object
27 properties 27 required
PaginatedDataFileList
object
4 properties 2 required
PaginatedObjectTypeList
object
4 properties 2 required
DataFile
object
Adds support for custom fields and tags.
9 properties 9 required
BulkDataSourceRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties 4 required
BriefOwner
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
5 properties 4 required
DataSourceRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbox-labs-core-api-openapi.yml Raw ↑

Other APIs NetBox Labs publishes across the network.

NetBox Labs authentication-check API
AE Profile APIs.io
NetBox Labs circuits API
AE Profile APIs.io
NetBox Labs dcim API
AE Profile APIs.io
NetBox Labs extras API
AE Profile APIs.io
NetBox Labs ipam API
AE Profile APIs.io
NetBox Labs schema API
AE Profile APIs.io
NetBox Labs status API
AE Profile APIs.io
NetBox Labs tenancy API
AE Profile APIs.io
NetBox Labs users API
AE Profile APIs.io
NetBox Labs virtualization API
AE Profile APIs.io
NetBox Labs vpn API
AE Profile APIs.io
NetBox Labs wireless API
AE Profile APIs.io
#core
← Back to N APIs
API Details
ID
netbox-labs:netbox-labs-core-api
Base URL
https://demo.netbox.dev/api/
Docs
https://netboxlabs.com/docs/netbox/integrations/rest-api/
Provider
NetBox Labs
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network