NetBox Labs Users API
The users API from NetBox Labs — 14 operation(s) for users.
NetBox Labs Users 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 User. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.
This API exposes 56 operations across 14 paths, and defines 44 schemas. It is described by OpenAPI 3.2.0, at version 4.6.5 (4.6).
Requests are made against the base URL https://demo.netbox.dev/api/.
56 operations
14 paths
44 schemas
12 DELETE13 GET12 PATCH7 POST12 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
NetBox Labs 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/
Users config retrieve
GET
/api/users/groups/
Users groups list
POST
/api/users/groups/
Users groups create
PUT
/api/users/groups/
Users groups bulk update
PATCH
/api/users/groups/
Users groups bulk partial update
DELETE
/api/users/groups/
Users groups bulk destroy
GET
/api/users/groups/{id}/
Users groups retrieve
PUT
/api/users/groups/{id}/
Users groups update
PATCH
/api/users/groups/{id}/
Users groups partial update
DELETE
/api/users/groups/{id}/
Users groups destroy
GET
/api/users/owner-groups/
Users owner groups list
POST
/api/users/owner-groups/
Users owner groups create
PUT
/api/users/owner-groups/
Users owner groups bulk update
PATCH
/api/users/owner-groups/
Users owner groups bulk partial update
DELETE
/api/users/owner-groups/
Users owner groups bulk destroy
GET
/api/users/owner-groups/{id}/
Users owner groups retrieve
PUT
/api/users/owner-groups/{id}/
Users owner groups update
PATCH
/api/users/owner-groups/{id}/
Users owner groups partial update
DELETE
/api/users/owner-groups/{id}/
Users owner groups destroy
GET
/api/users/owners/
Users owners list
POST
/api/users/owners/
Users owners create
PUT
/api/users/owners/
Users owners bulk update
PATCH
/api/users/owners/
Users owners bulk partial update
DELETE
/api/users/owners/
Users owners bulk destroy
GET
/api/users/owners/{id}/
Users owners retrieve
PUT
/api/users/owners/{id}/
Users owners update
PATCH
/api/users/owners/{id}/
Users owners partial update
DELETE
/api/users/owners/{id}/
Users owners destroy
GET
/api/users/permissions/
Users permissions list
POST
/api/users/permissions/
Users permissions create
PUT
/api/users/permissions/
Users permissions bulk update
PATCH
/api/users/permissions/
Users permissions bulk partial update
DELETE
/api/users/permissions/
Users permissions bulk destroy
GET
/api/users/permissions/{id}/
Users permissions retrieve
PUT
/api/users/permissions/{id}/
Users permissions update
PATCH
/api/users/permissions/{id}/
Users permissions partial update
DELETE
/api/users/permissions/{id}/
Users permissions destroy
GET
/api/users/tokens/
Users tokens list
POST
/api/users/tokens/
Users tokens create
PUT
/api/users/tokens/
Users tokens bulk update
PATCH
/api/users/tokens/
Users tokens bulk partial update
DELETE
/api/users/tokens/
Users tokens bulk destroy
GET
/api/users/tokens/{id}/
Users tokens retrieve
PUT
/api/users/tokens/{id}/
Users tokens update
PATCH
/api/users/tokens/{id}/
Users tokens partial update
DELETE
/api/users/tokens/{id}/
Users tokens destroy
POST
/api/users/tokens/provision/
Users tokens provision create
GET
/api/users/users/
Users users list
POST
/api/users/users/
Users users create
PUT
/api/users/users/
Users users bulk update
PATCH
/api/users/users/
Users users bulk partial update
DELETE
/api/users/users/
Users users bulk destroy
GET
/api/users/users/{id}/
Users users retrieve
PUT
/api/users/users/{id}/
Users users update
PATCH
/api/users/users/{id}/
Users users partial update
DELETE
/api/users/users/{id}/
Users users destroy
Schemas 44
The contract defines 44 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.
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
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
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
PaginatedUserList
object
4 properties
2 required
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
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
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
PatchedBulkOwnerGroupRequest
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
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
PatchedBulkUserRequest
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…
11 properties
1 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
PatchedBulkGroupRequest
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
1 required
BulkUserRequest
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…
11 properties
3 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
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
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
PaginatedTokenList
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
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
PaginatedObjectPermissionList
object
4 properties
2 required
PaginatedOwnerGroupList
object
4 properties
2 required
PatchedBulkObjectPermissionRequest
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
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
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
PaginatedOwnerList
object
4 properties
2 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
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
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
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
BulkGroupRequest
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
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
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
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
PaginatedGroupList
object
4 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
BulkOwnerGroupRequest
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
2 required
PatchedBulkTokenRequest
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
1 required
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
BulkObjectPermissionRequest
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
4 required
BulkTokenRequest
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
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
PatchedBulkOwnerRequest
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…
6 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
BulkOwnerRequest
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…
6 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from NetBox Labs 12
Other APIs NetBox Labs publishes across the network.
NetBox Labs Authentication Check API
NetBox Labs Circuits API
NetBox Labs Core API
NetBox Labs Dcim API
NetBox Labs Extras API
NetBox Labs Ipam API
NetBox Labs Schema API
NetBox Labs Status API
NetBox Labs Tenancy API
NetBox Labs Virtualization API
NetBox Labs Vpn API
NetBox Labs Wireless API
#User
Where this information came from
This is an independent, third-party profile of NetBox Labs 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.