Get a managed sandbox deployment | Runtype Documentation

{
  "activeOperationId": "op_01HQ8K2MNPXVZ3R7JTFW5YCBD4",
  "activeProviderInstanceId": "prov_inst_01HQ8K2MNPXVZ3R7JTFW5YCBD4",
  "counters": {
    "desiredRevision": 3,
    "observedRevision": 3,
    "providerGeneration": 2,
    "resourceVersion": 7,
    "runtimeEpoch": 1
  },
  "createdAt": "2024-03-15T10:22:00Z",
  "createdByUserId": "user_01HQ8K2MNPXVZ3R7JTFW5YCBD4",
  "deploymentId": "dep_01HQ8K2MNPXVZ3R7JTFW5YCBD4",
  "desiredState": "active",
  "displayName": "my-api-sandbox",
  "effectivePolicy": {
    "access": "bearer",
    "availability": "on-demand",
    "restartPolicy": "process",
    "retention": "1h",
    "sleepPolicy": {
      "mode": "never"
    },
    "networkAccess": "essentials"
  },
  "environment": "development",
  "expiresAt": "2024-03-15T11:22:00Z",
  "ingressEnabled": true,
  "organizationId": "org_01HQ8K2MNPXVZ3R7JTFW5YCBD4",
  "profile": {
    "accountTier": "pro",
    "environment": "development",
    "profileId": "profile_node20_standard",
    "providerId": "provider_aws_us_east_1",
    "runtimeClass": "node20",
    "sdkVersion": "1.4.2"
  },
  "retentionAnchorAt": "2024-03-15T10:22:00Z",
  "specHash": "sha256:a3f8c2d1e4b7f9a0c5d2e8f1b4a7c0d3e6f9b2a5c8d1e4f7a0b3c6d9e2f5a8b1",
  "status": "running",
  "statusReason": null,
  "updatedAt": "2024-03-15T10:23:15Z",
  "url": "https://dep-01hq8k2mnpxvz3r7jtfw5ycbd4.sandbox.runtype.com"
}

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired>=1 character

Response

Deployment

activeOperationIdstring or null

activeProviderInstanceIdstring or null

countersobject

createdAtstring

createdByUserIdstring or null

deploymentIdstring

desiredStateenum

Allowed values:

displayNamestring or null

effectivePolicyobject

environmentenum

Allowed values:

expiresAtstring or null

ingressEnabledboolean

organizationIdstring

profileobject

retentionAnchorAtstring

specHashstring

statusenum

statusReasonstring or null

updatedAtstring

urlstring or null

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