The Network Map — topology sites and locations. Auto-generated from the platform OpenAPI schema so it matches the running API.
REST API for this feature — 17 operations across 9 resource paths, auto-generated from the platform's live OpenAPI schema (drf-spectacular).
Base URL
https://<your-versus-host>/api· AuthAuthorization: Bearer <JWT>(fromPOST /api/auth/token/) · 📄 Download the OpenAPI spec for Postman/Insomnia/Swagger · see the API overview for pagination, filtering, and errors.
GET /api/locations/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
Responses: 200 → PaginatedLocationList
POST /api/locations/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): LocationRequest
Responses: 201 → Location
GET /api/locations/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this location. |
Responses: 200 → Location
PUT /api/locations/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this location. |
Request body (application/json): LocationRequest
Responses: 200 → Location
PATCH /api/locations/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this location. |
Request body (application/json): PatchedLocationRequest
Responses: 200 → Location
DELETE /api/locations/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this location. |
Responses: 204
GET /api/network-map/device/{id}/GET /api/network-map/device/<pk>/
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses: 200
POST /api/network-map/path-diagram/POST /api/network-map/path-diagram/
Responses: 200
POST /api/network-map/positions/POST /api/network-map/positions/
Responses: 200
GET /api/network-map/topology/GET /api/network-map/topology/
Responses: 200
POST /api/network-map/trace/POST /api/network-map/trace/
Responses: 200
GET /api/sites/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
Responses: 200 → PaginatedSiteList
POST /api/sites/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): SiteRequest
Responses: 201 → Site
GET /api/sites/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this site. |
Responses: 200 → Site
PUT /api/sites/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this site. |
Request body (application/json): SiteRequest
Responses: 200 → Site
PATCH /api/sites/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this site. |
Request body (application/json): PatchedSiteRequest
Responses: 200 → Site
DELETE /api/sites/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this site. |
Responses: 204
Auto-generated from drf-spectacular OpenAPI. Endpoint descriptions come from viewset docstrings/serializers; enriching those improves this page on the next generation.