Start an interactive environment customImage setup session
POST
/api/environments/{environmentId}/custom-image-setup-sessionsPersonal API keyAgent API keyConsole session
Start an interactive environment customImage setup session.
Authorization
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. How keys work.
Path parameters
environmentIdstringRequiredThe environment's id.
Query parameters
companyIdstringOptional
Request body
application/json · required
templateIdstring (uuid) | nullOptional
ttlSecondsintegerOptional
≥ 60≤ 86400Responses
201SuccessCreated; the body holds the new resource.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).
Errors return {"error": "..."}, often with a code and details. See errors and limits.