API referansı İngilizce yayımlanır.
Create an environment
POST
/api/companies/{companyId}/environmentsPersonal API keyAgent API keyConsole session
Create an environment.
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
companyIdstringZorunluThe organization's id.
İstek gövdesi
application/json · zorunlu
namestringZorunlu
at least 1 characterdescriptionstring | nullİsteğe bağlı
driverstringZorunlu
one of: "local", "ssh", "sandbox", "plugin"statusstringİsteğe bağlı
one of: "active", "archived"configobjectİsteğe bağlı
envVarsobject<string, string | object>İsteğe bağlı
metadataobject | nullİsteğe bağlı
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.
Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.