For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to page URLs.
Skip to content

Networks

get

This class will define the view behavior

Args: viewsets ([OCSVIewSet])

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters
descriptionstringOptional
formatstring · enumOptionalPossible values:
groupintegerOptional
last_updatestring · date-timeOptional
limitintegerOptional

Number of results to return per page.

locationstringOptional
maskstringOptional
namestringOptional
netidstringOptional
nettagstringOptional
offsetintegerOptional

The initial index from which to return the results.

orderingstringOptional

Which field to use when ordering the results.

searchstringOptional

A search term.

Responses
200Success
countintegerRequiredExample: 123
nextstring · uri · nullableOptionalExample: http://api.example.org/accounts/?offset=400&limit=100
previousstring · uri · nullableOptionalExample: http://api.example.org/accounts/?offset=200&limit=100
get/networks/
GET /networks/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 1,
      "nettag": "text",
      "name": "text",
      "description": "text",
      "netid": "text",
      "mask": "text",
      "netdevices": [
        {
          "id": 1,
          "ip": "text",
          "netname": "text",
          "mac": "text",
          "network": 1,
          "last_seen": "2026-01-01T00:00:00.000Z"
        }
      ],
      "group": 1,
      "last_update": "2026-01-01T00:00:00.000Z"
    }
  ]
}
post

Handle post request, suitable for single and multi creation

Args: request ([dict]): can be dict or list of dicts

Returns: [type]: [description]

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters
formatstring · enumOptionalPossible values:
Body

This serialize class provide the API representation

idintegerRead-onlyRequired
nettagstring · max: 128Optional
namestring · max: 128Optional
descriptionstring · max: 1024Optional
netidstringRequired
maskstringRequired
groupinteger · nullableOptional
last_updatestring · date-timeRead-onlyRequired
Responses
201Success

This serialize class provide the API representation

idintegerRead-onlyRequired
nettagstring · max: 128Optional
namestring · max: 128Optional
descriptionstring · max: 1024Optional
netidstringRequired
maskstringRequired
groupinteger · nullableOptional
last_updatestring · date-timeRead-onlyRequired
post/networks/
POST /networks/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 162

"nettag='text'&name='text'&description='text'&netid='text'&mask='text'&netdevices=[{'ip':'text','netname':'text','mac':'text','network':1}]&group=1"
201Success
{
  "id": 1,
  "nettag": "text",
  "name": "text",
  "description": "text",
  "netid": "text",
  "mask": "text",
  "netdevices": [
    {
      "id": 1,
      "ip": "text",
      "netname": "text",
      "mac": "text",
      "network": 1,
      "last_seen": "2026-01-01T00:00:00.000Z"
    }
  ],
  "group": 1,
  "last_update": "2026-01-01T00:00:00.000Z"
}
get

This class will define the view behavior

Args: viewsets ([OCSVIewSet])

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters
idintegerRequired

A unique integer value identifying this network.

Query parameters
formatstring · enumOptionalPossible values:
Responses
200Success

This serialize class provide the API representation

idintegerRead-onlyRequired
nettagstring · max: 128Optional
namestring · max: 128Optional
descriptionstring · max: 1024Optional
netidstringRequired
maskstringRequired
groupinteger · nullableOptional
last_updatestring · date-timeRead-onlyRequired
get/networks/{id}/
GET /networks/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": 1,
  "nettag": "text",
  "name": "text",
  "description": "text",
  "netid": "text",
  "mask": "text",
  "netdevices": [
    {
      "id": 1,
      "ip": "text",
      "netname": "text",
      "mac": "text",
      "network": 1,
      "last_seen": "2026-01-01T00:00:00.000Z"
    }
  ],
  "group": 1,
  "last_update": "2026-01-01T00:00:00.000Z"
}
put

This class will define the view behavior

Args: viewsets ([OCSVIewSet])

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters
idintegerRequired

A unique integer value identifying this network.

Query parameters
formatstring · enumOptionalPossible values:
Body

This serialize class provide the API representation

idintegerRead-onlyRequired
nettagstring · max: 128Optional
namestring · max: 128Optional
descriptionstring · max: 1024Optional
netidstringRequired
maskstringRequired
groupinteger · nullableOptional
last_updatestring · date-timeRead-onlyRequired
Responses
200Success

This serialize class provide the API representation

idintegerRead-onlyRequired
nettagstring · max: 128Optional
namestring · max: 128Optional
descriptionstring · max: 1024Optional
netidstringRequired
maskstringRequired
groupinteger · nullableOptional
last_updatestring · date-timeRead-onlyRequired
put/networks/{id}/
PUT /networks/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 162

"nettag='text'&name='text'&description='text'&netid='text'&mask='text'&netdevices=[{'ip':'text','netname':'text','mac':'text','network':1}]&group=1"
200Success
{
  "id": 1,
  "nettag": "text",
  "name": "text",
  "description": "text",
  "netid": "text",
  "mask": "text",
  "netdevices": [
    {
      "id": 1,
      "ip": "text",
      "netname": "text",
      "mac": "text",
      "network": 1,
      "last_seen": "2026-01-01T00:00:00.000Z"
    }
  ],
  "group": 1,
  "last_update": "2026-01-01T00:00:00.000Z"
}
delete

This class will define the view behavior

Args: viewsets ([OCSVIewSet])

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters
idintegerRequired

A unique integer value identifying this network.

Query parameters
formatstring · enumOptionalPossible values:
Responses
204

No response body

No content

delete/networks/{id}/
DELETE /networks/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
204

No response body

No content

patch

This class will define the view behavior

Args: viewsets ([OCSVIewSet])

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters
idintegerRequired

A unique integer value identifying this network.

Query parameters
formatstring · enumOptionalPossible values:
Body

This serialize class provide the API representation

idintegerRead-onlyOptional
nettagstring · max: 128Optional
namestring · max: 128Optional
descriptionstring · max: 1024Optional
netidstringOptional
maskstringOptional
groupinteger · nullableOptional
last_updatestring · date-timeRead-onlyOptional
Responses
200Success

This serialize class provide the API representation

idintegerRead-onlyRequired
nettagstring · max: 128Optional
namestring · max: 128Optional
descriptionstring · max: 1024Optional
netidstringRequired
maskstringRequired
groupinteger · nullableOptional
last_updatestring · date-timeRead-onlyRequired
patch/networks/{id}/
PATCH /networks/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 162

"nettag='text'&name='text'&description='text'&netid='text'&mask='text'&netdevices=[{'ip':'text','netname':'text','mac':'text','network':1}]&group=1"
200Success
{
  "id": 1,
  "nettag": "text",
  "name": "text",
  "description": "text",
  "netid": "text",
  "mask": "text",
  "netdevices": [
    {
      "id": 1,
      "ip": "text",
      "netname": "text",
      "mac": "text",
      "network": 1,
      "last_seen": "2026-01-01T00:00:00.000Z"
    }
  ],
  "group": 1,
  "last_update": "2026-01-01T00:00:00.000Z"
}

Last updated