Sandbox envs
Create a new SandboxEnv shell. Members are added through `POST /envs/{name}/sandboxpools`; the matching autoscaling group is created automatically per member and tuned through `PUT /envs/{name}/autoscaling/groups/{groupName}`.
Authorization
ApiKeyAuth AGENTBOX-API-KEY<token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://envs" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "templateRef": { "name": "string" } }'{ "env": { "name": "string", "namespace": "string", "labels": { "property1": "string", "property2": "string" }, "spec": { "templateRef": { "name": "string", "version": "string" }, "mode": "WarmPool", "defaults": { "instanceType": "string", "multiplier": 1 }, "clusters": [ { "clusterID": "string", "members": [ { "name": "string", "config": { "labels": { "property1": "string", "property2": "string" }, "annotations": { "property1": "string", "property2": "string" }, "instanceType": "string", "multiplier": 0, "inlineResources": { "requests": { "property1": "string", "property2": "string" }, "limits": { "property1": "string", "property2": "string" } }, "scalingGroup": "string", "minReplicas": 0, "maxReplicas": 0, "priority": 0, "scaleUpPriority": 0, "scaleDownPriority": 0 } } ] } ], "autoscaling": { "groups": [ { "name": "string", "enabled": true, "minReplicas": 0, "maxReplicas": 0, "scaleUpPolicy": { "mode": "Conservative", "cooldownSeconds": 0, "idleThresholdSeconds": 0, "idleZeroQuietWindowSeconds": 0, "saturationCooldownSeconds": 0 }, "scaleDownPolicy": { "idleTimeoutSeconds": 0, "stabilizationSeconds": 0, "protectionWindowSeconds": 0 } } ] }, "overrides": { "image": "string", "podCreationImagePolicy": "PoolDefaultImage", "defaultStartupTimeout": "string", "defaultIdleTimeout": "string", "imagePullSecret": { "registries": [ { "registry": "string", "username": "string", "password": "pa$$word" } ] }, "imagePullSecretConfigured": true } }, "status": { "conditions": [ { "type": "string", "status": "string", "reason": "string", "message": "string", "lastTransitionTime": "2019-08-24T14:15:22Z" } ], "clusters": [ { "clusterID": "string", "isLocal": true, "observedMembers": [ { "name": "string", "instanceType": "string", "multiplier": 0, "state": "Active", "idleCount": 0, "runningCount": 0, "desiredReplicas": 0, "currentReplicas": 0, "pendingRequests": 0, "saturatedUntil": "2019-08-24T14:15:22Z" } ], "lastSnapshotTime": "2019-08-24T14:15:22Z" } ], "scalingGroups": [ { "name": "string", "totalIdle": 0, "totalRunning": 0, "totalDesired": 0 } ], "memberCount": 0, "desiredReplicas": 0, "runningReplicas": 0, "idleReplicas": 0 }, "team": "string", "user": "string", "createdAt": "2019-08-24T14:15:22Z", "envDocs": "string" }}{ "error": "string", "errorCode": "API_KEY_REQUIRED", "detail": null}{ "error": "string", "errorCode": "API_KEY_REQUIRED", "detail": null}{ "error": "string", "errorCode": "API_KEY_REQUIRED", "detail": null}{ "error": "string", "errorCode": "API_KEY_REQUIRED", "detail": null}