How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
NetBox

NetBox Core API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

NetBox Core API is one of 14 APIs that NetBox 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, API documentation, and authentication docs.

This API exposes 28 operations across 21 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 4.5.9 (4.5).

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

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

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

NetBox 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/
Core background queues retrieve
core_background_queues_retrieve → 200
GET
/api/core/background-queues/{name}/
Core background queues retrieve by name
core_background_queues_retrieve_by_name 1 param → 200
GET
/api/core/background-tasks/
Core background tasks retrieve
core_background_tasks_retrieve → 200
GET
/api/core/background-tasks/{id}/
Core background tasks retrieve by id
core_background_tasks_retrieve_by_id 1 param → 200
POST
/api/core/background-tasks/{id}/delete/
Core background tasks delete create
core_background_tasks_delete_create 1 param body → 200
POST
/api/core/background-tasks/{id}/enqueue/
Core background tasks enqueue create
core_background_tasks_enqueue_create 1 param body → 200
POST
/api/core/background-tasks/{id}/requeue/
Core background tasks requeue create
core_background_tasks_requeue_create 1 param body → 200
POST
/api/core/background-tasks/{id}/stop/
Core background tasks stop create
core_background_tasks_stop_create 1 param body → 200
GET
/api/core/background-workers/
Core background workers retrieve
core_background_workers_retrieve → 200
GET
/api/core/background-workers/{name}/
Core background workers retrieve by name
core_background_workers_retrieve_by_name 1 param → 200
GET
/api/core/data-files/
Core data files list
core_data_files_list 65 params → 200
GET
/api/core/data-files/{id}/
Core data files retrieve
core_data_files_retrieve 1 param → 200
GET
/api/core/data-sources/
Core data sources list
core_data_sources_list 125 params → 200
POST
/api/core/data-sources/
Core data sources create
core_data_sources_create body → 201
PUT
/api/core/data-sources/
Core data sources bulk update
core_data_sources_bulk_update body → 200
PATCH
/api/core/data-sources/
Core data sources bulk partial update
core_data_sources_bulk_partial_update body → 200
DELETE
/api/core/data-sources/
Core data sources bulk destroy
core_data_sources_bulk_destroy body → 204
GET
/api/core/data-sources/{id}/
Core data sources retrieve
core_data_sources_retrieve 1 param → 200
PUT
/api/core/data-sources/{id}/
Core data sources update
core_data_sources_update 1 param body → 200
PATCH
/api/core/data-sources/{id}/
Core data sources partial update
core_data_sources_partial_update 1 param body → 200
DELETE
/api/core/data-sources/{id}/
Core data sources destroy
core_data_sources_destroy 1 param → 204
POST
/api/core/data-sources/{id}/sync/
Core data sources sync create
core_data_sources_sync_create 1 param body → 200
GET
/api/core/jobs/
Core jobs list
core_jobs_list 83 params → 200
GET
/api/core/jobs/{id}/
Core jobs retrieve
core_jobs_retrieve 1 param → 200
GET
/api/core/object-changes/
Core object changes list
core_object_changes_list 77 params → 200
GET
/api/core/object-changes/{id}/
Core object changes retrieve
core_object_changes_retrieve 1 param → 200
GET
/api/core/object-types/
Core object types list
core_object_types_list 39 params → 200
GET
/api/core/object-types/{id}/
Core object types retrieve
core_object_types_retrieve 1 param → 200

Schemas 19

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

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
ObjectType
object
13 properties 13 required
ObjectChange
object
16 properties 16 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
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
PaginatedDataFileList
object
4 properties 2 required
BackgroundTask
object
27 properties 27 required
WritableDataSourceRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 3 required
PatchedWritableDataSourceRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties
PaginatedObjectTypeList
object
4 properties 2 required
BriefDataSource
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 4 required
DataSource
object
Base serializer class for models inheriting from PrimaryModel.
20 properties 12 required
BackgroundTaskRequest
object
22 properties 22 required
PaginatedJobList
object
4 properties 2 required
PaginatedDataSourceList
object
4 properties 2 required
Job
object
20 properties 12 required
DataFile
object
Adds support for custom fields and tags.
9 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbox-core-api-openapi.yml Raw ↑

Other APIs NetBox publishes across the network.

NetBox GraphQL API
AE Profile APIs.io
NetBox Authentication Check API
AE Profile APIs.io
NetBox Circuits API
AE Profile APIs.io
NetBox Dcim API
AE Profile APIs.io
NetBox Extras API
AE Profile APIs.io
NetBox Ipam API
AE Profile APIs.io
NetBox Schema API
AE Profile APIs.io
NetBox Status API
AE Profile APIs.io
NetBox Tenancy API
AE Profile APIs.io
NetBox Users API
AE Profile APIs.io
NetBox Virtualization API
AE Profile APIs.io
NetBox Vpn API
AE Profile APIs.io
#Core
← Back to N APIs
API Details
ID
netbox:netbox-core-api
Base URL
https://demo.netbox.dev/api
Docs
https://docs.netbox.dev/en/stable/
Provider
NetBox
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=netbox-core-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/netbox-core-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of NetBox Core API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.