# deploy-api ## Pages - [Deploy API](https://docs.ezghcloud.com/deploy-api/index.md) — Stacks, environments, deployments and their plans, changesets and managed resources. Every path is under an organization; lists are paged with limit, cursor and nextCursor. Routes answer 404 until they are built. - [Approve a deployment's plan](https://docs.ezghcloud.com/deploy-api/ApproveDeployment/index.md) - [Attach an existing resource to a key](https://docs.ezghcloud.com/deploy-api/AttachResource/index.md) - [Cancel a deployment](https://docs.ezghcloud.com/deploy-api/CancelDeployment/index.md) - [Start a changeset](https://docs.ezghcloud.com/deploy-api/CreateChangeset/index.md) - [Deploy an environment's branch](https://docs.ezghcloud.com/deploy-api/CreateDeployment/index.md) - [Register an environment](https://docs.ezghcloud.com/deploy-api/CreateEnvironment/index.md) - [Register a repository as a stack](https://docs.ezghcloud.com/deploy-api/CreateStack/index.md) - [Delete an environment and tear down what it deployed](https://docs.ezghcloud.com/deploy-api/DeleteEnvironment/index.md) - [Delete a managed resource](https://docs.ezghcloud.com/deploy-api/DeleteResource/index.md) - [Delete a stack](https://docs.ezghcloud.com/deploy-api/DeleteStack/index.md) - [Discard a changeset](https://docs.ezghcloud.com/deploy-api/DiscardChangeset/index.md) - [Stop managing a resource, leaving it in place](https://docs.ezghcloud.com/deploy-api/ForgetResource/index.md) - [Get a changeset](https://docs.ezghcloud.com/deploy-api/GetChangeset/index.md) - [Get a deployment](https://docs.ezghcloud.com/deploy-api/GetDeployment/index.md) - [Get an environment's desired state, as its file says](https://docs.ezghcloud.com/deploy-api/GetDesiredState/index.md) - [Get an environment](https://docs.ezghcloud.com/deploy-api/GetEnvironment/index.md) - [Get a stack's canvas layout](https://docs.ezghcloud.com/deploy-api/GetLayout/index.md) - [Get a deployment's operation (poll it until it finishes)](https://docs.ezghcloud.com/deploy-api/GetOperation/index.md) — Readable with deploy.deployments.get on the deployment's stack. Retry-After suggests when to poll again while it's queued or running. Deploy operations are never cancellable here: cancel the deployment instead. Not recorded in Trails. - [Get a deployment's plan](https://docs.ezghcloud.com/deploy-api/GetPlan/index.md) - [Get a policy document an environment needs](https://docs.ezghcloud.com/deploy-api/GetPolicyTemplate/index.md) - [Get a stack](https://docs.ezghcloud.com/deploy-api/GetStack/index.md) - [List an environment's changesets](https://docs.ezghcloud.com/deploy-api/ListChangesets/index.md) - [List an environment's deployments, newest first](https://docs.ezghcloud.com/deploy-api/ListDeployments/index.md) - [List a stack's environments](https://docs.ezghcloud.com/deploy-api/ListEnvironments/index.md) - [List the GitHub App's installations](https://docs.ezghcloud.com/deploy-api/ListGitHubInstallations/index.md) - [List an installation's repositories](https://docs.ezghcloud.com/deploy-api/ListGitHubRepositories/index.md) - [List operations, newest first](https://docs.ezghcloud.com/deploy-api/ListOperations/index.md) — Only operations of deployments in stacks the caller holds deploy.deployments.list on; a page may be shorter than limit. Filters: status, targetResourceName. - [List an environment's managed resources](https://docs.ezghcloud.com/deploy-api/ListResources/index.md) - [List stacks](https://docs.ezghcloud.com/deploy-api/ListStacks/index.md) - [Look up the stack that manages a resource](https://docs.ezghcloud.com/deploy-api/LookupManagedResource/index.md) - [Pause an environment](https://docs.ezghcloud.com/deploy-api/PauseEnvironment/index.md) - [Reject a deployment's plan](https://docs.ezghcloud.com/deploy-api/RejectDeployment/index.md) - [Resume an environment](https://docs.ezghcloud.com/deploy-api/ResumeEnvironment/index.md) - [Roll an environment back to an earlier deployment](https://docs.ezghcloud.com/deploy-api/RollbackEnvironment/index.md) - [Start installing the GitHub App](https://docs.ezghcloud.com/deploy-api/StartGitHubInstall/index.md) - [Submit a changeset as a commit or a pull request](https://docs.ezghcloud.com/deploy-api/SubmitChangeset/index.md) - [Edit a changeset](https://docs.ezghcloud.com/deploy-api/UpdateChangeset/index.md) - [Change an environment](https://docs.ezghcloud.com/deploy-api/UpdateEnvironment/index.md) - [Replace a stack's canvas layout](https://docs.ezghcloud.com/deploy-api/UpdateLayout/index.md) - [Change a stack](https://docs.ezghcloud.com/deploy-api/UpdateStack/index.md) - [Check an EZGHDeploy file](https://docs.ezghcloud.com/deploy-api/ValidateFile/index.md) - [AuthorizationRequired](https://docs.ezghcloud.com/deploy-api/schemas/AuthorizationRequired/index.md) — 409: Deploy writes to GitHub as the person (never as the App), and needs their GitHub authorization first. - [Changeset](https://docs.ezghcloud.com/deploy-api/schemas/Changeset/index.md) - [ChangesetEdit](https://docs.ezghcloud.com/deploy-api/schemas/ChangesetEdit/index.md) - [ChangesetStatus](https://docs.ezghcloud.com/deploy-api/schemas/ChangesetStatus/index.md) — Clients treat a state they don't know as unknown. - [ChangesetSummary](https://docs.ezghcloud.com/deploy-api/schemas/ChangesetSummary/index.md) - [Deployment](https://docs.ezghcloud.com/deploy-api/schemas/Deployment/index.md) - [DeploymentStatus](https://docs.ezghcloud.com/deploy-api/schemas/DeploymentStatus/index.md) — Clients treat a state they don't know as unknown. - [DesiredEdge](https://docs.ezghcloud.com/deploy-api/schemas/DesiredEdge/index.md) - [DesiredState](https://docs.ezghcloud.com/deploy-api/schemas/DesiredState/index.md) - [Environment](https://docs.ezghcloud.com/deploy-api/schemas/Environment/index.md) - [EnvironmentStatus](https://docs.ezghcloud.com/deploy-api/schemas/EnvironmentStatus/index.md) — Clients treat a state they don't know as unknown. - [Error](https://docs.ezghcloud.com/deploy-api/schemas/Error/index.md) — Every non-2xx answer. Clients branch on code, never on message. - [ErrorOrNull](https://docs.ezghcloud.com/deploy-api/schemas/ErrorOrNull/index.md) - [FileProblem](https://docs.ezghcloud.com/deploy-api/schemas/FileProblem/index.md) - [GitHubInstallationStatus](https://docs.ezghcloud.com/deploy-api/schemas/GitHubInstallationStatus/index.md) — Clients treat a state they don't know as unknown. - [LeftBehind](https://docs.ezghcloud.com/deploy-api/schemas/LeftBehind/index.md) - [ManagedResourceStatus](https://docs.ezghcloud.com/deploy-api/schemas/ManagedResourceStatus/index.md) — Clients treat a state they don't know as unknown. - [NamedRef](https://docs.ezghcloud.com/deploy-api/schemas/NamedRef/index.md) — A stack (dps_…) or environment (den_…) by ID and name. - [Operation](https://docs.ezghcloud.com/deploy-api/schemas/Operation/index.md) — The operation a long-running request answers with (202, Location). - [Plan](https://docs.ezghcloud.com/deploy-api/schemas/Plan/index.md) - [PlanChange](https://docs.ezghcloud.com/deploy-api/schemas/PlanChange/index.md) - [PlanStatus](https://docs.ezghcloud.com/deploy-api/schemas/PlanStatus/index.md) — Clients treat a state they don't know as unknown. - [PlanSummary](https://docs.ezghcloud.com/deploy-api/schemas/PlanSummary/index.md) - [PolicyDocument](https://docs.ezghcloud.com/deploy-api/schemas/PolicyDocument/index.md) - [PullRequest](https://docs.ezghcloud.com/deploy-api/schemas/PullRequest/index.md) - [PullRequestOrNull](https://docs.ezghcloud.com/deploy-api/schemas/PullRequestOrNull/index.md) - [QuotaExceeded](https://docs.ezghcloud.com/deploy-api/schemas/QuotaExceeded/index.md) — quota_exceeded: the quota that refused the request. Never with Retry-After. - [ReleaseRunStatus](https://docs.ezghcloud.com/deploy-api/schemas/ReleaseRunStatus/index.md) — Clients treat a state they don't know as unknown. - [Resource](https://docs.ezghcloud.com/deploy-api/schemas/Resource/index.md) - [Rollout](https://docs.ezghcloud.com/deploy-api/schemas/Rollout/index.md) - [RolloutStatus](https://docs.ezghcloud.com/deploy-api/schemas/RolloutStatus/index.md) — Clients treat a state they don't know as unknown. - [SandboxImage](https://docs.ezghcloud.com/deploy-api/schemas/SandboxImage/index.md) - [Source](https://docs.ezghcloud.com/deploy-api/schemas/Source/index.md) - [Stack](https://docs.ezghcloud.com/deploy-api/schemas/Stack/index.md) - [StackStatus](https://docs.ezghcloud.com/deploy-api/schemas/StackStatus/index.md) — Clients treat a state they don't know as unknown. - [StateError](https://docs.ezghcloud.com/deploy-api/schemas/StateError/index.md) — A step's, rollout's, deployment's or changeset's error. - [Step](https://docs.ezghcloud.com/deploy-api/schemas/Step/index.md) - [StepStatus](https://docs.ezghcloud.com/deploy-api/schemas/StepStatus/index.md) — Clients treat a state they don't know as unknown.