API ReferenceEnvironments

Update Azure environment

Updates metadata/credentials. Infrastructure settings cannot be freely changed. An errored environment may attempt reprovisioning and include jobId.

Requires every scope: environments:write.

Authentication

AuthorizationBearer

JWT returned by POST /api/auth/token-exchange. Amazon and authorization invitations require API-key-derived tokens.

Path parameters

idintegerRequired

Storage/server/environment resource ID as applicable.

Request

This endpoint expects an object.
environmentNamestringOptional>=3 characters
azureClientSecretstringOptional>=1 character

Response

Success
messagestring
environmentobject

Provider-neutral environment projection. Provider configuration and additional fields depend on the deployment provider.

jobIdintegerOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error
503
Service Unavailable Error