Справочник API публикуется на английском языке.
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.
Авторизация
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. Как работают ключи.
Параметры пути
environmentIdstringОбязательныйThe environment's id.
Параметры запроса
companyIdstringНеобязательный
Тело запроса
application/json · обязательно
templateIdstring (uuid) | nullНеобязательный
ttlSecondsintegerНеобязательный
≥ 60≤ 86400Ответы
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).
Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.