Create a Service Account

curl --request POST \
  --url https://wksusa1b2c3d.provisionr.app/api/v1/workspace/services \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "environment_type": "production",
  "name": "Helpdesk Ticket Automation",
  "handle": "helpdesk",
  "description": "This service provides helpdesk functionality for IT support.",
  "metadata": "['managed_by' => 'IT Team', 'service_level' => 'gold', 'support_contact' => '[email protected]']",
  "admin_notes": "This service is critical for IT operations.",
  "audit_notes": "Reviewed on 2024-01-15 for compliance.",
  "permission_notes": "Permissions are managed by the IT team.",
  "token_notes": "Tokens are rotated every 90 days.",
  "ipv4_allowed": "['1.2.3.4/32', '10.0.0.0/24']",
  "ipv6_allowed": "['2001:0db8::1', '2001:0db8::/32']"
}
EOF

$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://wksusa1b2c3d.provisionr.app/api/v1/workspace/services' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "environment_type": "production",
  "name": "Helpdesk Ticket Automation",
  "handle": "helpdesk",
  "description": "This service provides helpdesk functionality for IT support.",
  "metadata": "['managed_by' => 'IT Team', 'service_level' => 'gold', 'support_contact' => '[email protected]']",
  "admin_notes": "This service is critical for IT operations.",
  "audit_notes": "Reviewed on 2024-01-15 for compliance.",
  "permission_notes": "Permissions are managed by the IT team.",
  "token_notes": "Tokens are rotated every 90 days.",
  "ipv4_allowed": "['1.2.3.4/32', '10.0.0.0/24']",
  "ipv6_allowed": "['2001:0db8::1', '2001:0db8::/32']"
}'

import requests

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

payload = {
    "environment_type": "production",
    "name": "Helpdesk Ticket Automation",
    "handle": "helpdesk",
    "description": "This service provides helpdesk functionality for IT support.",
    "metadata": "['managed_by' => 'IT Team', 'service_level' => 'gold', 'support_contact' => '[email protected]']",
    "admin_notes": "This service is critical for IT operations.",
    "audit_notes": "Reviewed on 2024-01-15 for compliance.",
    "permission_notes": "Permissions are managed by the IT team.",
    "token_notes": "Tokens are rotated every 90 days.",
    "ipv4_allowed": "['1.2.3.4/32', '10.0.0.0/24']",
    "ipv6_allowed": "['2001:0db8::1', '2001:0db8::/32']"
}
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({
    environment_type: 'production',
    name: 'Helpdesk Ticket Automation',
    handle: 'helpdesk',
    description: 'This service provides helpdesk functionality for IT support.',
    metadata: '[\'managed_by\' => \'IT Team\', \'service_level\' => \'gold\', \'support_contact\' => \'[email protected]\']',
    admin_notes: 'This service is critical for IT operations.',
    audit_notes: 'Reviewed on 2024-01-15 for compliance.',
    permission_notes: 'Permissions are managed by the IT team.',
    token_notes: 'Tokens are rotated every 90 days.',
    ipv4_allowed: '[\'1.2.3.4/32\', \'10.0.0.0/24\']',
    ipv6_allowed: '[\'2001:0db8::1\', \'2001:0db8::/32\']'
  })
};

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

{
  "id": "wssvc_01hq8xyzabc123def456ghi789",
  "state": "staged",
  "environment": "demo",
  "name": "<string>",
  "handle": "<string>",
  "description": "<string>",
  "admin_notes": "<string>",
  "audit_notes": "<string>",
  "permission_notes": "<string>",
  "token_notes": "<string>",
  "ipv4_allowed": [
    "<string>"
  ],
  "ipv6_allowed": [
    "<string>"
  ],
  "timestamp": {
    "created_at": "2025-01-28T13:37:00Z",
    "updated_at": "2025-01-28T13:37:00Z",
    "deleted_at": null,
    "activated_at": "2025-01-28T13:37:00Z",
    "expires_at": null,
    "last_activity_at": "2025-03-14T15:07:00Z",
    "last_authenticated_at": "2025-03-14T15:07:00Z"
  },
  "count": {
    "audit_logs_parent": 123,
    "audit_logs_record": 123,
    "workspace_admins": 123,
    "workspace_roles": 123,
    "workspace_tokens": 123
  },
  "included": [
    "<string>"
  ],
  "links": {
    "self": "<string>",
    "admins": "<string>",
    "permissions": "<string>",
    "tokens": "<string>"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

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

POST

workspace

services

Create a Service Account

curl --request POST \
  --url https://wksusa1b2c3d.provisionr.app/api/v1/workspace/services \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "environment_type": "production",
  "name": "Helpdesk Ticket Automation",
  "handle": "helpdesk",
  "description": "This service provides helpdesk functionality for IT support.",
  "metadata": "['managed_by' => 'IT Team', 'service_level' => 'gold', 'support_contact' => '[email protected]']",
  "admin_notes": "This service is critical for IT operations.",
  "audit_notes": "Reviewed on 2024-01-15 for compliance.",
  "permission_notes": "Permissions are managed by the IT team.",
  "token_notes": "Tokens are rotated every 90 days.",
  "ipv4_allowed": "['1.2.3.4/32', '10.0.0.0/24']",
  "ipv6_allowed": "['2001:0db8::1', '2001:0db8::/32']"
}
EOF

$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://wksusa1b2c3d.provisionr.app/api/v1/workspace/services' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "environment_type": "production",
  "name": "Helpdesk Ticket Automation",
  "handle": "helpdesk",
  "description": "This service provides helpdesk functionality for IT support.",
  "metadata": "['managed_by' => 'IT Team', 'service_level' => 'gold', 'support_contact' => '[email protected]']",
  "admin_notes": "This service is critical for IT operations.",
  "audit_notes": "Reviewed on 2024-01-15 for compliance.",
  "permission_notes": "Permissions are managed by the IT team.",
  "token_notes": "Tokens are rotated every 90 days.",
  "ipv4_allowed": "['1.2.3.4/32', '10.0.0.0/24']",
  "ipv6_allowed": "['2001:0db8::1', '2001:0db8::/32']"
}'

import requests

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

payload = {
    "environment_type": "production",
    "name": "Helpdesk Ticket Automation",
    "handle": "helpdesk",
    "description": "This service provides helpdesk functionality for IT support.",
    "metadata": "['managed_by' => 'IT Team', 'service_level' => 'gold', 'support_contact' => '[email protected]']",
    "admin_notes": "This service is critical for IT operations.",
    "audit_notes": "Reviewed on 2024-01-15 for compliance.",
    "permission_notes": "Permissions are managed by the IT team.",
    "token_notes": "Tokens are rotated every 90 days.",
    "ipv4_allowed": "['1.2.3.4/32', '10.0.0.0/24']",
    "ipv6_allowed": "['2001:0db8::1', '2001:0db8::/32']"
}
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({
    environment_type: 'production',
    name: 'Helpdesk Ticket Automation',
    handle: 'helpdesk',
    description: 'This service provides helpdesk functionality for IT support.',
    metadata: '[\'managed_by\' => \'IT Team\', \'service_level\' => \'gold\', \'support_contact\' => \'[email protected]\']',
    admin_notes: 'This service is critical for IT operations.',
    audit_notes: 'Reviewed on 2024-01-15 for compliance.',
    permission_notes: 'Permissions are managed by the IT team.',
    token_notes: 'Tokens are rotated every 90 days.',
    ipv4_allowed: '[\'1.2.3.4/32\', \'10.0.0.0/24\']',
    ipv6_allowed: '[\'2001:0db8::1\', \'2001:0db8::/32\']'
  })
};

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

{
  "id": "wssvc_01hq8xyzabc123def456ghi789",
  "state": "staged",
  "environment": "demo",
  "name": "<string>",
  "handle": "<string>",
  "description": "<string>",
  "admin_notes": "<string>",
  "audit_notes": "<string>",
  "permission_notes": "<string>",
  "token_notes": "<string>",
  "ipv4_allowed": [
    "<string>"
  ],
  "ipv6_allowed": [
    "<string>"
  ],
  "timestamp": {
    "created_at": "2025-01-28T13:37:00Z",
    "updated_at": "2025-01-28T13:37:00Z",
    "deleted_at": null,
    "activated_at": "2025-01-28T13:37:00Z",
    "expires_at": null,
    "last_activity_at": "2025-03-14T15:07:00Z",
    "last_authenticated_at": "2025-03-14T15:07:00Z"
  },
  "count": {
    "audit_logs_parent": 123,
    "audit_logs_record": 123,
    "workspace_admins": 123,
    "workspace_roles": 123,
    "workspace_tokens": 123
  },
  "included": [
    "<string>"
  ],
  "links": {
    "self": "<string>",
    "admins": "<string>",
    "permissions": "<string>",
    "tokens": "<string>"
  }
}

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

CreateWorkspaceServiceData

environment_type

enum<string>

required

The environment type where this service will be available


`demo` Demo Environment with Seeded Industry Data
`sandbox` Sandbox and Experiment Environment
`development` Local Development Environment
`testing` Automated or Unit Environment
`staging` Staging or User Acceptance Testing Environment
`production` Production Environment
`unknown` New Environment (Not Configured Yet)

Available options:

demo,

sandbox,

development,

testing,

staging,

production,

unknown

Example:

"production"

name

string

required

The display name of the service account

Maximum string length: 55

Example:

"Helpdesk Ticket Automation"

handle

string

required

The unique handle/identifier for the service account

Maximum string length: 55

Example:

"helpdesk"

description

string

required

A detailed description of the service account

Example:

"This service provides helpdesk functionality for IT support."

metadata

string[]

required

An array of business and context metadata about this service.

This is cosemetic only for system administrator reference and provides structured data in API responses

Minimum array length: 1

Example:

"['managed_by' => 'IT Team', 'service_level' => 'gold', 'support_contact' => '[email protected]']"

admin_notes

string

required

Administrative notes about this service account

Example:

"This service is critical for IT operations."

audit_notes

string

required

Audit notes about this service account

Example:

"Reviewed on 2024-01-15 for compliance."

permission_notes

string

required

Permission notes about this service account

Example:

"Permissions are managed by the IT team."

token_notes

string

required

Token notes about this service account

Example:

"Tokens are rotated every 90 days."

ipv4_allowed

string[]

required

An array of allowed IPv4 address CIDR ranges that can access the Provisionr API using a service token

Minimum array length: 1

Example:

"['1.2.3.4/32', '10.0.0.0/24']"

ipv6_allowed

string[]

required

An array of allowed IPv6 address CIDR ranges that can access the Provisionr API using a service token

Minimum array length: 1

Example:

"['2001:0db8::1', '2001:0db8::/32']"

Response

WorkspaceServiceDetailedResponseData

string

required

Example:

"wssvc_01hq8xyzabc123def456ghi789"

state

enum<string>

required


`staged` The record is staged and is only visible to administrators or in the API. Use the `activate` method during your change window.
`active` The record is active.
`expiring` The `expires_at` value is set in the future for the record. You can run the `activate` action to remove the scheduled expiration.
`expired` The `expires_at` value is in the past and the record was deactivated.
`deactivated` The record was deactivated manually by an administrator.

Available options:

staged,

active,

expiring,

expired,

deactivated

environment

enum<string>

required


`demo` Demo Environment with Seeded Industry Data
`sandbox` Sandbox and Experiment Environment
`development` Local Development Environment
`testing` Automated or Unit Environment
`staging` Staging or User Acceptance Testing Environment
`production` Production Environment
`unknown` New Environment (Not Configured Yet)

Available options:

demo,

sandbox,

development,

testing,

staging,

production,

unknown

name

string

required

handle

string

required

description

string | null

required

admin_notes

string | null

required

audit_notes

string | null

required

permission_notes

string | null

required

token_notes

string | null

required

ipv4_allowed

string[] | null

required

ipv6_allowed

string[] | null

required

timestamp

WorkspaceServiceNestedTimestampResponseData · object

required

Show child attributes

count

WorkspaceServiceNestedCountResponseData · object

required

Show child attributes

included

string[]

required

Minimum array length: 1

links

object

required

API hyperlinks related to the workspace service record

Show child attributes

Getting Started

Endpoints

Create a Service Account

Authorizations

Body

Response