Update environment details

Partially updates a environment's details. Only the provided fields will be updated. This operation allows for selective updates without requiring all environment fields.

PATCH/organizations/{organizationName}/environments/{environmentName}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

organizationName*string

The unique identifier of the organization containing the environment

Match^[a-zA-Z0-9_ -]+$

environmentName*string

The unique name of the environment to update

Match^[a-zA-Z0-9_ -]+$

Request Body

application/json

Partial environment data to update

Represents a environment entity that serves as a container for packages and related resources

name?IdentifierPattern

The unique name of the environment within its organization

Match^[a-zA-Z0-9_ -]+$

readme?string

Markdown-formatted documentation describing the environment's purpose and contents

createdAt?string

ISO 8601 timestamp indicating when the environment was created

Formatdate-time

updatedAt?string

ISO 8601 timestamp indicating when the environment was last modified

Formatdate-time

replicationCount?integer

Number of replicas for high availability and performance. When sent on create, this value is stored as-is (within min/max). When omitted on create, Credible manages it for you. When omitted on update, the existing value is left unchanged.

Range1 <= value <= 10

Response Body

`application/json`

curl --request PATCH \  --url 'https://example.com/organizations/string/environments/string' \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{}'

{  "name": "string",  "readme": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "replicationCount": 1}

Update environment details

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`