List of CLI Devices

curl --request GET \
  --url https://wksusa1b2c3d.provisionr.app/api/v1/workspace/devices \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://wksusa1b2c3d.provisionr.app/api/v1/workspace/devices"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://wksusa1b2c3d.provisionr.app/api/v1/workspace/devices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "id": "wsdev_01hq8xyzabc123def456ghi789",
    "app_composer_path": "/opt/homebrew/bin/composer",
    "app_composer_version": "x.y.z",
    "app_cli_version": "x.y.z",
    "app_php_path": "/opt/homebrew/bin/php",
    "app_php_version": "x.y.z",
    "ip_address": "1.2.3.4",
    "os_chipset": "Apple M1 Pro",
    "os_hostname": "dmurphy-laptop",
    "os_platform": "macOS",
    "os_serial": "A1B2C3D4E5F6G7",
    "os_uuid": "A1B2C3D4-E5F6-G7H8-I9J0-K1L2M3N4O5P6",
    "os_version": "x.y.z",
    "count": {
      "audit_logs_parent": 123,
      "audit_logs_record": 123,
      "audit_logs_related": 123
    },
    "timestamp": {
      "created_at": "2024-03-15T10:30:00.000000Z",
      "updated_at": "2024-03-15T14:22:00.000000Z",
      "deleted_at": null
    },
    "included": {
      "refresh_token": {
        "workspace_id": "hqwks_01ka7gx38jf1za86ns4c6114at",
        "workspace_token_id": "wstok_01hq8xyzabc123def456ghi789",
        "token_type": "cli_activation",
        "created_at": "2023-11-07T05:31:56Z",
        "last_used_at": "2023-11-07T05:31:56Z",
        "expires_at": "2023-11-07T05:31:56Z",
        "expires_at_mins": 60,
        "requested_at": "2023-11-07T05:31:56Z"
      },
      "workspace_user": {
        "id": "wsusr_01hq8xyzabc123def456ghi789",
        "state": "staged",
        "provider": "hq",
        "provider_id": "<string>",
        "name": "<string>",
        "handle": "<string>",
        "email": "<string>"
      }
    },
    "links": {
      "self": "https://ws-a1b2c3.provisionr.io/api/v1/workspace/devices/wsdev_01hq8xyzabc123def456ghi789"
    }
  }
]

{
  "message": "<string>"
}

{
  "message": "<string>"
}

GET

workspace

devices

List of CLI Devices

curl --request GET \
  --url https://wksusa1b2c3d.provisionr.app/api/v1/workspace/devices \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://wksusa1b2c3d.provisionr.app/api/v1/workspace/devices"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://wksusa1b2c3d.provisionr.app/api/v1/workspace/devices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "id": "wsdev_01hq8xyzabc123def456ghi789",
    "app_composer_path": "/opt/homebrew/bin/composer",
    "app_composer_version": "x.y.z",
    "app_cli_version": "x.y.z",
    "app_php_path": "/opt/homebrew/bin/php",
    "app_php_version": "x.y.z",
    "ip_address": "1.2.3.4",
    "os_chipset": "Apple M1 Pro",
    "os_hostname": "dmurphy-laptop",
    "os_platform": "macOS",
    "os_serial": "A1B2C3D4E5F6G7",
    "os_uuid": "A1B2C3D4-E5F6-G7H8-I9J0-K1L2M3N4O5P6",
    "os_version": "x.y.z",
    "count": {
      "audit_logs_parent": 123,
      "audit_logs_record": 123,
      "audit_logs_related": 123
    },
    "timestamp": {
      "created_at": "2024-03-15T10:30:00.000000Z",
      "updated_at": "2024-03-15T14:22:00.000000Z",
      "deleted_at": null
    },
    "included": {
      "refresh_token": {
        "workspace_id": "hqwks_01ka7gx38jf1za86ns4c6114at",
        "workspace_token_id": "wstok_01hq8xyzabc123def456ghi789",
        "token_type": "cli_activation",
        "created_at": "2023-11-07T05:31:56Z",
        "last_used_at": "2023-11-07T05:31:56Z",
        "expires_at": "2023-11-07T05:31:56Z",
        "expires_at_mins": 60,
        "requested_at": "2023-11-07T05:31:56Z"
      },
      "workspace_user": {
        "id": "wsusr_01hq8xyzabc123def456ghi789",
        "state": "staged",
        "provider": "hq",
        "provider_id": "<string>",
        "name": "<string>",
        "handle": "<string>",
        "email": "<string>"
      }
    },
    "links": {
      "self": "https://ws-a1b2c3.provisionr.io/api/v1/workspace/devices/wsdev_01hq8xyzabc123def456ghi789"
    }
  }
]

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter[id]

string

filter[workspace_user_id]

string

filter[app_composer_path]

string

filter[app_composer_version]

string

filter[app_cli_version]

string

filter[app_php_path]

string

filter[app_php_version]

string

filter[ip_address]

string

filter[os_chipset]

string

filter[os_hostname]

string

filter[os_hostname_search]

string

filter[os_platform]

string

filter[os_serial]

string

filter[os_serial_search]

string

filter[os_uuid]

string

filter[os_uuid_search]

string

filter[os_version]

string

filter[created_before]

string

filter[created_after]

string

filter[updated_before]

string

filter[updated_after]

string

filter[deleted_before]

string

filter[deleted_after]

string

filter[trashed]

string

Can be a value of with (response will contain deleted items as well), only (will contain only deleted items), or any arbitrary value (will contain only not deleted items).

sort

enum<string>[]

Available options:

workspace_user_id,

-workspace_user_id,

app_composer_path,

-app_composer_path,

app_composer_version,

-app_composer_version,

app_cli_version,

-app_cli_version,

app_php_path,

-app_php_path,

app_php_version,

-app_php_version,

ip_address,

-ip_address,

os_chipset,

-os_chipset,

os_hostname,

-os_hostname,

os_platform,

-os_platform,

os_serial,

-os_serial,

os_uuid,

-os_uuid,

os_version,

-os_version,

-user_id,

--user_id,

-app_composer_path,

--app_composer_path,

-app_composer_version,

--app_composer_version,

-app_cli_version,

--app_cli_version,

-app_php_path,

--app_php_path,

-app_php_version,

--app_php_version,

-ip_address,

--ip_address,

-os_chipset,

--os_chipset,

-os_hostname,

--os_hostname,

-os_platform,

--os_platform,

-os_serial,

--os_serial,

-os_uuid,

--os_uuid,

-os_version,

--os_version

Response

The collection of WorkspaceDeviceDetailedResponseData

string

required

Example:

"wsdev_01hq8xyzabc123def456ghi789"

app_composer_path

string | null

required

Example:

"/opt/homebrew/bin/composer"

app_composer_version

string | null

required

Example:

"x.y.z"

app_cli_version

string | null

required

Example:

"x.y.z"

app_php_path

string | null

required

Example:

"/opt/homebrew/bin/php"

app_php_version

string | null

required

Example:

"x.y.z"

ip_address

string | null

required

Example:

"1.2.3.4"

os_chipset

string | null

required

Example:

"Apple M1 Pro"

os_hostname

string | null

required

Example:

"dmurphy-laptop"

os_platform

string | null

required

Example:

"macOS"

os_serial

string | null

required

Example:

"A1B2C3D4E5F6G7"

os_uuid

string | null

required

Example:

"A1B2C3D4-E5F6-G7H8-I9J0-K1L2M3N4O5P6"

os_version

string | null

required

Example:

"x.y.z"

count

object

required

Count of related records

Show child attributes

timestamp

object

required

The timestamps for the workspace device record

Show child attributes

Example:

{
  "created_at": "2024-03-15T10:30:00.000000Z",
  "updated_at": "2024-03-15T14:22:00.000000Z",
  "deleted_at": null
}

included

object

required

Included related resources for the workspace device record

Show child attributes

links

object

required

API hyperlinks related to the workspace device record

Show child attributes

Example:

{
  "self": "https://ws-a1b2c3.provisionr.io/api/v1/workspace/devices/wsdev_01hq8xyzabc123def456ghi789"
}

Getting Started

Endpoints

List of CLI Devices

Authorizations

Query Parameters

Response