ResolvedEnvironment
The environment this step deploys to, and the rules that applied to it when the run was triggered. Changing the environment afterwards does not change a run already in flight.
Shape
- environment_idEnvironmentId (string · uuid)
- full_pathstringThe environment's unique name: the full path of the group or repository that owns it,
:, then its slug (e.g.acme/platform:production). Two groups may each have aproductionenvironment; this tells them apart. - slugEnvironmentSlug (string)
- tierEnvironmentTierdevelopmenttestingstagingproductionWhat kind of environment this is, whatever it is called:
development,testing,stagingorproduction. Aproductionenvironment is protected by default. - accept_fromAcceptFrompeople_signed_inpeoplepeople_and_service_accountspeople_and_agentsoptionalWhich kinds of approval count toward a rule.
- concurrency_keyConcurrencyKey (string) or nulloptionalThe lock deploys to this environment take, so that only one runs at a time. Absent when the environment allows deploys to run at the same time.
- concurrency_modeConcurrencyModequeueskipcancel_previousoptionalWhat happens when another run holds the lock:
queuewaits for it,skipskips this step,cancel_previouscancels the other run. - max_lock_wait_secondsinteger · int32optional0–∞How long a queued step waits for the lock before failing, in seconds.
0means it waits for as long as the pipeline's timeout allows. - prevent_self_approvalbooleanoptional
- requiredinteger · int32optional0–∞
- requires_approvalbooleanoptional
variablesarray of ResolvedEnvironmentVariableoptionalThe environment's variables, in name order. A secret appears here by name only — its value is never included.
- The ResolvedEnvironmentVariable schema
- nameEnvironmentVariableName (string)
- valueEnvironmentVariableValue (string) or nulloptional
- wait_timer_secondsinteger · int32optional0–∞
Example
Synthesized example{
"environment_id": "3f902489-f2cb-43ee-972c-d83510ff3ce5",
"full_path": "acme/payments-api",
"slug": "slug-1132",
"tier": "development",
"accept_from": "people_signed_in",
"approvers": [
{
"anyone": {}
}
],
"concurrency_key": "concurrency-key-a12e",
"concurrency_mode": "queue",
"max_lock_wait_seconds": 39,
"prevent_self_approval": false,
"required": 46,
"requires_approval": false,
"variables": [
{
"name": "payments-api"
}
],
"wait_timer_seconds": 60
}
Graph
Used inside
Used by
Sent by 0 operations
No operation takes it as a request body.
Returned by 0 operations
No operation returns it directly.