NetBox tenancy API
The tenancy API from NetBox — 12 operation(s) for tenancy.
NetBox tenancy API is one of 14 APIs that NetBox publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include tenancy. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 54 operations across 12 paths, and defines 41 schemas. It is described by OpenAPI 3.0.3, at version 4.5.9 (4.5).
Requests are made against the base URL https://demo.netbox.dev/api.
54 operations
12 paths
41 schemas
12 DELETE12 GET12 PATCH6 POST12 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
NetBox tenancy 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 54
Across 12 paths, the API surfaces 54 operations — 12 DELETE, 12 GET, 12 PATCH, 6 POST, 12 PUT. Each is listed below with its method, path, parameters, and response codes.
tenancy 54
GET
/api/tenancy/contact-assignments/
Get a list of contact assignment objects.
POST
/api/tenancy/contact-assignments/
Post a list of contact assignment objects.
PUT
/api/tenancy/contact-assignments/
Put a list of contact assignment objects.
PATCH
/api/tenancy/contact-assignments/
Patch a list of contact assignment objects.
DELETE
/api/tenancy/contact-assignments/
Delete a list of contact assignment objects.
GET
/api/tenancy/contact-assignments/{id}/
Get a contact assignment object.
PUT
/api/tenancy/contact-assignments/{id}/
Put a contact assignment object.
PATCH
/api/tenancy/contact-assignments/{id}/
Patch a contact assignment object.
DELETE
/api/tenancy/contact-assignments/{id}/
Delete a contact assignment object.
GET
/api/tenancy/contact-groups/
Get a list of contact group objects.
POST
/api/tenancy/contact-groups/
Post a list of contact group objects.
PUT
/api/tenancy/contact-groups/
Put a list of contact group objects.
PATCH
/api/tenancy/contact-groups/
Patch a list of contact group objects.
DELETE
/api/tenancy/contact-groups/
Delete a list of contact group objects.
GET
/api/tenancy/contact-groups/{id}/
Get a contact group object.
PUT
/api/tenancy/contact-groups/{id}/
Put a contact group object.
PATCH
/api/tenancy/contact-groups/{id}/
Patch a contact group object.
DELETE
/api/tenancy/contact-groups/{id}/
Delete a contact group object.
GET
/api/tenancy/contact-roles/
Get a list of contact role objects.
POST
/api/tenancy/contact-roles/
Post a list of contact role objects.
PUT
/api/tenancy/contact-roles/
Put a list of contact role objects.
PATCH
/api/tenancy/contact-roles/
Patch a list of contact role objects.
DELETE
/api/tenancy/contact-roles/
Delete a list of contact role objects.
GET
/api/tenancy/contact-roles/{id}/
Get a contact role object.
PUT
/api/tenancy/contact-roles/{id}/
Put a contact role object.
PATCH
/api/tenancy/contact-roles/{id}/
Patch a contact role object.
DELETE
/api/tenancy/contact-roles/{id}/
Delete a contact role object.
GET
/api/tenancy/contacts/
Get a list of contact objects.
POST
/api/tenancy/contacts/
Post a list of contact objects.
PUT
/api/tenancy/contacts/
Put a list of contact objects.
PATCH
/api/tenancy/contacts/
Patch a list of contact objects.
DELETE
/api/tenancy/contacts/
Delete a list of contact objects.
GET
/api/tenancy/contacts/{id}/
Get a contact object.
PUT
/api/tenancy/contacts/{id}/
Put a contact object.
PATCH
/api/tenancy/contacts/{id}/
Patch a contact object.
DELETE
/api/tenancy/contacts/{id}/
Delete a contact object.
GET
/api/tenancy/tenant-groups/
Get a list of tenant group objects.
POST
/api/tenancy/tenant-groups/
Post a list of tenant group objects.
PUT
/api/tenancy/tenant-groups/
Put a list of tenant group objects.
PATCH
/api/tenancy/tenant-groups/
Patch a list of tenant group objects.
DELETE
/api/tenancy/tenant-groups/
Delete a list of tenant group objects.
GET
/api/tenancy/tenant-groups/{id}/
Get a tenant group object.
PUT
/api/tenancy/tenant-groups/{id}/
Put a tenant group object.
PATCH
/api/tenancy/tenant-groups/{id}/
Patch a tenant group object.
DELETE
/api/tenancy/tenant-groups/{id}/
Delete a tenant group object.
GET
/api/tenancy/tenants/
Get a list of tenant objects.
POST
/api/tenancy/tenants/
Post a list of tenant objects.
PUT
/api/tenancy/tenants/
Put a list of tenant objects.
PATCH
/api/tenancy/tenants/
Patch a list of tenant objects.
DELETE
/api/tenancy/tenants/
Delete a list of tenant objects.
GET
/api/tenancy/tenants/{id}/
Get a tenant object.
PUT
/api/tenancy/tenants/{id}/
Put a tenant object.
PATCH
/api/tenancy/tenants/{id}/
Patch a tenant object.
DELETE
/api/tenancy/tenants/{id}/
Delete a tenant object.
Schemas 41
The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are Tenant (24 properties), Contact (18 properties), ContactGroup (16 properties), TenantGroup (16 properties). Each schema is shown below with its type and property counts.
NestedTenantGroup
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…
7 properties
7 required
PatchedWritableContactGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
NestedContactGroupRequest
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…
2 properties
2 required
BriefContactRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties
2 required
PaginatedContactGroupList
object
4 properties
2 required
Tenant
object
Base serializer class for models inheriting from PrimaryModel.
24 properties
18 required
TenantGroup
object
Base serializer class for models inheriting from NestedGroupModel.
16 properties
10 required
PatchedWritableContactAssignmentRequest
object
Adds support for custom fields and tags.
7 properties
PatchedContactRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
TenantGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
2 required
ContactRole
object
Base serializer class for models inheriting from OrganizationalModel.
13 properties
8 required
WritableContactAssignmentRequest
object
Adds support for custom fields and tags.
7 properties
3 required
TenantRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
2 required
ContactGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
2 required
BriefTenantGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
3 properties
2 required
PaginatedContactRoleList
object
4 properties
2 required
PatchedWritableTenantGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
ContactRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties
1 required
BriefTenantGroup
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
7 required
PaginatedTenantList
object
4 properties
2 required
PaginatedContactList
object
4 properties
2 required
WritableContactGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
2 required
BriefContactRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
1 required
NestedTag
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…
7 properties
6 required
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
PaginatedContactAssignmentList
object
4 properties
2 required
ContactRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
2 required
PaginatedTenantGroupList
object
4 properties
2 required
ContactGroup
object
Base serializer class for models inheriting from NestedGroupModel.
16 properties
10 required
PatchedTenantRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
NestedContactGroup
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…
7 properties
7 required
Contact
object
Base serializer class for models inheriting from PrimaryModel.
18 properties
7 required
NestedTenantGroupRequest
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…
2 properties
2 required
BriefContactRole
object
Base serializer class for models inheriting from OrganizationalModel.
6 properties
5 required
ContactAssignmentRequest
object
Adds support for custom fields and tags.
7 properties
3 required
PatchedContactRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties
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
ContactAssignment
object
Adds support for custom fields and tags.
13 properties
9 required
WritableTenantGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
2 required
BriefContact
object
Base serializer class for models inheriting from PrimaryModel.
5 properties
4 required
NestedTagRequest
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…
3 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from NetBox 12
Other APIs NetBox publishes across the network.
NetBox GraphQL API
NetBox authentication-check API
NetBox circuits API
NetBox core API
NetBox dcim API
NetBox extras API
NetBox ipam API
NetBox schema API
NetBox status API
NetBox users API
NetBox virtualization API
NetBox vpn API
#tenancy