asset

Get Assets

Get all assets for an assessment.

get/api/v1/assessments/{assessment_id}/asset/

Request

  • The document declares no server URL.
  • Auth: OAuth 2 (password, token URL /api/v1/auth/token)

Path parameters

assessment_idstring uuid required

Query parameters

offsetinteger
limitinteger
sort_order'asc' | 'desc' nullable
namestring nullable
deletedboolean nullable
sort_by'name' | 'deleted' nullable

Response

Successful Response

totalinteger required
pageinteger required
sizeinteger required
pagesinteger required

Example response

{
  "items": [
    {
      "assessment_id": "11111111-1111-1111-1111-111111111111",
      "deleted": false,
      "icon": "Computer",
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Test Computer",
      "properties": {
        "computer_name": "computer1",
        "ip": "192.168.1.1",
        "mac": "00:11:22:33:44:55"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 4 revisions of this API.