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 users API

The users API from NetBox — 14 operation(s) for users.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 56 operations across 14 paths, and defines 32 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.

56 operations 14 paths 32 schemas 12 DELETE13 GET12 PATCH7 POST12 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 users 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 56

Across 14 paths, the API surfaces 56 operations — 12 DELETE, 13 GET, 12 PATCH, 7 POST, 12 PUT. Each is listed below with its method, path, parameters, and response codes.

users 56
GET
/api/users/config/
An API endpoint via which a user can update his or her own UserConfig data (but no one else's).
users_config_retrieve → 200
GET
/api/users/groups/
Get a list of group objects.
users_groups_list 47 params → 200
POST
/api/users/groups/
Post a list of group objects.
users_groups_create body → 201
PUT
/api/users/groups/
Put a list of group objects.
users_groups_bulk_update body → 200
PATCH
/api/users/groups/
Patch a list of group objects.
users_groups_bulk_partial_update body → 200
DELETE
/api/users/groups/
Delete a list of group objects.
users_groups_bulk_destroy body → 204
GET
/api/users/groups/{id}/
Get a group object.
users_groups_retrieve 1 param → 200
PUT
/api/users/groups/{id}/
Put a group object.
users_groups_update 1 param body → 200
PATCH
/api/users/groups/{id}/
Patch a group object.
users_groups_partial_update 1 param body → 200
DELETE
/api/users/groups/{id}/
Delete a group object.
users_groups_destroy 1 param → 204
GET
/api/users/owner-groups/
Get a list of owner group objects.
users_owner_groups_list 37 params → 200
POST
/api/users/owner-groups/
Post a list of owner group objects.
users_owner_groups_create body → 201
PUT
/api/users/owner-groups/
Put a list of owner group objects.
users_owner_groups_bulk_update body → 200
PATCH
/api/users/owner-groups/
Patch a list of owner group objects.
users_owner_groups_bulk_partial_update body → 200
DELETE
/api/users/owner-groups/
Delete a list of owner group objects.
users_owner_groups_bulk_destroy body → 204
GET
/api/users/owner-groups/{id}/
Get a owner group object.
users_owner_groups_retrieve 1 param → 200
PUT
/api/users/owner-groups/{id}/
Put a owner group object.
users_owner_groups_update 1 param body → 200
PATCH
/api/users/owner-groups/{id}/
Patch a owner group object.
users_owner_groups_partial_update 1 param body → 200
DELETE
/api/users/owner-groups/{id}/
Delete a owner group object.
users_owner_groups_destroy 1 param → 204
GET
/api/users/owners/
Get a list of owner objects.
users_owners_list 49 params → 200
POST
/api/users/owners/
Post a list of owner objects.
users_owners_create body → 201
PUT
/api/users/owners/
Put a list of owner objects.
users_owners_bulk_update body → 200
PATCH
/api/users/owners/
Patch a list of owner objects.
users_owners_bulk_partial_update body → 200
DELETE
/api/users/owners/
Delete a list of owner objects.
users_owners_bulk_destroy body → 204
GET
/api/users/owners/{id}/
Get a owner object.
users_owners_retrieve 1 param → 200
PUT
/api/users/owners/{id}/
Put a owner object.
users_owners_update 1 param body → 200
PATCH
/api/users/owners/{id}/
Patch a owner object.
users_owners_partial_update 1 param body → 200
DELETE
/api/users/owners/{id}/
Delete a owner object.
users_owners_destroy 1 param → 204
GET
/api/users/permissions/
Get a list of permission objects.
users_permissions_list 66 params → 200
POST
/api/users/permissions/
Post a list of permission objects.
users_permissions_create body → 201
PUT
/api/users/permissions/
Put a list of permission objects.
users_permissions_bulk_update body → 200
PATCH
/api/users/permissions/
Patch a list of permission objects.
users_permissions_bulk_partial_update body → 200
DELETE
/api/users/permissions/
Delete a list of permission objects.
users_permissions_bulk_destroy body → 204
GET
/api/users/permissions/{id}/
Get a permission object.
users_permissions_retrieve 1 param → 200
PUT
/api/users/permissions/{id}/
Put a permission object.
users_permissions_update 1 param body → 200
PATCH
/api/users/permissions/{id}/
Patch a permission object.
users_permissions_partial_update 1 param body → 200
DELETE
/api/users/permissions/{id}/
Delete a permission object.
users_permissions_destroy 1 param → 204
GET
/api/users/tokens/
Get a list of token objects.
users_tokens_list 71 params → 200
POST
/api/users/tokens/
Post a list of token objects.
users_tokens_create body → 201
PUT
/api/users/tokens/
Put a list of token objects.
users_tokens_bulk_update body → 200
PATCH
/api/users/tokens/
Patch a list of token objects.
users_tokens_bulk_partial_update body → 200
DELETE
/api/users/tokens/
Delete a list of token objects.
users_tokens_bulk_destroy body → 204
GET
/api/users/tokens/{id}/
Get a token object.
users_tokens_retrieve 1 param → 200
PUT
/api/users/tokens/{id}/
Put a token object.
users_tokens_update 1 param body → 200
PATCH
/api/users/tokens/{id}/
Patch a token object.
users_tokens_partial_update 1 param body → 200
DELETE
/api/users/tokens/{id}/
Delete a token object.
users_tokens_destroy 1 param → 204
POST
/api/users/tokens/provision/
Non-authenticated REST API endpoint via which a user may create a Token.
users_tokens_provision_create body → 201401
GET
/api/users/users/
Get a list of user objects.
users_users_list 91 params → 200
POST
/api/users/users/
Post a list of user objects.
users_users_create body → 201
PUT
/api/users/users/
Put a list of user objects.
users_users_bulk_update body → 200
PATCH
/api/users/users/
Patch a list of user objects.
users_users_bulk_partial_update body → 200
DELETE
/api/users/users/
Delete a list of user objects.
users_users_bulk_destroy body → 204
GET
/api/users/users/{id}/
Get a user object.
users_users_retrieve 1 param → 200
PUT
/api/users/users/{id}/
Put a user object.
users_users_update 1 param body → 200
PATCH
/api/users/users/{id}/
Patch a user object.
users_users_partial_update 1 param body → 200
DELETE
/api/users/users/{id}/
Delete a user object.
users_users_destroy 1 param → 204

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are Token (15 properties), TokenProvision (14 properties), User (13 properties), ObjectPermission (12 properties). Each schema is shown below with its type and property counts.

BriefOwnerGroupRequest
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
ObjectPermissionRequest
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…
8 properties 3 required
Group
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…
8 properties 6 required
PatchedTokenRequest
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…
9 properties
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
Token
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…
15 properties 7 required
GroupRequest
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…
3 properties 1 required
OwnerGroup
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…
7 properties 6 required
TokenProvision
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…
14 properties 8 required
PatchedOwnerRequest
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
PaginatedUserList
object
4 properties 2 required
TokenProvisionRequest
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…
8 properties 2 required
PatchedUserRequest
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…
10 properties
NestedGroup
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
5 properties 5 required
Owner
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…
9 properties 6 required
UserRequest
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…
10 properties 2 required
PaginatedGroupList
object
4 properties 2 required
PaginatedOwnerList
object
4 properties 2 required
PaginatedTokenList
object
4 properties 2 required
PatchedGroupRequest
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…
3 properties
BriefUserRequest
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…
1 property 1 required
BriefOwnerGroup
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
TokenRequest
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…
9 properties 1 required
NestedUser
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
5 properties 5 required
ObjectPermission
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…
12 properties 7 required
PaginatedObjectPermissionList
object
4 properties 2 required
OwnerGroupRequest
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
PatchedOwnerGroupRequest
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
PatchedObjectPermissionRequest
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…
8 properties
PaginatedOwnerGroupList
object
4 properties 2 required
OwnerRequest
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 2 required
User
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…
13 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbox-users-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 core 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 virtualization API
AE Profile APIs.io
NetBox vpn API
AE Profile APIs.io
#User
← Back to N APIs
API Details
ID
netbox:netbox-users-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-users-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/netbox-users-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 users 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.