List managed sandbox deployments

GET

/v1/sandbox-deployments

GET

/v1/sandbox-deployments

curl https://api.runtype.com/v1/sandbox-deployments \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json"

{
  "data": [
    {
      "activeOperationId": "op_01HX9K2MNPQR3ST4UV5WX6YZ7A",
      "activeProviderInstanceId": "pi_01HX9K2MNPQR3ST4UV5WX6YZ7B",
      "counters": {
        "desiredRevision": 3,
        "observedRevision": 3,
        "providerGeneration": 2,
        "resourceVersion": 7,
        "runtimeEpoch": 1
      },
      "createdAt": "2024-03-15T10:00:00Z",
      "createdByUserId": "user_01HX9K2MNPQR3ST4UV5WX6YZ7C",
      "deploymentId": "dep_01HX9K2MNPQR3ST4UV5WX6YZ7D",
      "desiredState": "active",
      "displayName": "my-python-sandbox",
      "effectivePolicy": {
        "access": "bearer",
        "availability": "on-demand",
        "restartPolicy": "process",
        "retention": "1h",
        "sleepPolicy": {
          "mode": "never"
        },
        "networkAccess": "essentials"
      },
      "environment": "development",
      "expiresAt": "2024-03-15T11:00:00Z",
      "ingressEnabled": true,
      "organizationId": "org_01HX9K2MNPQR3ST4UV5WX6YZ7E",
      "profile": {
        "accountTier": "pro",
        "environment": "development",
        "profileId": "profile_python310_standard",
        "providerId": "provider_gcp_us_central1",
        "runtimeClass": "python3.10",
        "sdkVersion": "1.4.2"
      },
      "retentionAnchorAt": "2024-03-15T10:00:00Z",
      "specHash": "sha256:a3f1c2d4e5b6789012345678abcdef01234567890abcdef01234567890abcdef0",
      "status": "running",
      "statusReason": "string",
      "updatedAt": "2024-03-15T10:05:32Z",
      "url": "https://dep-01hx9k2mnpqr3st4uv5wx6yz7d.sandbox.runtype.com"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 20,
    "nextCursor": "cursor_01HX9K2MNPQR3ST4UV5WX6YZ7F"
  }
}

Authentication

AuthorizationBearer

API key or Clerk session token

Query parameters

limitstringOptional

cursorstringOptional

Response

Deployments owned by the caller organization

datalist of objects

paginationobject

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

412

Precondition Failed Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error