Skip to main content
Create an environment pinned to a build or following repository source

Authorizations

Authorization
string
header
required

Opaque control credential

Headers

Idempotency-Key
string
required
Required string length: 8 - 128
Pattern: ^[A-Za-z0-9._:-]+$

Path Parameters

projectId
string
required
Pattern: ^prj_[0-9a-z]{12,32}$

Body

application/json
name
string
required
Required string length: 1 - 100
Pattern: ^[^\r\n\t]+$
activeBuildHash
string
Pattern: ^sha256:[0-9a-f]{64}$
follow
object

Response

Existing idempotent environment

schemaVersion
enum<number>
required
Available options:
1
organizationId
string
required
Pattern: ^org_[0-9a-z]{12,32}$
projectId
string
required
Pattern: ^prj_[0-9a-z]{12,32}$
environmentId
string
required
Pattern: ^env_[0-9a-z]{12,32}$
name
string
required
Required string length: 1 - 100
Pattern: ^[^\r\n\t]+$
state
enum<string>
required
Available options:
active,
archived
version
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
createdAtMs
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
updatedAtMs
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
activeBuildHash
string
Pattern: ^sha256:[0-9a-f]{64}$
follow
object
archivedAtMs
integer
Required range: -9007199254740991 <= x <= 9007199254740991