List devices

GET 
/devices

Retrieve a list of devices.

Request

Query Parameters

limit number

The maximum number of resources to return

offset number

The offset into the list of resources returned

name string

The name of the resource

Responses

200

OK

application/json

Schema

Schema

data object[]
Array [
id stringrequired
The UUID of the device
name stringrequired
The name of the device
folder stringrequired
The folder containing the device
description string
The description of the device
hostname string
The hostname of the device
ip_address string
The IPv4 address of the device
ipV6_address string
The IPv6 address of the device
mac_address string
The MAC address of the device
family string
The product family of the device
model string
The model of the device
labels string[]
Labels assigned to the device
snippets string[]
Snippets associated with the device
app_version string
threat_version string
anti_virus_version string
wf_ver string
iot_version string
url_db_type string
url_db_ver string
software_version string
vm_state string
gp_client_verion string
gp_data_version string
log_db_version string
uptime string
dev_cert_detail string
dev_cert_expiry_date string
ha_state string
ha_peer_serial string
ha_peer_state string
is_connected boolean
connected_since date-time
app_release_date string
threat_release_date string
av_release_date string
wf_release_date string
iot_release_date string
license_match boolean
available_licensess object[]
Array [
issued date
expires date
feature string
authcode string
]
installed_licenses object[]
Array [
issued date
expired string
expires string
feature string
authcode string
]
]
limit number

Default value: 200

offset number

Default value: 0

total number

Example (from schema)

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "folder": "string",
      "description": "string",
      "hostname": "string",
      "ip_address": "string",
      "ipV6_address": "string",
      "mac_address": "string",
      "family": "string",
      "model": "string",
      "labels": [
        "string"
      ],
      "snippets": [
        "string"
      ],
      "app_version": "string",
      "threat_version": "string",
      "anti_virus_version": "string",
      "wf_ver": "string",
      "iot_version": "string",
      "url_db_type": "string",
      "url_db_ver": "string",
      "software_version": "string",
      "vm_state": "string",
      "gp_client_verion": "string",
      "gp_data_version": "string",
      "log_db_version": "string",
      "uptime": "string",
      "dev_cert_detail": "string",
      "dev_cert_expiry_date": "string",
      "ha_state": "string",
      "ha_peer_serial": "string",
      "ha_peer_state": "string",
      "is_connected": true,
      "connected_since": "2024-07-29T15:51:28.071Z",
      "app_release_date": "string",
      "threat_release_date": "string",
      "av_release_date": "string",
      "wf_release_date": "string",
      "iot_release_date": "string",
      "license_match": true,
      "available_licensess": [
        {
          "issued": "2024-07-29",
          "expires": "2024-07-29",
          "feature": "string",
          "authcode": "string"
        }
      ],
      "installed_licenses": [
        {
          "issued": "2024-07-29",
          "expired": "string",
          "expires": "string",
          "feature": "string",
          "authcode": "string"
        }
      ]
    }
  ],
  "limit": 200,
  "offset": 0,
  "total": 0
}

400

Bad Request

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

input_format_mismatch

Input Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "message": "Input Format Mismatch: input-format=json",
      "details": {}
    }
  ],
  "_request_id": "abcd-1234"
}

output_format_mismatch

Output Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "message": "Output Format Mismatch: output-format=json Accept=xml",
      "details": {}
    }
  ],
  "_request_id": "abcd-1234"
}

missing_query_parameter

Missing Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "message": "Missing Query Parameter: name",
      "details": {}
    }
  ],
  "_request_id": "abcd-1234"
}

invalid_query_parameter

Invalid Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Query Parameter: location=invalid",
      "details": {}
    }
  ],
  "_request_id": "abcd-1234"
}

401

Unauthorized

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

auth_not_authenticated

Not Authenticated

{
  "_errors": [
    {
      "code": "E016",
      "message": "Not Authenticated",
      "details": {}
    }
  ],
  "_request_id": "abcd-1234"
}

invalid_credential

Invalid Credential

{
  "_errors": [
    {
      "code": "E016",
      "message": "Invalid Credential",
      "details": {}
    }
  ],
  "_request_id": "abcd-1234"
}

key_too_long

Key Too Long

{
  "_errors": [
    {
      "code": "E016",
      "message": "Key Too Long",
      "details": {}
    }
  ],
  "_request_id": "abcd-1234"
}

key_expired

Key Expired

{
  "_errors": [
    {
      "code": "E016",
      "message": "Key Expired",
      "details": {}
    }
  ],
  "_request_id": "abcd-1234"
}

need_password_change

Need Password Change

{
  "_errors": [
    {
      "code": "E016",
      "message": "The password needs to be changed.",
      "details": {}
    }
  ],
  "_request_id": "abcd-1234"
}

403

Forbidden

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

auth_unauthorized

Unauthorized

{
  "_errors": [
    {
      "code": "E007",
      "message": "Unauthorized",
      "details": {}
    }
  ],
  "_request_id": "abcd-1234"
}

404

Not Found

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

object_not_present

Object Not Present

{
  "_errors": [
    {
      "code": "E005",
      "message": "Object Not Present",
      "details": {}
    }
  ],
  "_request_id": "abcd-1234"
}

default

General Errors

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

version_not_supported

Version Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Version Not Supported",
      "details": {}
    }
  ],
  "_request_id": "abcd-1234"
}

method_not_allowed

Method Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Method Not Supported",
      "details": {}
    }
  ],
  "_request_id": "abcd-1234"
}

action_not_supported

Action Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Action Not Supported: move",
      "details": {}
    }
  ],
  "_request_id": "abcd-1234"
}

bad_xpath

Bad XPath

{
  "_errors": [
    {
      "code": "E013",
      "message": "Bad XPath",
      "details": {}
    }
  ],
  "_request_id": "abcd-1234"
}

invalid_command

Invalid Command

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Command",
      "details": {}
    }
  ],
  "_request_id": "abcd-1234"
}

malformed_command

Malformed Command

{
  "_errors": [
    {
      "code": "E003",
      "message": "Malformed Command",
      "details": {}
    }
  ],
  "_request_id": "abcd-1234"
}

session_timeout

Session Timeout

{
  "_errors": [
    {
      "code": "4",
      "message": "Session Timeout",
      "details": {}
    }
  ],
  "_request_id": "abcd-1234"
}

Loading...