Get supported configuration and runtime capabilities
Requires authentication. Read capabilities from this environment; workerOnline reports recent worker readiness. Listed service types are not a guarantee of available capacity. Prices are estimates.
Kept in memory for this page. Requests go through this documentation site to the live Openstead API and can change your workspace. Use a read-only key to explore read operations.
Requires authentication. Read capabilities from this environment; workerOnline reports recent worker readiness. Listed service types are not a guarantee of available capacity. Prices are estimates.
Workspace-scoped rnv_ API key. Read scope allows GET; write scope is additionally constrained by current membership, role, email verification, expiry and workspace MFA policy.
In: header
Header Parameters
Optional correlation identifier; invalid values are replaced. The accepted/generated value is returned in X-Request-ID and error body requestId. This is not an idempotency key.
^[A-Za-z0-9][A-Za-z0-9._-]*$length <= 64Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.openstead.tech/api/v1/catalog" \ -H "Authorization: Bearer <OPENSTEAD_API_KEY>"{ "capabilities": { "property1": true, "property2": true }, "databasePlans": [ { "backupRetentionDays": 0, "buildMinutes": 0, "cpu": 0, "id": "string", "kinds": [ "string" ], "logDays": 0, "maxConnections": 0, "memoryMb": 0, "name": "string", "ngn": 0, "storageGb": 0, "transferGb": 0, "usd": 0, "workspaceLimit": 0 } ], "defaults": { "autoDeploy": "off", "backupEnabled": true, "backupRetentionDays": 7, "branch": "main", "buildCommand": "", "buildMethod": "railpack", "cacheProfile": "none", "databaseName": "", "databaseUser": "", "databaseVersion": "16", "description": "", "dockerContext": ".", "dockerfilePath": "Dockerfile", "evictionPolicy": "allkeys-lru", "healthCheckPath": "", "ignorePaths": [], "image": "", "includePaths": [], "ipAllowList": [], "maintenance": false, "maintenancePage": "", "maxConcurrency": 1, "maxReplicas": 3, "maxRetries": 3, "minReplicas": 1, "notifications": "workspace", "plan": "free", "platformDomainEnabled": true, "port": 8000, "preDeployCommand": "", "previewExpiryHours": 72, "previewMode": "off", "privateNetworking": true, "publishDirectory": "dist", "region": "auto", "registryId": "", "replicas": 1, "repository": "", "rootDirectory": "", "runtime": "auto", "scaling": "manual", "schedule": "0 * * * *", "sourceType": "repository", "startCommand": "", "targetCpu": 70, "targetMemory": 80, "timeoutSeconds": 3600, "timezone": "UTC" }, "plans": [ { "backupRetentionDays": 0, "buildMinutes": 0, "cpu": 0, "id": "string", "kinds": [ "string" ], "logDays": 0, "maxConnections": 0, "memoryMb": 0, "name": "string", "ngn": 0, "storageGb": 0, "transferGb": 0, "usd": 0, "workspaceLimit": 0 } ], "pricesAreEstimates": true, "regions": [ { "description": "string", "id": "string", "name": "string" } ], "runtimes": [ "string" ], "serviceTypes": [ { "description": "string", "id": "string", "name": "string", "plural": "string", "runtime": true } ]}