Retrieve Scanning Agent

GET 
/scanning-agents/:id/

Request

Path Parameters

id stringrequired

A unique value identifying this scanning agent.

Responses

200

application/json

Schema

Schema

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)

{
  "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."
}

404

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Not found."
}

500

application/json

Schema

Schema

detail string

Example (from schema)

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

Loading...