Change an environment
Changes only the fields sent.
Requires the catalog:source:write scope.
Authorization
Parameters
Path parameters
idstring requiredThe environment's ID.
Request body required
namestringkindstringdescriptionstring
Responses
200
The environment.
dataEnvironmentShow Environment properties
idstringorg_idstringnamestringkindstringdescriptionstringcreated_bystringcreated_atstring (date-time)updated_atstring (date-time)
400
The request is not valid: a field or filter value is wrong
(VALIDATION_ERROR, with a sentence saying what), the body is not
the expected JSON or carries an unknown field (INVALID_BODY), the
cursor is not one this list gave (INVALID_CURSOR), a binding names
a service that does not exist (UNKNOWN_COMPONENT), or a PATCH
tries to change a slug (SLUG_IMMUTABLE).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
401
No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
403
The key lacks a scope this endpoint needs (FORBIDDEN).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
404
Nothing with this ID (or slug) exists in the organization (NOT_FOUND).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
409
Another one already has this name (NAME_TAKEN).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
429
Too many requests (RATE_LIMITED). Wait for Retry-After seconds.
Retry-AfterintegerSeconds to wait before retrying.
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
500
Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
Example request
curl -X PATCH 'https://evohub.io/api/v1/catalog/environments/env_2c4e6a8b0d1f3a5c7e9b1d3f5a7c9e0b' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"description": "Production cluster in Frankfurt, since October"
}'
