a13nDocs
API referenceEnvironments

Create Environment

Reserve a managed sandbox from a template (`creating`), or register an external envd target (`ready`).

POST/api/v1/environments

Reserve a managed sandbox from a template (creating), or register an external envd target (ready).

Authorization

AuthorizationBearer <token>

A workspace API key (a13n_...)

In: header

Header Parameters

X-Workspace-ID?|

The workspace ID a login session acts in; required with a login session. An API key acts in its own workspace and needs none; naming another is forbidden.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

A workspace-managed sandbox reserved from a template, for threads to mount; maintenance creates it.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/environments" \  -H "Content-Type: application/json" \  -d '{    "template_id": "string"  }'
{  "created_at": "2019-08-24T14:15:22Z",  "created_by_id": "string",  "device_id": "string",  "endpoint": "string",  "failure": {    "at": "2019-08-24T14:15:22Z",    "certainty": "not_dispatched",    "code": "string",    "message": "string",    "operation_id": "string",    "permanent": true  },  "id": "string",  "last_used_at": "2019-08-24T14:15:22Z",  "name": "string",  "operation_id": "string",  "operation_started_at": "2019-08-24T14:15:22Z",  "organization_id": "string",  "owner_principal_id": "string",  "provider_id": "string",  "status": "string",  "template_id": "string",  "updated_at": "2019-08-24T14:15:22Z",  "version": 0,  "workspace_id": "string"}