API referansı İngilizce yayımlanır.

Start an interactive environment customImage setup session

POST/api/environments/{environmentId}/custom-image-setup-sessions
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

Start an interactive environment customImage setup session.

Yetkilendirme

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. Anahtarlar nasıl çalışır.

Yol parametreleri

environmentIdstringZorunluThe environment's id.

Sorgu parametreleri

companyIdstringİsteğe bağlı

İstek gövdesi

application/json · zorunlu

templateIdstring (uuid) | nullİsteğe bağlı
ttlSecondsintegerİsteğe bağlı≥ 60≤ 86400

Yanıtlar

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).

Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.

Environments