Environments API

An environment is one named place a project's software runs, from a developer's machine to production: its kind, the component it runs (or the whole project), its addresses, the branch deployed there, the auto_deploy and protected flags, the health the last check found, the version running there and whether a change freeze is in force. Deployments will land here and releases will promote through the kinds in order; a protected environment will need a promotion approval, and a frozen one refuses deployments until the freeze lifts.

The reads here see the environments of the projects the token may see. A client guest's token reads only the UAT and production environments, without the admin address, the branch, the hosting note, the region, the check's address and streak, and the notes, which are left out of the payload rather than nulled. An environment outside that set is a 404 RESOURCE_NOT_FOUND, never a 403. Every write runs the same action the Environments page runs, under the project permissions, and announces itself as an environment.* event. No endpoint here carries a secret: the addresses are what a browser or a pipeline opens.

EndpointsCopy Anchor Link

Related

Projects APIThe project an environment belongs to.Components APIThe application an environment runs.Activity APIWhat changed on an environment and who did it.environment.* eventsThe lifecycle and the state of a project's environments: creation, edits, deletion, change freezes and the health the checks find.