ANangelcam
arrow-clients

Arrow client detail

Get detailed information about a given Arrow client.

get/arrow-clients/{uuid}/

Request

  • Base URL
    https://api.angelcam.com/v1
  • Auth
    • OAuth 2
      Authorization codehttps://my.angelcam.com/oauth/authorize/, token URL https://my.angelcam.com/oauth/token/
      PasswordToken URL https://api.angelcam.com/oauth/token/
      Scopesarrow_client_access
    • or API key in header Authorization
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

uuidstring uuid required

Arrow client UUID

Response

OK

uuidstring uuid nullable required

UUID of the Arrow client

macstring mac nullable required

MAC address of the device running the Arrow client

ipstring

Public IP address of the device running the Arrow client

status'online' | 'offline' | 'not_paired' required

Current availability of the Arrow client. The not_paired value means that there is an active pairing request for this client, however, the client has not reached Angelcam servers yet.

scanningboolean

True if the client is currently scanning the target network, false otherwise

Example response

{
  "uuid": "75b62326-eca3-4424-ab68-48e7da47e847",
  "mac": "12:34:56:78:9a:bc",
  "ip": "1.1.1.1",
  "status": "online",
  "scanning": true,
  "proxy": {
    "connect": {
      "http": "m1-eu1.angelcam.com:8920",
      "https": "m1-eu1.angelcam.com:8940"
    },
    "transparent": {
      "http": "m1-eu1.angelcam.com:8921",
      "https": "m1-eu1.angelcam.com:8941"
    },
    "token": "xxx.yyy.zzz"
  },
  "capabilities": {
    "add_custom_service": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.