List Scanning Agents

GET 
/scanning-agents/

Request

Query Parameters

length integer

Number of results to return per page.

ordering string

Which field to use when ordering the results.

page integer

A page number within the paginated result set.

scopes_logical_operator string
Possible values: [and, or]
Logical operator to apply between agent scopes:
(Defaults to or)
• and - and
• or - or
search string

A search term.

status integer[]
Possible values: [connected, connected_with_issues, disconnected]
Filter by status
• connected - Connected
• connected_with_issues - Connected with issues
• disconnected - Disconnected
team string[]

A unique Base58 value identifying this object.

Responses

200

application/json

Schema

Schema

count integer

Total number of results.

page_total integer

Total number of pages.

page integer

Number of the current page.
The first page is 1.
Defaults to 1 if no specific page is requested.

length integer

Number of results returned per page.

results

object[]

Array [

id stringrequired

name stringrequired

Possible values: <= 255 characters

installer_generated booleanrequired

teams

object[]

nullable

Array [

id string

A unique Base58 value identifying this object.

name stringrequired

]

online booleanrequired

fallback booleanrequired

rx_bytes integerrequired

tx_bytes integerrequired

latest_handshake integerrequired

]

Example (from schema)

{
  "count": 6,
  "page_total": 1,
  "page": 1,
  "length": 10,
  "results": [
    {
      "id": "string",
      "name": "string",
      "installer_generated": true,
      "teams": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "online": true,
      "fallback": true,
      "rx_bytes": 0,
      "tx_bytes": 0,
      "latest_handshake": 0
    }
  ]
}

400

application/json

Schema

Schema

<field name> string[]
non_field_errors string[]

Example (from schema)

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

401

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Incorrect authentication credentials."
}

500

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Unexpected error while handling your request."
}

Loading...