Create a CLI Device

curl --request POST \
  --url https://wksusa1b2c3d.provisionr.app/api/v1/workspace/devices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_user_id": "wsusr_01hq8xyzabc123def456ghi789",
  "app_composer_path": "/Users/masked/Library/Application Support/Herd/bin//composer",
  "app_composer_version": "x.y.z",
  "app_cli_version": "x.y.z",
  "app_php_path": "/Users/masked/Library/Application Support/Herd/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"
}
'

$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://wksusa1b2c3d.provisionr.app/api/v1/workspace/devices' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "workspace_user_id": "wsusr_01hq8xyzabc123def456ghi789",
  "app_composer_path": "/Users/masked/Library/Application Support/Herd/bin//composer",
  "app_composer_version": "x.y.z",
  "app_cli_version": "x.y.z",
  "app_php_path": "/Users/masked/Library/Application Support/Herd/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"
}'

import requests

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

payload = {
    "workspace_user_id": "wsusr_01hq8xyzabc123def456ghi789",
    "app_composer_path": "/Users/masked/Library/Application Support/Herd/bin//composer",
    "app_composer_version": "x.y.z",
    "app_cli_version": "x.y.z",
    "app_php_path": "/Users/masked/Library/Application Support/Herd/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"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    workspace_user_id: 'wsusr_01hq8xyzabc123def456ghi789',
    app_composer_path: '/Users/masked/Library/Application Support/Herd/bin//composer',
    app_composer_version: 'x.y.z',
    app_cli_version: 'x.y.z',
    app_php_path: '/Users/masked/Library/Application Support/Herd/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'
  })
};

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

{
  "message": "<string>",
  "errors": {}
}

POST

workspace

devices

Create a CLI Device

curl --request POST \
  --url https://wksusa1b2c3d.provisionr.app/api/v1/workspace/devices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_user_id": "wsusr_01hq8xyzabc123def456ghi789",
  "app_composer_path": "/Users/masked/Library/Application Support/Herd/bin//composer",
  "app_composer_version": "x.y.z",
  "app_cli_version": "x.y.z",
  "app_php_path": "/Users/masked/Library/Application Support/Herd/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"
}
'

$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://wksusa1b2c3d.provisionr.app/api/v1/workspace/devices' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "workspace_user_id": "wsusr_01hq8xyzabc123def456ghi789",
  "app_composer_path": "/Users/masked/Library/Application Support/Herd/bin//composer",
  "app_composer_version": "x.y.z",
  "app_cli_version": "x.y.z",
  "app_php_path": "/Users/masked/Library/Application Support/Herd/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"
}'

import requests

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

payload = {
    "workspace_user_id": "wsusr_01hq8xyzabc123def456ghi789",
    "app_composer_path": "/Users/masked/Library/Application Support/Herd/bin//composer",
    "app_composer_version": "x.y.z",
    "app_cli_version": "x.y.z",
    "app_php_path": "/Users/masked/Library/Application Support/Herd/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"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    workspace_user_id: 'wsusr_01hq8xyzabc123def456ghi789',
    app_composer_path: '/Users/masked/Library/Application Support/Herd/bin//composer',
    app_composer_version: 'x.y.z',
    app_cli_version: 'x.y.z',
    app_php_path: '/Users/masked/Library/Application Support/Herd/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'
  })
};

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

{
  "message": "<string>",
  "errors": {}
}

Authorizations

Authorization

string

header

required

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

Body

application/json

CreateWorkspaceDeviceRequestData

workspace_user_id

string

required

Pattern: ^wsusr_[0-9a-hjkmnp-tv-z]{26}$

Example:

"wsusr_01hq8xyzabc123def456ghi789"

app_composer_path

string

required

The path to the Composer installation on the client.

If it starts with /Users/, the username portion of the path is masked for privacy. The only exposed data is in the os_hostname which is used for device trust verification by some organizations

Maximum string length: 255

Example:

"/Users/masked/Library/Application Support/Herd/bin//composer"

app_composer_version

string

required

Example:

"x.y.z"

app_cli_version

string

required

Maximum string length: 55

Example:

"x.y.z"

app_php_path

string

required

The path to the PHP installation on the client.

If it starts with /Users/, the username portion of the path is masked for privacy. The only exposed data is in the os_hostname which is used for device trust verification by some organizations

Maximum string length: 255

Example:

"/Users/masked/Library/Application Support/Herd/bin//php"

app_php_version

string

required

Example:

"x.y.z"

ip_address

string

required

Example:

"1.2.3.4"

os_chipset

string

required

Maximum string length: 55

Example:

"Apple M1 Pro"

os_hostname

string

required

Maximum string length: 256

Example:

"dmurphy-laptop"

os_platform

enum<string>

required

Available options:

macOS

Maximum string length: 55

Example:

"macOS"

os_serial

string

required

Required string length: 8 - 14

Example:

"A1B2C3D4E5F6G7"

os_uuid

string

required

Example:

"A1B2C3D4-E5F6-G7H8-I9J0-K1L2M3N4O5P6"

os_version

string

required

Example:

"x.y.z"

Response

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

Create a CLI Device

Authorizations

Body

Response