Organizations

List organization invitations for authenticated user

GET/organizations/invitations

Authorization

AuthorizationBearer <token>

API Key access

In: header

`application/json`

curl -X GET "https://example.com/organizations/invitations"

[  {    "id": "string",    "email": "string",    "invitedBy": "string",    "organizationId": "string",    "organizationName": "string",    "expiresAt": "2019-08-24T14:15:22Z",    "status": "pending",    "role": "owner",    "assignedRoles": [      {        "id": "string",        "name": "string",        "description": "string",        "permissions": [          "write:registries"        ],        "isGlobal": true,        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ],    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }]

Get count of organization invitations for authenticated user

GET/organizations/invitations/count

Authorization

AuthorizationBearer <token>

API Key access

In: header

`application/json`

curl -X GET "https://example.com/organizations/invitations/count"

Accept organization invitation

POST/organizations/invitations/{invitationId}/accept

Authorization

AuthorizationBearer <token>

API Key access

In: header

`application/json`

curl -X POST "https://example.com/organizations/invitations/string/accept"

{  "id": "string",  "email": "string",  "invitedBy": "string",  "organizationId": "string",  "organizationName": "string",  "expiresAt": "2019-08-24T14:15:22Z",  "status": "pending",  "role": "owner",  "assignedRoles": [    {      "id": "string",      "name": "string",      "description": "string",      "permissions": [        "write:registries"      ],      "isGlobal": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Decline organization invitation

POST/organizations/invitations/{invitationId}/decline

Authorization

AuthorizationBearer <token>

API Key access

In: header

List organizations

GET/organizations

Authorization

AuthorizationBearer <token>

API Key access

In: header

`application/json`

curl -X GET "https://example.com/organizations"

[  {    "id": "string",    "name": "string",    "createdBy": "string",    "personal": true,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "suspended": true,    "suspendedAt": "2019-08-24T14:15:22Z",    "suspensionReason": "string",    "suspendedUntil": "2019-08-24T14:15:22Z",    "suspensionCleanupGracePeriodHours": 0,    "maxCpuPerSandbox": 0,    "maxMemoryPerSandbox": 0,    "maxDiskPerSandbox": 0,    "secretQuota": 0,    "maxSecretsPerSandbox": 0,    "snapshotDeactivationTimeoutMinutes": 20160,    "sandboxLimitedNetworkEgress": true,    "previewWarningEnabled": true,    "ssoEnabled": true,    "defaultRegionId": "string",    "authenticatedRateLimit": 0,    "sandboxCreateRateLimit": 0,    "sandboxLifecycleRateLimit": 0,    "experimentalConfig": {},    "otelConfig": {      "endpoint": "string",      "headers": {        "x-api-key": "my-api-key"      },      "organizationId": "string"    },    "authenticatedRateLimitTtlSeconds": 0,    "sandboxCreateRateLimitTtlSeconds": 0,    "sandboxLifecycleRateLimitTtlSeconds": 0  }]

Create organization

POST/organizations

Authorization

AuthorizationBearer <token>

API Key access

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

The name of organization

defaultRegionId*string

The ID of the default region for the organization

`application/json`

curl -X POST "https://example.com/organizations" \  -H "Content-Type: application/json" \  -d '{    "name": "My Organization",    "defaultRegionId": "us"  }'

{  "id": "string",  "name": "string",  "createdBy": "string",  "personal": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "suspended": true,  "suspendedAt": "2019-08-24T14:15:22Z",  "suspensionReason": "string",  "suspendedUntil": "2019-08-24T14:15:22Z",  "suspensionCleanupGracePeriodHours": 0,  "maxCpuPerSandbox": 0,  "maxMemoryPerSandbox": 0,  "maxDiskPerSandbox": 0,  "secretQuota": 0,  "maxSecretsPerSandbox": 0,  "snapshotDeactivationTimeoutMinutes": 20160,  "sandboxLimitedNetworkEgress": true,  "previewWarningEnabled": true,  "ssoEnabled": true,  "defaultRegionId": "string",  "authenticatedRateLimit": 0,  "sandboxCreateRateLimit": 0,  "sandboxLifecycleRateLimit": 0,  "experimentalConfig": {},  "otelConfig": {    "endpoint": "string",    "headers": {      "x-api-key": "my-api-key"    },    "organizationId": "string"  },  "authenticatedRateLimitTtlSeconds": 0,  "sandboxCreateRateLimitTtlSeconds": 0,  "sandboxLifecycleRateLimitTtlSeconds": 0}

Set default region for organization

PATCH/organizations/{organizationId}/default-region

Authorization

AuthorizationBearer <token>

API Key access

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

defaultRegionId*string

The ID of the default region for the organization

Get organization by ID

GET/organizations/{organizationId}

Authorization

AuthorizationBearer <token>

API Key access

In: header

`application/json`

curl -X GET "https://example.com/organizations/string"

{  "id": "string",  "name": "string",  "createdBy": "string",  "personal": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "suspended": true,  "suspendedAt": "2019-08-24T14:15:22Z",  "suspensionReason": "string",  "suspendedUntil": "2019-08-24T14:15:22Z",  "suspensionCleanupGracePeriodHours": 0,  "maxCpuPerSandbox": 0,  "maxMemoryPerSandbox": 0,  "maxDiskPerSandbox": 0,  "secretQuota": 0,  "maxSecretsPerSandbox": 0,  "snapshotDeactivationTimeoutMinutes": 20160,  "sandboxLimitedNetworkEgress": true,  "previewWarningEnabled": true,  "ssoEnabled": true,  "defaultRegionId": "string",  "authenticatedRateLimit": 0,  "sandboxCreateRateLimit": 0,  "sandboxLifecycleRateLimit": 0,  "experimentalConfig": {},  "otelConfig": {    "endpoint": "string",    "headers": {      "x-api-key": "my-api-key"    },    "organizationId": "string"  },  "authenticatedRateLimitTtlSeconds": 0,  "sandboxCreateRateLimitTtlSeconds": 0,  "sandboxLifecycleRateLimitTtlSeconds": 0}

Get organization current usage overview

GET/organizations/{organizationId}/usage

Authorization

AuthorizationBearer <token>

API Key access

In: header

`application/json`

curl -X GET "https://example.com/organizations/string/usage"

{  "regionUsage": [    {      "regionId": "string",      "sandboxClass": "linux-vm",      "totalCpuQuota": 0,      "currentCpuUsage": 0,      "totalMemoryQuota": 0,      "currentMemoryUsage": 0,      "totalDiskQuota": 0,      "currentDiskUsage": 0,      "totalGpuQuota": 0,      "currentGpuUsage": 0,      "allowedGpuTypes": [        "H100"      ],      "maxCpuPerSandbox": 0,      "maxMemoryPerSandbox": 0,      "maxDiskPerSandbox": 0,      "maxDiskPerNonEphemeralSandbox": 0,      "maxCpuPerGpu": 0,      "maxMemoryPerGpu": 0,      "maxDiskPerGpu": 0    }  ],  "totalSnapshotQuota": 0,  "currentSnapshotUsage": 0,  "totalVolumeQuota": 0,  "currentVolumeUsage": 0}

List available sandbox classes for organization

GET/organizations/{organizationId}/available-sandbox-classes

Authorization

AuthorizationBearer <token>

API Key access

In: header

`application/json`

curl -X GET "https://example.com/organizations/string/available-sandbox-classes"

[  {    "regionId": "string",    "sandboxClass": "linux-vm",    "gpuAvailable": true,    "allowedGpuTypes": [      "H100"    ]  }]

Update organization region quota

PATCH/organizations/{organizationId}/quota/{regionId}

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

regionId*string

ID of the region where the updated quota will be applied

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

sandboxClass?string

Value in

"linux-vm"
"container"
"android"
"windows"

totalCpuQuota*number|null

totalMemoryQuota*number|null

totalDiskQuota*number|null

totalGpuQuota*number|null

allowedGpuTypes?array<>|null

maxCpuPerSandbox?number|null

maxMemoryPerSandbox?number|null

maxDiskPerSandbox?number|null

maxDiskPerNonEphemeralSandbox?number|null

maxCpuPerGpu?|

CPU maximum per requested GPU unit for GPU sandboxes.

maxMemoryPerGpu?|

Memory maximum per requested GPU unit for GPU sandboxes.

maxDiskPerGpu?|

Disk maximum per requested GPU unit for GPU sandboxes.

maxSandboxLifespan?|

Maximum sandbox lifespan in minutes, measured from sandbox creation to its auto-destroy deadline. If null or 0, lifespan is unrestricted. When set, sandboxes created without a TTL default to this lifespan and TTL cannot be disabled.

Response Body

curl -X PATCH "https://example.com/organizations/string/quota/string" \  -H "Content-Type: application/json" \  -d '{    "totalCpuQuota": 0,    "totalMemoryQuota": 0,    "totalDiskQuota": 0,    "totalGpuQuota": 0  }'

Empty

Leave organization

POST/organizations/{organizationId}/leave

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

Response Body

curl -X POST "https://example.com/organizations/string/leave"

Empty

Suspend organization

POST/organizations/{organizationId}/suspend

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

reason*string

Suspension reason

until*string

Suspension until

Formatdate-time

suspensionCleanupGracePeriodHours?number

Suspension cleanup grace period hours

Range0 <= value

Response Body

curl -X POST "https://example.com/organizations/string/suspend" \  -H "Content-Type: application/json" \  -d '{    "reason": "string",    "until": "2019-08-24T14:15:22Z"  }'

Empty

Unsuspend organization

POST/organizations/{organizationId}/unsuspend

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

Response Body

curl -X POST "https://example.com/organizations/string/unsuspend"

Empty

Get organization OTEL config by sandbox auth token

GET/organizations/otel-config/by-sandbox-auth-token/{authToken}

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

authToken*string

Sandbox Auth Token

Response Body

`application/json`

curl -X GET "https://example.com/organizations/otel-config/by-sandbox-auth-token/string"

{  "endpoint": "string",  "headers": {    "x-api-key": "my-api-key"  },  "organizationId": "string"}

Get organization OTEL config by organization ID

GET/organizations/{organizationId}/otel-config

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

Response Body

`application/json`

curl -X GET "https://example.com/organizations/string/otel-config"

{  "endpoint": "string",  "headers": {    "x-api-key": "my-api-key"  },  "organizationId": "string"}

Delete organization OpenTelemetry configuration

DELETE/organizations/{organizationId}/otel-config

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

Response Body

curl -X DELETE "https://example.com/organizations/string/otel-config"

Empty

Update organization OpenTelemetry configuration

PUT/organizations/{organizationId}/otel-config

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

endpoint*string

Endpoint

headers?|

Headers

organizationId?string

Organization ID the config belongs to

Response Body

curl -X PUT "https://example.com/organizations/string/otel-config" \  -H "Content-Type: application/json" \  -d '{    "endpoint": "string"  }'

Empty

Update sandbox default limited network egress

POST/organizations/{organizationId}/sandbox-default-limited-network-egress

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

sandboxDefaultLimitedNetworkEgress*boolean

Sandbox default limited network egress

Response Body

curl -X POST "https://example.com/organizations/string/sandbox-default-limited-network-egress" \  -H "Content-Type: application/json" \  -d '{    "sandboxDefaultLimitedNetworkEgress": true  }'

Empty

Update organization preview warning

POST/organizations/{organizationId}/preview-warning

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

previewWarningEnabled*boolean

Whether the proxy shows the preview URL warning page for this organization

Response Body

curl -X POST "https://example.com/organizations/string/preview-warning" \  -H "Content-Type: application/json" \  -d '{    "previewWarningEnabled": true  }'

Empty

Update organization SSO entitlement

POST/organizations/{organizationId}/sso-enabled

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

ssoEnabled*boolean

Whether this organization may configure SSO identity providers

Response Body

curl -X POST "https://example.com/organizations/string/sso-enabled" \  -H "Content-Type: application/json" \  -d '{    "ssoEnabled": true  }'

Empty

Update experimental configuration

PUT/organizations/{organizationId}/experimental-config

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

Request Body

application/json

Experimental configuration as a JSON object. Set to null to clear the configuration.

TypeScript Definitions

Use the request body type in TypeScript.

body?unknown

Response Body

curl -X PUT "https://example.com/organizations/string/experimental-config" \  -H "Content-Type: application/json" \  -d '{    "otel": {      "endpoint": "http://otel-collector:4317",      "headers": {        "api-key": "XXX"      }    }  }'

Empty

List organization roles

GET/organizations/{organizationId}/roles

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

Response Body

`application/json`

curl -X GET "https://example.com/organizations/string/roles"

[  {    "id": "string",    "name": "string",    "description": "string",    "permissions": [      "write:registries"    ],    "isGlobal": true,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }]

Create organization role

POST/organizations/{organizationId}/roles

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

The name of the role

description*string

The description of the role

permissions*array<>

The list of permissions assigned to the role

Response Body

`application/json`

curl -X POST "https://example.com/organizations/string/roles" \  -H "Content-Type: application/json" \  -d '{    "name": "Maintainer",    "description": "Can manage all resources",    "permissions": [      "write:registries"    ]  }'

{  "id": "string",  "name": "string",  "description": "string",  "permissions": [    "write:registries"  ],  "isGlobal": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete organization role

DELETE/organizations/{organizationId}/roles/{roleId}

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

roleId*string

Role ID

Response Body

curl -X DELETE "https://example.com/organizations/string/roles/string"

Empty

Update organization role

PUT/organizations/{organizationId}/roles/{roleId}

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

roleId*string

Role ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

The name of the role

description*string

The description of the role

permissions*array<>

The list of permissions assigned to the role

Response Body

`application/json`

curl -X PUT "https://example.com/organizations/string/roles/string" \  -H "Content-Type: application/json" \  -d '{    "name": "Maintainer",    "description": "Can manage all resources",    "permissions": [      "write:registries"    ]  }'

{  "id": "string",  "name": "string",  "description": "string",  "permissions": [    "write:registries"  ],  "isGlobal": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

List organization members

GET/organizations/{organizationId}/users

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

Response Body

`application/json`

curl -X GET "https://example.com/organizations/string/users"

[  {    "userId": "string",    "organizationId": "string",    "name": "string",    "email": "string",    "role": "owner",    "assignedRoles": [      {        "id": "string",        "name": "string",        "description": "string",        "permissions": [          "write:registries"        ],        "isGlobal": true,        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ],    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }]

Update access for organization member

POST/organizations/{organizationId}/users/{userId}/access

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

userId*string

User ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

role*string

Organization member role

Default"member"

Value in

"owner"
"member"

assignedRoleIds*array<string>

Array of assigned role IDs

Default

[  "00000000-0000-0000-0000-000000000001"]

Response Body

`application/json`

curl -X POST "https://example.com/organizations/string/users/string/access" \  -H "Content-Type: application/json" \  -d '{    "role": "owner",    "assignedRoleIds": [      "00000000-0000-0000-0000-000000000001"    ]  }'

{  "userId": "string",  "organizationId": "string",  "name": "string",  "email": "string",  "role": "owner",  "assignedRoles": [    {      "id": "string",      "name": "string",      "description": "string",      "permissions": [        "write:registries"      ],      "isGlobal": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete organization member

DELETE/organizations/{organizationId}/users/{userId}

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

userId*string

User ID

Response Body

curl -X DELETE "https://example.com/organizations/string/users/string"

Empty

List pending organization invitations

GET/organizations/{organizationId}/invitations

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

Response Body

`application/json`

curl -X GET "https://example.com/organizations/string/invitations"

[  {    "id": "string",    "email": "string",    "invitedBy": "string",    "organizationId": "string",    "organizationName": "string",    "expiresAt": "2019-08-24T14:15:22Z",    "status": "pending",    "role": "owner",    "assignedRoles": [      {        "id": "string",        "name": "string",        "description": "string",        "permissions": [          "write:registries"        ],        "isGlobal": true,        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ],    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }]

Create organization invitation

POST/organizations/{organizationId}/invitations

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*string

Email address of the invitee

role*string

Organization member role for the invitee

Default"member"

Value in

"owner"
"member"

assignedRoleIds*array<string>

Array of assigned role IDs for the invitee

Default

[  "00000000-0000-0000-0000-000000000001"]

expiresAt?string

Expiration date of the invitation

Formatdate-time

Response Body

`application/json`

curl -X POST "https://example.com/organizations/string/invitations" \  -H "Content-Type: application/json" \  -d '{    "email": "mail@example.com",    "role": "owner",    "assignedRoleIds": [      "00000000-0000-0000-0000-000000000001"    ]  }'

{  "id": "string",  "email": "string",  "invitedBy": "string",  "organizationId": "string",  "organizationName": "string",  "expiresAt": "2019-08-24T14:15:22Z",  "status": "pending",  "role": "owner",  "assignedRoles": [    {      "id": "string",      "name": "string",      "description": "string",      "permissions": [        "write:registries"      ],      "isGlobal": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Update organization invitation

PUT/organizations/{organizationId}/invitations/{invitationId}

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

invitationId*string

Invitation ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

role*string

Organization member role

Value in

"owner"
"member"

assignedRoleIds*array<string>

Array of role IDs

expiresAt?string

Expiration date of the invitation

Formatdate-time

Response Body

`application/json`

curl -X PUT "https://example.com/organizations/string/invitations/string" \  -H "Content-Type: application/json" \  -d '{    "role": "owner",    "assignedRoleIds": [      "string"    ]  }'

{  "id": "string",  "email": "string",  "invitedBy": "string",  "organizationId": "string",  "organizationName": "string",  "expiresAt": "2019-08-24T14:15:22Z",  "status": "pending",  "role": "owner",  "assignedRoles": [    {      "id": "string",      "name": "string",      "description": "string",      "permissions": [        "write:registries"      ],      "isGlobal": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Cancel organization invitation

POST/organizations/{organizationId}/invitations/{invitationId}/cancel

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

invitationId*string

Invitation ID

Response Body

curl -X POST "https://example.com/organizations/string/invitations/string/cancel"

Empty

List all available regions for the organization

GET/regions

Authorization

AuthorizationBearer <token>

API Key access

In: header

Header Parameters

X-Daytona-Organization-ID?string

Use with JWT to specify the organization ID

Response Body

`application/json`

curl -X GET "https://example.com/regions"

[  {    "id": "123456789012",    "name": "us-east-1",    "organizationId": "123e4567-e89b-12d3-a456-426614174000",    "regionType": "shared",    "createdAt": "2023-01-01T00:00:00.000Z",    "updatedAt": "2023-01-01T00:00:00.000Z",    "proxyUrl": "https://proxy.example.com",    "sshGatewayUrl": "http://ssh-gateway.example.com",    "snapshotManagerUrl": "http://snapshot-manager.example.com",    "otelEndpoint": "https://otel-collector.example.com:4318"  }]

Create a new region

POST/regions

Authorization

AuthorizationBearer <token>

API Key access

In: header

Header Parameters

X-Daytona-Organization-ID?string

Use with JWT to specify the organization ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Region name

proxyUrl?|

Proxy URL for the region

sshGatewayUrl?|

SSH Gateway URL for the region

snapshotManagerUrl?|

Snapshot Manager URL for the region

otelEndpoint?|

OTel collector endpoint for sandboxes created in this region. When set, sandbox OTel data is sent to this endpoint instead of the Daytona-hosted collector and will not be available in the Daytona analytics API or dashboard.

Response Body

`application/json`

curl -X POST "https://example.com/regions" \  -H "Content-Type: application/json" \  -d '{    "name": "us-east-1"  }'

{  "id": "region_12345",  "proxyApiKey": "proxy-api-key-xyz",  "sshGatewayApiKey": "ssh-gateway-api-key-abc",  "snapshotManagerUsername": "daytona",  "snapshotManagerPassword": "string"}

Get region by ID

GET/regions/{id}

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

id*string

Region ID

Header Parameters

X-Daytona-Organization-ID?string

Use with JWT to specify the organization ID

Response Body

`application/json`

curl -X GET "https://example.com/regions/string"

{  "id": "123456789012",  "name": "us-east-1",  "organizationId": "123e4567-e89b-12d3-a456-426614174000",  "regionType": "shared",  "createdAt": "2023-01-01T00:00:00.000Z",  "updatedAt": "2023-01-01T00:00:00.000Z",  "proxyUrl": "https://proxy.example.com",  "sshGatewayUrl": "http://ssh-gateway.example.com",  "snapshotManagerUrl": "http://snapshot-manager.example.com",  "otelEndpoint": "https://otel-collector.example.com:4318"}

Update region configuration

PATCH/regions/{id}

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

id*string

Region ID

Header Parameters

X-Daytona-Organization-ID?string

Use with JWT to specify the organization ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

proxyUrl?|

Proxy URL for the region

sshGatewayUrl?|

SSH Gateway URL for the region

snapshotManagerUrl?|

Snapshot Manager URL for the region

otelEndpoint?|

Response Body

curl -X PATCH "https://example.com/regions/string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Delete a region

DELETE/regions/{id}

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

id*string

Region ID

Header Parameters

X-Daytona-Organization-ID?string

Use with JWT to specify the organization ID

Response Body

curl -X DELETE "https://example.com/regions/string"

Empty

Regenerate proxy API key for a region

POST/regions/{id}/regenerate-proxy-api-key

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

id*string

Region ID

Header Parameters

X-Daytona-Organization-ID?string

Use with JWT to specify the organization ID

Response Body

`application/json`

curl -X POST "https://example.com/regions/string/regenerate-proxy-api-key"

{  "apiKey": "api-key-xyz123"}

Regenerate SSH gateway API key for a region

POST/regions/{id}/regenerate-ssh-gateway-api-key

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

id*string

Region ID

Header Parameters

X-Daytona-Organization-ID?string

Use with JWT to specify the organization ID

Response Body

`application/json`

curl -X POST "https://example.com/regions/string/regenerate-ssh-gateway-api-key"

{  "apiKey": "api-key-xyz123"}

Regenerate snapshot manager credentials for a region

POST/regions/{id}/regenerate-snapshot-manager-credentials

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

id*string

Region ID

Header Parameters

X-Daytona-Organization-ID?string

Use with JWT to specify the organization ID

Response Body

`application/json`

curl -X POST "https://example.com/regions/string/regenerate-snapshot-manager-credentials"

{  "username": "daytona",  "password": "string"}

List organization identity providers

GET/organizations/{organizationId}/identity-providers

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

Response Body

`application/json`

curl -X GET "https://example.com/organizations/string/identity-providers"

[  {    "id": "123e4567-e89b-12d3-a456-426614174000",    "organizationId": "123e4567-e89b-12d3-a456-426614174000",    "name": "Company Okta",    "oidcConfig": {      "issuerUrl": "https://company.okta.com",      "clientId": "abc123",      "scope": "openid email profile"    },    "emailDomains": [      "company.com",      "corp.company.com"    ],    "allowAnyDomain": false,    "trustEmailVerified": false,    "defaultAssignedRoleIds": [      "00000000-0000-0000-0000-000000000001"    ],    "enabled": true,    "createdAt": "2025-01-01T00:00:00.000Z",    "updatedAt": "2025-01-01T00:00:00.000Z"  }]

Create organization identity provider

POST/organizations/{organizationId}/identity-providers

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Display name for the identity provider

oidcConfig*

OIDC configuration

emailDomains*array<string>

Email domains used for IdP discovery on the login form and to validate the user identity returned by the IdP. Required and must be non-empty unless allowAnyDomain is true.

Default[]

allowAnyDomain?boolean

When true, the IdP accepts any email domain returned by the external provider. Disables the post-callback domain check and allows emailDomains to be empty. Only enable for trusted IdPs that strictly control which users can authenticate.

Defaultfalse

trustEmailVerified?boolean

When true, skip the email_verified claim check on SSO logins through this identity provider. Only intended for providers that never emit the claim (e.g. Microsoft Entra ID). Risky: only enable if the IdP strictly controls its users' email addresses.

Defaultfalse

defaultAssignedRoleIds?array<string>

Organization role IDs assigned to users who join the organization via SSO through this identity provider. Roles must be global or belong to this organization. Empty (default) grants the lowest access: membership with no resource permissions.

Default[]

enabled?boolean

Whether the identity provider is enabled

Defaulttrue

Response Body

`application/json`

curl -X POST "https://example.com/organizations/string/identity-providers" \  -H "Content-Type: application/json" \  -d '{    "name": "Company Okta",    "oidcConfig": {      "issuerUrl": "https://company.okta.com",      "clientId": "abc123",      "clientSecret": "secret123"    },    "emailDomains": [      "company.com",      "corp.company.com"    ]  }'

{  "id": "123e4567-e89b-12d3-a456-426614174000",  "organizationId": "123e4567-e89b-12d3-a456-426614174000",  "name": "Company Okta",  "oidcConfig": {    "issuerUrl": "https://company.okta.com",    "clientId": "abc123",    "scope": "openid email profile"  },  "emailDomains": [    "company.com",    "corp.company.com"  ],  "allowAnyDomain": false,  "trustEmailVerified": false,  "defaultAssignedRoleIds": [    "00000000-0000-0000-0000-000000000001"  ],  "enabled": true,  "createdAt": "2025-01-01T00:00:00.000Z",  "updatedAt": "2025-01-01T00:00:00.000Z"}

Get organization identity provider

GET/organizations/{organizationId}/identity-providers/{id}

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

id*string

Identity provider ID

Response Body

`application/json`

curl -X GET "https://example.com/organizations/string/identity-providers/string"

{  "id": "123e4567-e89b-12d3-a456-426614174000",  "organizationId": "123e4567-e89b-12d3-a456-426614174000",  "name": "Company Okta",  "oidcConfig": {    "issuerUrl": "https://company.okta.com",    "clientId": "abc123",    "scope": "openid email profile"  },  "emailDomains": [    "company.com",    "corp.company.com"  ],  "allowAnyDomain": false,  "trustEmailVerified": false,  "defaultAssignedRoleIds": [    "00000000-0000-0000-0000-000000000001"  ],  "enabled": true,  "createdAt": "2025-01-01T00:00:00.000Z",  "updatedAt": "2025-01-01T00:00:00.000Z"}

Update organization identity provider

PATCH/organizations/{organizationId}/identity-providers/{id}

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

id*string

Identity provider ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Display name for the identity provider

oidcConfig?

OIDC configuration

emailDomains?array<string>

Email domains used for IdP discovery on the login form and to validate the user identity returned by the IdP. If provided and allowAnyDomain is not being set to true, must contain at least one domain. To clear domains in the same request, set allowAnyDomain: true and emailDomains: [].

allowAnyDomain?boolean

trustEmailVerified?boolean

defaultAssignedRoleIds?array<string>

Organization role IDs assigned to users who join the organization via SSO through this identity provider. Roles must be global or belong to this organization. Empty grants the lowest access: membership with no resource permissions.

enabled?boolean

Whether the identity provider is enabled

Response Body

`application/json`

curl -X PATCH "https://example.com/organizations/string/identity-providers/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "123e4567-e89b-12d3-a456-426614174000",  "organizationId": "123e4567-e89b-12d3-a456-426614174000",  "name": "Company Okta",  "oidcConfig": {    "issuerUrl": "https://company.okta.com",    "clientId": "abc123",    "scope": "openid email profile"  },  "emailDomains": [    "company.com",    "corp.company.com"  ],  "allowAnyDomain": false,  "trustEmailVerified": false,  "defaultAssignedRoleIds": [    "00000000-0000-0000-0000-000000000001"  ],  "enabled": true,  "createdAt": "2025-01-01T00:00:00.000Z",  "updatedAt": "2025-01-01T00:00:00.000Z"}

Delete organization identity provider

DELETE/organizations/{organizationId}/identity-providers/{id}

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

id*string

Identity provider ID

Response Body

curl -X DELETE "https://example.com/organizations/string/identity-providers/string"

Empty

Test OIDC identity provider connection

POST/organizations/{organizationId}/identity-providers/test-connection

Authorization

AuthorizationBearer <token>

API Key access

In: header

Path Parameters

organizationId*string

Organization ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

issuerUrl*string

OIDC Issuer URL to test

Response Body

`application/json`

curl -X POST "https://example.com/organizations/string/identity-providers/test-connection" \  -H "Content-Type: application/json" \  -d '{    "issuerUrl": "https://company.okta.com"  }'

{  "success": true,  "issuer": "https://company.okta.com",  "error": "string"}

Organizations

200application/json

200application/json

200application/json

200

200application/json

201application/json

204

200application/json

204

200application/json

200application/json

204

204

204

204

204

200application/json

200application/json

204

204

204

204

204

200

200application/json

201application/json

204

200application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`