Skip to main content
PATCH
Update environment details

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationName
string
required

The unique identifier of the organization containing the environment Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_ -]+$
environmentName
string
required

The unique name of the environment to update Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_ -]+$

Body

application/json

Partial environment data to update

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

name
string

The unique name of the environment within its organization

Pattern: ^[a-zA-Z0-9_ -]+$
readme
string

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

createdAt
string<date-time>

ISO 8601 timestamp indicating when the environment was created

updatedAt
string<date-time>

ISO 8601 timestamp indicating when the environment was last modified

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.

Required range: 1 <= x <= 10

Response

Environment updated successfully

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

name
string

The unique name of the environment within its organization

Pattern: ^[a-zA-Z0-9_ -]+$
readme
string

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

createdAt
string<date-time>

ISO 8601 timestamp indicating when the environment was created

updatedAt
string<date-time>

ISO 8601 timestamp indicating when the environment was last modified

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.

Required range: 1 <= x <= 10