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

NetBox Labs Tenancy API

The tenancy API from NetBox Labs — 12 operation(s) for tenancy.

NetBox Labs Tenancy 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 Tenancy. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 54 operations across 12 paths, and defines 53 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/.

54 operations 12 paths 53 schemas 12 DELETE12 GET12 PATCH6 POST12 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
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 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/
Tenancy contact assignments list
tenancy_contact_assignments_list 70 params → 200
POST
/api/tenancy/contact-assignments/
Tenancy contact assignments create
tenancy_contact_assignments_create body → 201
PUT
/api/tenancy/contact-assignments/
Tenancy contact assignments bulk update
tenancy_contact_assignments_bulk_update body → 200
PATCH
/api/tenancy/contact-assignments/
Tenancy contact assignments bulk partial update
tenancy_contact_assignments_bulk_partial_update body → 200
DELETE
/api/tenancy/contact-assignments/
Tenancy contact assignments bulk destroy
tenancy_contact_assignments_bulk_destroy body → 204
GET
/api/tenancy/contact-assignments/{id}/
Tenancy contact assignments retrieve
tenancy_contact_assignments_retrieve 4 params → 200
PUT
/api/tenancy/contact-assignments/{id}/
Tenancy contact assignments update
tenancy_contact_assignments_update 1 param body → 200
PATCH
/api/tenancy/contact-assignments/{id}/
Tenancy contact assignments partial update
tenancy_contact_assignments_partial_update 1 param body → 200
DELETE
/api/tenancy/contact-assignments/{id}/
Tenancy contact assignments destroy
tenancy_contact_assignments_destroy 1 param → 204
GET
/api/tenancy/contact-groups/
Tenancy contact groups list
tenancy_contact_groups_list 93 params → 200
POST
/api/tenancy/contact-groups/
Tenancy contact groups create
tenancy_contact_groups_create body → 201
PUT
/api/tenancy/contact-groups/
Tenancy contact groups bulk update
tenancy_contact_groups_bulk_update body → 200
PATCH
/api/tenancy/contact-groups/
Tenancy contact groups bulk partial update
tenancy_contact_groups_bulk_partial_update body → 200
DELETE
/api/tenancy/contact-groups/
Tenancy contact groups bulk destroy
tenancy_contact_groups_bulk_destroy body → 204
GET
/api/tenancy/contact-groups/{id}/
Tenancy contact groups retrieve
tenancy_contact_groups_retrieve 4 params → 200
PUT
/api/tenancy/contact-groups/{id}/
Tenancy contact groups update
tenancy_contact_groups_update 1 param body → 200
PATCH
/api/tenancy/contact-groups/{id}/
Tenancy contact groups partial update
tenancy_contact_groups_partial_update 1 param body → 200
DELETE
/api/tenancy/contact-groups/{id}/
Tenancy contact groups destroy
tenancy_contact_groups_destroy 1 param → 204
GET
/api/tenancy/contact-roles/
Tenancy contact roles list
tenancy_contact_roles_list 83 params → 200
POST
/api/tenancy/contact-roles/
Tenancy contact roles create
tenancy_contact_roles_create body → 201
PUT
/api/tenancy/contact-roles/
Tenancy contact roles bulk update
tenancy_contact_roles_bulk_update body → 200
PATCH
/api/tenancy/contact-roles/
Tenancy contact roles bulk partial update
tenancy_contact_roles_bulk_partial_update body → 200
DELETE
/api/tenancy/contact-roles/
Tenancy contact roles bulk destroy
tenancy_contact_roles_bulk_destroy body → 204
GET
/api/tenancy/contact-roles/{id}/
Tenancy contact roles retrieve
tenancy_contact_roles_retrieve 4 params → 200
PUT
/api/tenancy/contact-roles/{id}/
Tenancy contact roles update
tenancy_contact_roles_update 1 param body → 200
PATCH
/api/tenancy/contact-roles/{id}/
Tenancy contact roles partial update
tenancy_contact_roles_partial_update 1 param body → 200
DELETE
/api/tenancy/contact-roles/{id}/
Tenancy contact roles destroy
tenancy_contact_roles_destroy 1 param → 204
GET
/api/tenancy/contacts/
Tenancy contacts list
tenancy_contacts_list 139 params → 200
POST
/api/tenancy/contacts/
Tenancy contacts create
tenancy_contacts_create body → 201
PUT
/api/tenancy/contacts/
Tenancy contacts bulk update
tenancy_contacts_bulk_update body → 200
PATCH
/api/tenancy/contacts/
Tenancy contacts bulk partial update
tenancy_contacts_bulk_partial_update body → 200
DELETE
/api/tenancy/contacts/
Tenancy contacts bulk destroy
tenancy_contacts_bulk_destroy body → 204
GET
/api/tenancy/contacts/{id}/
Tenancy contacts retrieve
tenancy_contacts_retrieve 4 params → 200
PUT
/api/tenancy/contacts/{id}/
Tenancy contacts update
tenancy_contacts_update 1 param body → 200
PATCH
/api/tenancy/contacts/{id}/
Tenancy contacts partial update
tenancy_contacts_partial_update 1 param body → 200
DELETE
/api/tenancy/contacts/{id}/
Tenancy contacts destroy
tenancy_contacts_destroy 1 param → 204
GET
/api/tenancy/tenant-groups/
Tenancy tenant groups list
tenancy_tenant_groups_list 91 params → 200
POST
/api/tenancy/tenant-groups/
Tenancy tenant groups create
tenancy_tenant_groups_create body → 201
PUT
/api/tenancy/tenant-groups/
Tenancy tenant groups bulk update
tenancy_tenant_groups_bulk_update body → 200
PATCH
/api/tenancy/tenant-groups/
Tenancy tenant groups bulk partial update
tenancy_tenant_groups_bulk_partial_update body → 200
DELETE
/api/tenancy/tenant-groups/
Tenancy tenant groups bulk destroy
tenancy_tenant_groups_bulk_destroy body → 204
GET
/api/tenancy/tenant-groups/{id}/
Tenancy tenant groups retrieve
tenancy_tenant_groups_retrieve 4 params → 200
PUT
/api/tenancy/tenant-groups/{id}/
Tenancy tenant groups update
tenancy_tenant_groups_update 1 param body → 200
PATCH
/api/tenancy/tenant-groups/{id}/
Tenancy tenant groups partial update
tenancy_tenant_groups_partial_update 1 param body → 200
DELETE
/api/tenancy/tenant-groups/{id}/
Tenancy tenant groups destroy
tenancy_tenant_groups_destroy 1 param → 204
GET
/api/tenancy/tenants/
Tenancy tenants list
tenancy_tenants_list 93 params → 200
POST
/api/tenancy/tenants/
Tenancy tenants create
tenancy_tenants_create body → 201
PUT
/api/tenancy/tenants/
Tenancy tenants bulk update
tenancy_tenants_bulk_update body → 200
PATCH
/api/tenancy/tenants/
Tenancy tenants bulk partial update
tenancy_tenants_bulk_partial_update body → 200
DELETE
/api/tenancy/tenants/
Tenancy tenants bulk destroy
tenancy_tenants_bulk_destroy body → 204
GET
/api/tenancy/tenants/{id}/
Tenancy tenants retrieve
tenancy_tenants_retrieve 4 params → 200
PUT
/api/tenancy/tenants/{id}/
Tenancy tenants update
tenancy_tenants_update 1 param body → 200
PATCH
/api/tenancy/tenants/{id}/
Tenancy tenants partial update
tenancy_tenants_partial_update 1 param body → 200
DELETE
/api/tenancy/tenants/{id}/
Tenancy tenants destroy
tenancy_tenants_destroy 1 param → 204

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are Tenant (24 properties), Contact (18 properties), TenantGroup (16 properties), ContactGroup (16 properties). Each schema is shown below with its type and property counts.

BriefContactRole
object
Base serializer class for models inheriting from OrganizationalModel.
6 properties 5 required
WritableContactGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties 2 required
PatchedBulkTenantRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 1 required
ContactRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties 2 required
PatchedBulkContactAssignmentRequest
object
Adds support for custom fields and tags.
8 properties 1 required
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
PaginatedContactGroupList
object
4 properties 2 required
BulkContactRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties 2 required
ContactRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties 1 required
BriefContact
object
Base serializer class for models inheriting from PrimaryModel.
5 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
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
PaginatedContactList
object
4 properties 2 required
PatchedWritableTenantGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
Contact
object
Base serializer class for models inheriting from PrimaryModel.
18 properties 7 required
PatchedContactRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
PatchedWritableContactAssignmentRequest
object
Adds support for custom fields and tags.
7 properties
BulkContactRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties 3 required
BulkTenantGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
9 properties 3 required
PatchedContactRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties
PatchedBulkContactRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties 1 required
Tenant
object
Base serializer class for models inheriting from PrimaryModel.
24 properties 18 required
BulkTenantRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 3 required
PatchedBulkContactGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
9 properties 1 required
TenantGroup
object
Base serializer class for models inheriting from NestedGroupModel.
16 properties 10 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
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
TenantGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties 2 required
PatchedBulkTenantGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
9 properties 1 required
BulkContactGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
9 properties 3 required
ContactAssignmentRequest
object
Adds support for custom fields and tags.
7 properties 3 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
BriefTenantGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
3 properties 2 required
ContactGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties 2 required
PatchedBulkContactRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties 1 required
BulkContactAssignmentRequest
object
Adds support for custom fields and tags.
8 properties 4 required
ContactRole
object
Base serializer class for models inheriting from OrganizationalModel.
13 properties 8 required
TenantRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 2 required
BriefContactRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties 2 required
PaginatedContactRoleList
object
4 properties 2 required
BriefContactRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
WritableTenantGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties 2 required
BriefTenantGroup
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties 7 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
PatchedTenantRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
PaginatedTenantList
object
4 properties 2 required
PatchedWritableContactGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
ContactAssignment
object
Adds support for custom fields and tags.
13 properties 9 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
ContactGroup
object
Base serializer class for models inheriting from NestedGroupModel.
16 properties 10 required
PaginatedTenantGroupList
object
4 properties 2 required
WritableContactAssignmentRequest
object
Adds support for custom fields and tags.
7 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

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 Users API
NetBox Labs Virtualization API
NetBox Labs Vpn API
NetBox Labs Wireless API
Where this information came from

This is an independent, third-party profile of NetBox Labs Tenancy 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.