List Scanning Agents
GET/scanning-agents/
Request
Query Parameters
and
- andor
- or
length integerrequired
Number of results to return per page.
ordering stringrequired
Which field to use when ordering the results.
page integerrequired
A page number within the paginated result set.
scopes_logical_operator string
Possible values: [and
, or
]
Logical operator to apply between agent scopes.
search stringrequired
A search term.
team string[]
A unique Base58 value identifying this object.
Responses
- 200
- 400
- 401
- 500
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- ]
count integerrequired
Total number of results.
page_total integerrequired
Total number of pages.
page integerrequired
Number of the current page.
The first page is 1.
Defaults to 1 if no specific page is requested.
length integerrequired
Number of results returned per page.
results object[]
id stringrequired
name stringrequired
Possible values: <= 255 characters
installer_generated booleanrequired
teams object[]nullable
id stringrequired
A unique Base58 value identifying this object.
name stringrequired
online booleanrequired
fallback booleanrequired
rx_bytes integerrequired
tx_bytes integerrequired
latest_handshake integerrequired
{
"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
}
]
}
- application/json
- Schema
- Example (from schema)
Schema
<field name> string[]required
non_field_errors string[]required
{
"<field name>": [
"Errors related to field <field name>."
],
"non_field_errors": [
"Errors not related to any field specific field."
]
}
- application/json
- Schema
- Example (from schema)
Schema
detail stringrequired
{
"detail": "Incorrect authentication credentials."
}
- application/json
- Schema
- Example (from schema)
Schema
detail stringrequired
{
"detail": "Unexpected error while handling your request."
}
Loading...