La référence de l'API est publiée en anglais.
Create an environment
POST
/api/companies/{companyId}/environmentsPersonal API keyAgent API keyConsole session
Create an environment.
Autorisation
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. Fonctionnement des clés.
Paramètres de chemin
companyIdstringObligatoireThe organization's id.
Corps de la requête
application/json · obligatoire
namestringObligatoire
at least 1 characterdescriptionstring | nullFacultatif
driverstringObligatoire
one of: "local", "ssh", "sandbox", "plugin"statusstringFacultatif
one of: "active", "archived"configobjectFacultatif
envVarsobject<string, string | object>Facultatif
metadataobject | nullFacultatif
Réponses
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.
Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.