# env zero docs: API reference

## API reference

### Users

- [List User's VCS ID Mappings](https://docs.envzero.com/api-reference/users/list-users-vcs-id-mappings.md): Returns the user's account ids for all mapped vcs-es.
- [Create VCS Provider User Mapping](https://docs.envzero.com/api-reference/users/create-vcs-provider-user-mapping.md)
- [Update a User's VCS ID Mapping](https://docs.envzero.com/api-reference/users/update-a-users-vcs-id-mapping.md): Updates a user's VCS ID mapping, and returns the updated value.
- [Get the User's Preferences](https://docs.envzero.com/api-reference/users/get-the-users-preferences.md): Returns the user's UI preferences. `design` is always populated - it falls back to the product default when the user has never chosen.
- [Update the User's Preferences](https://docs.envzero.com/api-reference/users/update-the-users-preferences.md): Updates the user's UI preferences and returns them. Fields left out are unchanged.
- [Get SCIM Configuration](https://docs.envzero.com/api-reference/users/get-scim-configuration.md): Returns the SCIM configuration for the organization (without the bearer token).
- [Create SCIM Configuration](https://docs.envzero.com/api-reference/users/create-scim-configuration.md): Creates a SCIM configuration for the organization and generates a bearer token. The token is only returned once.
- [Delete SCIM Configuration](https://docs.envzero.com/api-reference/users/delete-scim-configuration.md): Deletes the SCIM configuration for the organization.
- [Rotate SCIM Token](https://docs.envzero.com/api-reference/users/rotate-scim-token.md): Issues a new SCIM bearer token. The previous token stays valid for a grace window (default 24h), then is revoked. The new token is only returned once.
- [Get SCIM Group Mappings](https://docs.envzero.com/api-reference/users/get-scim-group-mappings.md): Returns the auto-discovered SCIM group to env zero team mappings for the organization.
- [Update SCIM Mode](https://docs.envzero.com/api-reference/users/update-scim-mode.md): Flips the organization SCIM provisioning mode between jit and scim.
- [Get JIT SAML Config](https://docs.envzero.com/api-reference/users/get-jit-saml-config.md): Returns the organization current JIT SAML provisioning config (admin SAML group + teams filter) for the mode-flip pre-flight display.
- [Unlink SCIM Group Mapping](https://docs.envzero.com/api-reference/users/unlink-scim-group-mapping.md): Removes a single SCIM group to env zero team mapping. The env zero team itself is preserved.
- [Reconcile SCIM State](https://docs.envzero.com/api-reference/users/reconcile-scim-state.md): Compares env zero org state against the SCIM-managed projection and returns a diff. dryRun=true (default) reports only; dryRun=false with confirm=true backfills SCIM ownership on org members and unlinks stale group mappings.
- [Get SCIM Reconcile Job](https://docs.envzero.com/api-reference/users/get-scim-reconcile-job.md): Returns the latest SCIM reconcile apply job for the organization, including backfill progress and terminal state.

### Agents Settings

- [List agents](https://docs.envzero.com/api-reference/agents-settings/list-agents.md): Get a list of the organization agents
- [Create agent](https://docs.envzero.com/api-reference/agents-settings/create-agent.md): Create a new self-hosted agent
- [Get agent](https://docs.envzero.com/api-reference/agents-settings/get-agent.md): Get agent details by key
- [Delete agent](https://docs.envzero.com/api-reference/agents-settings/delete-agent.md): Delete an agent (soft delete)
- [Update agent](https://docs.envzero.com/api-reference/agents-settings/update-agent.md): Update agent properties
- [Get agent values file content (Deprecated)](https://docs.envzero.com/api-reference/agents-settings/get-agent-values-file-content-deprecated.md): Deprecated. Not supported for agents created via the UI, API, or Terraform provider.
- [Get the agent assignment of a project](https://docs.envzero.com/api-reference/agents-settings/get-the-agent-assignment-of-a-project.md): Returns the assigned agent
- [Get agent .env file content (Deprecated)](https://docs.envzero.com/api-reference/agents-settings/get-agent-env-file-content-deprecated.md): Deprecated. Not supported for agents created via the UI, API, or Terraform provider.
- [Get agent assignments of projects](https://docs.envzero.com/api-reference/agents-settings/get-agent-assignments-of-projects.md): returns the current default agent key and a map of project ids to agent key assignments
- [Assign agents to projects](https://docs.envzero.com/api-reference/agents-settings/assign-agents-to-projects.md): Assign projects to agents, send a request body where each key represents a Project ID and the corresponding value is the Agent Key assigned to that project. Request Body Example: ```json {     "projectId1": "agentKey1",     "projectId2": "agentKey2" } ```
- [Set default agent for organization](https://docs.envzero.com/api-reference/agents-settings/set-default-agent-for-organization.md): sets the default agent for the organization
- [Get agent secrets metadata](https://docs.envzero.com/api-reference/agents-settings/get-agent-secrets-metadata.md): Returns metadata for all secrets associated with an agent (does not return secret values)
- [Create agent secret](https://docs.envzero.com/api-reference/agents-settings/create-agent-secret.md): Creates a new secret for an agent. Returns the plain secret value once.
- [Revoke agent secret](https://docs.envzero.com/api-reference/agents-settings/revoke-agent-secret.md): Delete an agent secret (immediate and irreversible)

### Audit Events

- [Fetch Audit Logs](https://docs.envzero.com/api-reference/audit-events/fetch-audit-logs.md)

### Templates

- [List Templates](https://docs.envzero.com/api-reference/templates/list-templates.md): Returns all Templates associated with either an Organization or Project. At least one of these must be set.
- [Create Template](https://docs.envzero.com/api-reference/templates/create-template.md): Please note, you can only have 1 ssh key per template
- [Get Template by ID](https://docs.envzero.com/api-reference/templates/get-template-by-id.md)
- [Update Template](https://docs.envzero.com/api-reference/templates/update-template.md): Please note, you can only have 1 ssh key per template
- [Delete Template](https://docs.envzero.com/api-reference/templates/delete-template.md)
- [List git repository revisions](https://docs.envzero.com/api-reference/templates/list-git-repository-revisions.md)
- [Get Assignable Templates](https://docs.envzero.com/api-reference/templates/get-assignable-templates.md): Returns a list of templates that can be assigned to the specified project, including those from parent projects and the organization.
- [Add Template to Project](https://docs.envzero.com/api-reference/templates/add-template-to-project.md)
- [Remove Template from Project](https://docs.envzero.com/api-reference/templates/remove-template-from-project.md)
- [Generate Terraform Variables from Repository](https://docs.envzero.com/api-reference/templates/generate-terraform-variables-from-repository.md): Clones and searches through a Template git repository for any Terraform variable blocks and returns a set of env zero Terraform Configuration Variables that may be added to env zero via the Configuration API
- [Download TF module](https://docs.envzero.com/api-reference/templates/download-tf-module.md): Gets the URL of the source code for a Tofu/Terraform module. This is an API used by Tofu/Terraform to download the module when running `tofu init`. The URL could be found in the response header under X-Terraform-Get, and its format is "git::REPOSITORY_URL[//PATH_TO_FOLDER][?ref=GIT_REF]"
- [Get Workflow File](https://docs.envzero.com/api-reference/templates/get-workflow-file.md): Retrieve workflow file representation by blueprintId or VCS parameters (repositoryUrl, organizationId, path, etc.)
- [Get Environment Discovery Configuration for a Project](https://docs.envzero.com/api-reference/templates/get-environment-discovery-configuration-for-a-project.md)
- [Enable/Update Environment Discovery Configuration](https://docs.envzero.com/api-reference/templates/enableupdate-environment-discovery-configuration.md)
- [Delete Environment Discovery Configuration for a Project](https://docs.envzero.com/api-reference/templates/delete-environment-discovery-configuration-for-a-project.md)

### Modules

- [List Modules](https://docs.envzero.com/api-reference/modules/list-modules.md): Returns all modules associated with an organization.
- [Create module](https://docs.envzero.com/api-reference/modules/create-module.md)
- [List Module Versions](https://docs.envzero.com/api-reference/modules/list-module-versions.md): Returns all versions of the module.
- [Get Module README](https://docs.envzero.com/api-reference/modules/get-module-readme.md): Returns the Module README.md file content from a specific version
- [Get module](https://docs.envzero.com/api-reference/modules/get-module.md)
- [Delete module](https://docs.envzero.com/api-reference/modules/delete-module.md)
- [Update module](https://docs.envzero.com/api-reference/modules/update-module.md)
- [List Module Test Runs](https://docs.envzero.com/api-reference/modules/list-module-test-runs.md)
- [Get Module Test Run by ID](https://docs.envzero.com/api-reference/modules/get-module-test-run-by-id.md)
- [Trigger Module Test Run](https://docs.envzero.com/api-reference/modules/trigger-module-test-run.md)

### Custom Flow

- [Assign Custom Flow](https://docs.envzero.com/api-reference/custom-flow/assign-custom-flow.md)
- [Unassign Custom Flow](https://docs.envzero.com/api-reference/custom-flow/unassign-custom-flow.md)
- [Find Custom Flows](https://docs.envzero.com/api-reference/custom-flow/find-custom-flows.md)
- [Update Custom Flow](https://docs.envzero.com/api-reference/custom-flow/update-custom-flow.md)
- [Create Custom Flow](https://docs.envzero.com/api-reference/custom-flow/create-custom-flow.md)
- [Delete Custom Flow](https://docs.envzero.com/api-reference/custom-flow/delete-custom-flow.md)
- [Get Custom Flow Assignments](https://docs.envzero.com/api-reference/custom-flow/get-custom-flow-assignments.md)

### Approval Policy

- [Get Approval Policy By Name](https://docs.envzero.com/api-reference/approval-policy/get-approval-policy-by-name.md)
- [Update Existing Approval Policy](https://docs.envzero.com/api-reference/approval-policy/update-existing-approval-policy.md)
- [Create Approval Policy](https://docs.envzero.com/api-reference/approval-policy/create-approval-policy.md)
- [Get Approval Policy Assignments By Scope](https://docs.envzero.com/api-reference/approval-policy/get-approval-policy-assignments-by-scope.md)
- [Unassign Approval Policy From Scope](https://docs.envzero.com/api-reference/approval-policy/unassign-approval-policy-from-scope.md)
- [Assign Approval Policy To Scope](https://docs.envzero.com/api-reference/approval-policy/assign-approval-policy-to-scope.md)
- [Unassign Approval Policy by assignment id](https://docs.envzero.com/api-reference/approval-policy/unassign-approval-policy-by-assignment-id.md)
- [Delete Approval Policy](https://docs.envzero.com/api-reference/approval-policy/delete-approval-policy.md)
- [Get Policy Catalog](https://docs.envzero.com/api-reference/approval-policy/get-policy-catalog.md): Returns a list of available policy templates for the policy catalog
- [List Approval Policies](https://docs.envzero.com/api-reference/approval-policy/list-approval-policies.md): Returns all approval policies associated with an organization.

### Bulk Operations

- [Bulk deploy](https://docs.envzero.com/api-reference/bulk-operations/bulk-deploy.md)
- [Bulk destroy](https://docs.envzero.com/api-reference/bulk-operations/bulk-destroy.md)
- [Bulk approve](https://docs.envzero.com/api-reference/bulk-operations/bulk-approve.md)
- [Bulk deploy](https://docs.envzero.com/api-reference/bulk-operations/bulk-deploy-1.md)
- [Bulk archive](https://docs.envzero.com/api-reference/bulk-operations/bulk-archive.md)
- [Bulk cancel queued deployments](https://docs.envzero.com/api-reference/bulk-operations/bulk-cancel-queued-deployments.md)
- [Bulk lock](https://docs.envzero.com/api-reference/bulk-operations/bulk-lock.md)
- [Bulk unlock](https://docs.envzero.com/api-reference/bulk-operations/bulk-unlock.md)
- [Bulk run task](https://docs.envzero.com/api-reference/bulk-operations/bulk-run-task.md)
- [Bulk add environment tags](https://docs.envzero.com/api-reference/bulk-operations/bulk-add-environment-tags.md): Applies the same tags to every selected environment - a key that already exists has its values replaced wholesale, and keys that are not listed are left untouched
- [Bulk remove environment tags](https://docs.envzero.com/api-reference/bulk-operations/bulk-remove-environment-tags.md): Removes the listed tag keys, values and all, from every selected environment - a key an environment does not carry is a no-op
- [Get bulk operation](https://docs.envzero.com/api-reference/bulk-operations/get-bulk-operation.md): Returns the per-environment status of a bulk operation - only the user who triggered it may read it

### Cloud Compass

- [List Organization's Cloud Accounts](https://docs.envzero.com/api-reference/cloud-compass/list-organizations-cloud-accounts.md): Returns all Cloud Accounts associated with an organization.
- [Create Cloud Account](https://docs.envzero.com/api-reference/cloud-compass/create-cloud-account.md)
- [Find Cloud Account by id](https://docs.envzero.com/api-reference/cloud-compass/find-cloud-account-by-id.md)
- [Update Cloud Account](https://docs.envzero.com/api-reference/cloud-compass/update-cloud-account.md)
- [Delete Cloud Account](https://docs.envzero.com/api-reference/cloud-compass/delete-cloud-account.md)
- [Test Cloud Account](https://docs.envzero.com/api-reference/cloud-compass/test-cloud-account.md)
- [Update Cloud Resources](https://docs.envzero.com/api-reference/cloud-compass/update-cloud-resources.md)
- [Find Cloud Resources](https://docs.envzero.com/api-reference/cloud-compass/find-cloud-resources.md)
- [Find Trends Data](https://docs.envzero.com/api-reference/cloud-compass/find-trends-data.md)
- [Generate IaC for Cloud Resources](https://docs.envzero.com/api-reference/cloud-compass/generate-iac-for-cloud-resources.md)
- [Get a link to resource's change event](https://docs.envzero.com/api-reference/cloud-compass/get-a-link-to-resources-change-event.md)
- [Get Resource Events](https://docs.envzero.com/api-reference/cloud-compass/get-resource-events.md)
- [Get Event By ID](https://docs.envzero.com/api-reference/cloud-compass/get-event-by-id.md)
- [List Environment State Resources](https://docs.envzero.com/api-reference/cloud-compass/list-environment-state-resources.md): Returns the cloud resources from the latest state-updating deployment of an environment (Terraform/OpenTofu/Terragrunt only), including cloud join keys (cloudId, cloudCompassResourceId, region, accountId).

### Code-Optimizer (BETA)

- [Get Issues](https://docs.envzero.com/api-reference/code-optimizer-beta/get-issues.md): Retrieve code quality issues for an organization, optionally filtered by state
- [Ignore Issue](https://docs.envzero.com/api-reference/code-optimizer-beta/ignore-issue.md): Change issue state to IGNORED
- [Unignore Issue](https://docs.envzero.com/api-reference/code-optimizer-beta/unignore-issue.md): Change issue state back from IGNORED
- [Get Latest Scan Status](https://docs.envzero.com/api-reference/code-optimizer-beta/get-latest-scan-status.md): Get the overall scan status for all repositories in an organization, including the timestamp of the most recent completed scan
- [Get Repository States](https://docs.envzero.com/api-reference/code-optimizer-beta/get-repository-states.md): Retrieve scan status for all repositories in an organization, including error messages for failed scans
- [Get Issue](https://docs.envzero.com/api-reference/code-optimizer-beta/get-issue.md): Retrieve a single code issue with its relevant environments
- [Generate Code For Issue](https://docs.envzero.com/api-reference/code-optimizer-beta/generate-code-for-issue.md): Trigger code generation for a specific issue
- [Trigger Code Scan](https://docs.envzero.com/api-reference/code-optimizer-beta/trigger-code-scan.md): Trigger a static code analysis scan

### Configuration

- [Query configuration variable by id](https://docs.envzero.com/api-reference/configuration/query-configuration-variable-by-id.md)
- [Delete a variable](https://docs.envzero.com/api-reference/configuration/delete-a-variable.md)
- [List all available SSH keys](https://docs.envzero.com/api-reference/configuration/list-all-available-ssh-keys.md)
- [Create a new SSH key](https://docs.envzero.com/api-reference/configuration/create-a-new-ssh-key.md)
- [Update an existing SSH key](https://docs.envzero.com/api-reference/configuration/update-an-existing-ssh-key.md)
- [Delete SSH key](https://docs.envzero.com/api-reference/configuration/delete-ssh-key.md)
- [List git tokens](https://docs.envzero.com/api-reference/configuration/list-git-tokens.md)
- [Create a git token](https://docs.envzero.com/api-reference/configuration/create-a-git-token.md)
- [Get git token by id](https://docs.envzero.com/api-reference/configuration/get-git-token-by-id.md)
- [Delete a git token](https://docs.envzero.com/api-reference/configuration/delete-a-git-token.md)
- [List Variables by Scope](https://docs.envzero.com/api-reference/configuration/list-variables-by-scope.md): Lists all variables for the provided scope(s). If more than one scope is given - variables will be overridden by lower level scopes - just like env zero does. For example - Provided both organizationId and projectId, if a variable exists on both scopes, a single instance of it will be returned, with…
- [Create or update variable](https://docs.envzero.com/api-reference/configuration/create-or-update-variable.md)
- [List Organization credentials](https://docs.envzero.com/api-reference/configuration/list-organization-credentials.md)
- [Create Credentials](https://docs.envzero.com/api-reference/configuration/create-credentials.md): Create a set of new cloud provider, kubernetes, vault or cost credentials for an Organization which may then be associated with a Project
- [Delete Credentials](https://docs.envzero.com/api-reference/configuration/delete-credentials.md)
- [Update Credentials](https://docs.envzero.com/api-reference/configuration/update-credentials.md): Update deployment credentials or cost credentials for an organization
- [Associate credentials with project](https://docs.envzero.com/api-reference/configuration/associate-credentials-with-project.md): Associate cloud provider, kubernetes or vault deployment credentials to Project
- [Dissociate credentials with project](https://docs.envzero.com/api-reference/configuration/dissociate-credentials-with-project.md): Dissociate cloud provider, kubernetes or vault deployment credentials with Project
- [List deployment credentials by project id](https://docs.envzero.com/api-reference/configuration/list-deployment-credentials-by-project-id.md): List deployment credentials by project id
- [List Sets created by Scope](https://docs.envzero.com/api-reference/configuration/list-sets-created-by-scope.md)
- [Create a configuration set](https://docs.envzero.com/api-reference/configuration/create-a-configuration-set.md)
- [Get configuration set by its ID](https://docs.envzero.com/api-reference/configuration/get-configuration-set-by-its-id.md)
- [Update a configuration set](https://docs.envzero.com/api-reference/configuration/update-a-configuration-set.md)
- [Delete a configuration set](https://docs.envzero.com/api-reference/configuration/delete-a-configuration-set.md)
- [Find sets assigned to scope](https://docs.envzero.com/api-reference/configuration/find-sets-assigned-to-scope.md)
- [Assign sets to entity](https://docs.envzero.com/api-reference/configuration/assign-sets-to-entity.md)
- [Unassign sets from entity](https://docs.envzero.com/api-reference/configuration/unassign-sets-from-entity.md)
- [For finding log forwarding configuration](https://docs.envzero.com/api-reference/configuration/for-finding-log-forwarding-configuration.md)
- [For creating or updating log forwarding configuration](https://docs.envzero.com/api-reference/configuration/for-creating-or-updating-log-forwarding-configuration.md): Log forwarding configuration is used to forward logs to external services
- [For deleting log forwarding configuration](https://docs.envzero.com/api-reference/configuration/for-deleting-log-forwarding-configuration.md)
- [Get an organization CloudQuery integration](https://docs.envzero.com/api-reference/configuration/get-an-organization-cloudquery-integration.md): Returns the organization CloudQuery integration without its secret value, or null when none is configured.
- [Create or update an organization CloudQuery integration](https://docs.envzero.com/api-reference/configuration/create-or-update-an-organization-cloudquery-integration.md): Stores the CloudQuery API key (encrypted) and tenant slug. A single integration is kept per organization.
- [Delete an organization CloudQuery integration](https://docs.envzero.com/api-reference/configuration/delete-an-organization-cloudquery-integration.md): Removes the organization CloudQuery integration.

### Cost

- [List Cost Credentials associated to Project](https://docs.envzero.com/api-reference/cost/list-cost-credentials-associated-to-project.md)
- [Associate Cost Credentials with Project](https://docs.envzero.com/api-reference/cost/associate-cost-credentials-with-project.md): Associate Cloud provider Cost Credentials to a Project. This will enable cost tagging in deployments in the project.
- [List projects with cost credentials associated to organization](https://docs.envzero.com/api-reference/cost/list-projects-with-cost-credentials-associated-to-organization.md)
- [Return wether or not cost is enabled for a project](https://docs.envzero.com/api-reference/cost/return-wether-or-not-cost-is-enabled-for-a-project.md)
- [Dissociate Cost Credentials from Project](https://docs.envzero.com/api-reference/cost/dissociate-cost-credentials-from-project.md): Dissociate Cloud provider Cost Credentials to a Project. This will disable cost tagging in deployments in the project.
- [Get costs for an Environment](https://docs.envzero.com/api-reference/cost/get-costs-for-an-environment.md)
- [Get weekly costs for projects or environments](https://docs.envzero.com/api-reference/cost/get-weekly-costs-for-projects-or-environments.md)
- [Get costs for a Project](https://docs.envzero.com/api-reference/cost/get-costs-for-a-project.md)
- [Get costs for an Organization](https://docs.envzero.com/api-reference/cost/get-costs-for-an-organization.md)
- [Get a project's budget](https://docs.envzero.com/api-reference/cost/get-a-projects-budget.md)
- [Upsert a project's budget](https://docs.envzero.com/api-reference/cost/upsert-a-projects-budget.md)
- [Remove a project's budget](https://docs.envzero.com/api-reference/cost/remove-a-projects-budget.md)
- [Get projects' budget summary of the current period](https://docs.envzero.com/api-reference/cost/get-projects-budget-summary-of-the-current-period.md)
- [Get a project's accumulated costs](https://docs.envzero.com/api-reference/cost/get-a-projects-accumulated-costs.md)

### Credentials

- [List Organization API Keys](https://docs.envzero.com/api-reference/credentials/list-organization-api-keys.md)
- [Create API Key](https://docs.envzero.com/api-reference/credentials/create-api-key.md)
- [Delete an API Key](https://docs.envzero.com/api-reference/credentials/delete-an-api-key.md)
- [List User's personal API Keys endpoint](https://docs.envzero.com/api-reference/credentials/list-users-personal-api-keys-endpoint.md)
- [Create personal API Key](https://docs.envzero.com/api-reference/credentials/create-personal-api-key.md)
- [Delete a User's personal API Key endpoint](https://docs.envzero.com/api-reference/credentials/delete-a-users-personal-api-key-endpoint.md)

### Dashboard

- [Get query result](https://docs.envzero.com/api-reference/dashboard/get-query-result.md)

### Deployment Logs

- [Find all steps by Deployment Id](https://docs.envzero.com/api-reference/deployment-logs/find-all-steps-by-deployment-id.md)
- [Get logs for specific step](https://docs.envzero.com/api-reference/deployment-logs/get-logs-for-specific-step.md)

### Drift

- [Get Drift Causes](https://docs.envzero.com/api-reference/drift/get-drift-causes.md)
- [Get Drift Fix Stats](https://docs.envzero.com/api-reference/drift/get-drift-fix-stats.md)
- [Get Ignored Drift Causes](https://docs.envzero.com/api-reference/drift/get-ignored-drift-causes.md)
- [Ignore Drift Cause](https://docs.envzero.com/api-reference/drift/ignore-drift-cause.md)
- [Un-ignore Drift Cause](https://docs.envzero.com/api-reference/drift/un-ignore-drift-cause.md)

### Environment Import

- [Find Discovered Environments](https://docs.envzero.com/api-reference/environment-import/find-discovered-environments.md)
- [Import Discovered Environments](https://docs.envzero.com/api-reference/environment-import/import-discovered-environments.md)
- [Rerun environments which failed to import](https://docs.envzero.com/api-reference/environment-import/rerun-environments-which-failed-to-import.md)
- [Discover Unimported Environments](https://docs.envzero.com/api-reference/environment-import/discover-unimported-environments.md)
- [Get Selection Issues](https://docs.envzero.com/api-reference/environment-import/get-selection-issues.md)
- [Connect to migration source](https://docs.envzero.com/api-reference/environment-import/connect-to-migration-source.md)
- [Update workspace secrets](https://docs.envzero.com/api-reference/environment-import/update-workspace-secrets.md)
- [Update variable set secrets](https://docs.envzero.com/api-reference/environment-import/update-variable-set-secrets.md)
- [Trigger scan of migration source organization](https://docs.envzero.com/api-reference/environment-import/trigger-scan-of-migration-source-organization.md)
- [Get migration inventory for a session](https://docs.envzero.com/api-reference/environment-import/get-migration-inventory-for-a-session.md)
- [Get migration results for a session](https://docs.envzero.com/api-reference/environment-import/get-migration-results-for-a-session.md)
- [Get a migration session by ID](https://docs.envzero.com/api-reference/environment-import/get-a-migration-session-by-id.md)
- [Delete a migration session](https://docs.envzero.com/api-reference/environment-import/delete-a-migration-session.md)
- [Get active migration session for an organization](https://docs.envzero.com/api-reference/environment-import/get-active-migration-session-for-an-organization.md)
- [Start migration for selected workspaces](https://docs.envzero.com/api-reference/environment-import/start-migration-for-selected-workspaces.md)
- [Go live — lock TFC workspaces and unlock env zero environments](https://docs.envzero.com/api-reference/environment-import/go-live-—-lock-tfc-workspaces-and-unlock-env-zero-environments.md)
- [Skip or unskip a workspace](https://docs.envzero.com/api-reference/environment-import/skip-or-unskip-a-workspace.md)
- [Finish a migration session](https://docs.envzero.com/api-reference/environment-import/finish-a-migration-session.md)

### Environment Outputs

- [Get environment state access configuration](https://docs.envzero.com/api-reference/environment-outputs/get-environment-state-access-configuration.md): Describe which environments, or projects in the organization may access a given environment's state
- [Create and update environment state access configuration](https://docs.envzero.com/api-reference/environment-outputs/create-and-update-environment-state-access-configuration.md): Creates and update configuration describing which environments, or projects in the organization may access a given environment's state
- [Delete environment state access configuration](https://docs.envzero.com/api-reference/environment-outputs/delete-environment-state-access-configuration.md): Deletes an existing environment state access configuration

### Environments

- [Get downstream environments that will be triggered by this environment deployment](https://docs.envzero.com/api-reference/environments/get-downstream-environments-that-will-be-triggered-by-this-environment-deployment.md)
- [Create or Update Workflow Trigger](https://docs.envzero.com/api-reference/environments/create-or-update-workflow-trigger.md): Env0 allows you to configure chained dependent environments to your current environment. Using workflow triggers, you can define which environments would trigger a deployment downstream in response to a deployment of your current environment. This allows you to configure a cascading series of enviro…
- [Subscribe environments as workflow-trigger](https://docs.envzero.com/api-reference/environments/subscribe-environments-as-workflow-trigger.md)
- [Unsubscribe environments as workflow-trigger](https://docs.envzero.com/api-reference/environments/unsubscribe-environments-as-workflow-trigger.md)
- [List Environments](https://docs.envzero.com/api-reference/environments/list-environments.md)
- [Create Environment](https://docs.envzero.com/api-reference/environments/create-environment.md)
- [Get Environment](https://docs.envzero.com/api-reference/environments/get-environment.md)
- [Update Environment](https://docs.envzero.com/api-reference/environments/update-environment.md)
- [Update Environment Tags](https://docs.envzero.com/api-reference/environments/update-environment-tags.md): Applies a JSON merge-patch (RFC 7396) to the environment's tags - a non-empty array replaces that key's values wholesale, null removes the key, and keys that are not mentioned are left untouched
- [Save VCS environment as a template](https://docs.envzero.com/api-reference/environments/save-vcs-environment-as-a-template.md)
- [Scan for Drift Events](https://docs.envzero.com/api-reference/environments/scan-for-drift-events.md)
- [Update Environment TTL](https://docs.envzero.com/api-reference/environments/update-environment-ttl.md)
- [List Deployments](https://docs.envzero.com/api-reference/environments/list-deployments.md)
- [Deploy Environment](https://docs.envzero.com/api-reference/environments/deploy-environment.md)
- [Cancel Deployment](https://docs.envzero.com/api-reference/environments/cancel-deployment.md)
- [Batch Cancel Deployments](https://docs.envzero.com/api-reference/environments/batch-cancel-deployments.md)
- [Abort Deployment](https://docs.envzero.com/api-reference/environments/abort-deployment.md)
- [Destroy Environment](https://docs.envzero.com/api-reference/environments/destroy-environment.md)
- [Get Deployment](https://docs.envzero.com/api-reference/environments/get-deployment.md)
- [Resume Deployment](https://docs.envzero.com/api-reference/environments/resume-deployment.md)
- [Lock/Unlock environment](https://docs.envzero.com/api-reference/environments/lockunlock-environment.md)
- [Download Deployment Plan JSON](https://docs.envzero.com/api-reference/environments/download-deployment-plan-json.md): Downloads the complete Terraform/OpenTofu plan JSON (the output of 'show -json') of the given deployment, including resources with no changes - unlike the parsed plan returned by 'GET /environments/deployments/{id}?fields=plan', which contains only changed resources. Intended for external policy eva…
- [Get Plan Impact For Deployments](https://docs.envzero.com/api-reference/environments/get-plan-impact-for-deployments.md): Returns, per deployment id, how many resources its stored plan would create, update, delete, recreate or only change in state, plus the destructive changes it would make. Reads the plan already stored for the deployment; it runs no new plan.
- [Get Sub Deployment Log In A Workflow By Workflow Deployment Id And Environment Id](https://docs.envzero.com/api-reference/environments/get-sub-deployment-log-in-a-workflow-by-workflow-deployment-id-and-environment-id.md)
- [Find deployment drift status](https://docs.envzero.com/api-reference/environments/find-deployment-drift-status.md)
- [Get a drifted resource's events](https://docs.envzero.com/api-reference/environments/get-a-drifted-resources-events.md)
- [Get a drifted resource's event details](https://docs.envzero.com/api-reference/environments/get-a-drifted-resources-event-details.md)
- [List Environment Tags](https://docs.envzero.com/api-reference/environments/list-environment-tags.md): Returns every tag key on the organization's environments that the caller may view, mapped to its distinct values
- [Count Environments](https://docs.envzero.com/api-reference/environments/count-environments.md)
- [Counts all selected statuses of organization projects](https://docs.envzero.com/api-reference/environments/counts-all-selected-statuses-of-organization-projects.md)
- [Returns an organization's monthly-runs limit and, for run-limited orgs only, its count of successful deploy, destroy and drift-detection runs this month (count is null for uncapped orgs)](https://docs.envzero.com/api-reference/environments/returns-an-organizations-monthly-runs-limit-and-for-run-limited-orgs-only-its-count-of-successful-deploy-destroy-and-drift-detection-runs-this-month-count-is-null-for-uncapped-orgs.md)
- [List Deployment Resources](https://docs.envzero.com/api-reference/environments/list-deployment-resources.md)
- [Check Environment meets Project limits](https://docs.envzero.com/api-reference/environments/check-environment-meets-project-limits.md)
- [Rerun PR plan](https://docs.envzero.com/api-reference/environments/rerun-pr-plan.md)
- [Create an Environment Without Template](https://docs.envzero.com/api-reference/environments/create-an-environment-without-template.md)
- [Get Environments Outputs](https://docs.envzero.com/api-reference/environments/get-environments-outputs.md)
- [Get Environments With Outputs](https://docs.envzero.com/api-reference/environments/get-environments-with-outputs.md)
- [Move Environment between Projects](https://docs.envzero.com/api-reference/environments/move-environment-between-projects.md)
- [Remediate Drift Deployment](https://docs.envzero.com/api-reference/environments/remediate-drift-deployment.md): Remediate a drifted environment, using a drift detection deployment ID

### Projects

- [Get Policy](https://docs.envzero.com/api-reference/projects/get-policy.md)
- [Update Policy](https://docs.envzero.com/api-reference/projects/update-policy.md)
- [Get Modules Testing Project for Organization](https://docs.envzero.com/api-reference/projects/get-modules-testing-project-for-organization.md)
- [Get a Project By ID](https://docs.envzero.com/api-reference/projects/get-a-project-by-id.md)
- [Update a Project](https://docs.envzero.com/api-reference/projects/update-a-project.md)
- [Archive a Project](https://docs.envzero.com/api-reference/projects/archive-a-project.md): This can not be undone. Running Environments will NOT be destroyed and continuous and scheduled Deployments will NOT continue to occur.
- [Move a project to be a sub-project of another project](https://docs.envzero.com/api-reference/projects/move-a-project-to-be-a-sub-project-of-another-project.md)
- [List Projects](https://docs.envzero.com/api-reference/projects/list-projects.md)
- [Create a new Project](https://docs.envzero.com/api-reference/projects/create-a-new-project.md)
- [List Projects (slim tree)](https://docs.envzero.com/api-reference/projects/list-projects-slim-tree.md)
- [List Direct Sub-Projects](https://docs.envzero.com/api-reference/projects/list-direct-sub-projects.md): Returns a single layer of active projects: the Organization's root Projects when parentProjectId is omitted, or the direct sub-projects of parentProjectId when it is given. Each Project carries hasSubProjects so the caller knows whether it can be expanded further.
- [List Organization Projects Tags](https://docs.envzero.com/api-reference/projects/list-organization-projects-tags.md)
- [Get Users With Access to Project](https://docs.envzero.com/api-reference/projects/get-users-with-access-to-project.md): Returns all users who have access to a project, including organization admins, users with direct project assignments, and users who have access through team assignments. Currently supports organizations with up to approximately 1000 users due to our limits.

### Notifications

- [List Notification Endpoints](https://docs.envzero.com/api-reference/notifications/list-notification-endpoints.md)
- [Create Notification Endpoint](https://docs.envzero.com/api-reference/notifications/create-notification-endpoint.md)
- [Delete Notification Endpoint](https://docs.envzero.com/api-reference/notifications/delete-notification-endpoint.md)
- [Update Notification Endpoint](https://docs.envzero.com/api-reference/notifications/update-notification-endpoint.md)
- [Update Notification Settings](https://docs.envzero.com/api-reference/notifications/update-notification-settings.md)
- [Get Notification Endpoint settings](https://docs.envzero.com/api-reference/notifications/get-notification-endpoint-settings.md)
- [Test webhook notification target](https://docs.envzero.com/api-reference/notifications/test-webhook-notification-target.md)

### Organization

- [List Organizations](https://docs.envzero.com/api-reference/organization/list-organizations.md)
- [Create a new Organization](https://docs.envzero.com/api-reference/organization/create-a-new-organization.md)
- [Get Organization](https://docs.envzero.com/api-reference/organization/get-organization.md)
- [Update Organization](https://docs.envzero.com/api-reference/organization/update-organization.md)
- [Get Organization Limits](https://docs.envzero.com/api-reference/organization/get-organization-limits.md)
- [Update Policy](https://docs.envzero.com/api-reference/organization/update-policy.md)
- [Get SSO Configuration](https://docs.envzero.com/api-reference/organization/get-sso-configuration.md)
- [Delete SSO Connection](https://docs.envzero.com/api-reference/organization/delete-sso-connection.md)
- [Create SSO Ticket](https://docs.envzero.com/api-reference/organization/create-sso-ticket.md)
- [Create SSO Edit Ticket](https://docs.envzero.com/api-reference/organization/create-sso-edit-ticket.md)
- [List Users](https://docs.envzero.com/api-reference/organization/list-users.md)
- [Remove User](https://docs.envzero.com/api-reference/organization/remove-user.md)
- [Invite User](https://docs.envzero.com/api-reference/organization/invite-user.md)
- [Update User's Organization Role Assignment](https://docs.envzero.com/api-reference/organization/update-users-organization-role-assignment.md)

### Provider Registry

- [Find all providers in an organization](https://docs.envzero.com/api-reference/provider-registry/find-all-providers-in-an-organization.md)
- [Create a new provider](https://docs.envzero.com/api-reference/provider-registry/create-a-new-provider.md)
- [Find a provider by id](https://docs.envzero.com/api-reference/provider-registry/find-a-provider-by-id.md)
- [Update a provider](https://docs.envzero.com/api-reference/provider-registry/update-a-provider.md)
- [Delete a provider](https://docs.envzero.com/api-reference/provider-registry/delete-a-provider.md)
- [Find a provider by type](https://docs.envzero.com/api-reference/provider-registry/find-a-provider-by-type.md)
- [List all available GPG keys](https://docs.envzero.com/api-reference/provider-registry/list-all-available-gpg-keys.md)
- [Create a new GPG key](https://docs.envzero.com/api-reference/provider-registry/create-a-new-gpg-key.md)
- [Delete a GPG key](https://docs.envzero.com/api-reference/provider-registry/delete-a-gpg-key.md)
- [Create a new provider version](https://docs.envzero.com/api-reference/provider-registry/create-a-new-provider-version.md)
- [Get a download url for a specific version](https://docs.envzero.com/api-reference/provider-registry/get-a-download-url-for-a-specific-version.md)

### Remote Backend

- [Get remote state access configuration](https://docs.envzero.com/api-reference/remote-backend/get-remote-state-access-configuration.md): Describe which environments, or projects in the organization may access a given environment's state
- [Create remote state access configuration](https://docs.envzero.com/api-reference/remote-backend/create-remote-state-access-configuration.md): Creates configuration describing which environments, or projects in the organization may access a given environment's state
- [Delete remote state access configuration](https://docs.envzero.com/api-reference/remote-backend/delete-remote-state-access-configuration.md): Deletes an existing environment state access configuration

### Roles

- [Get a Role](https://docs.envzero.com/api-reference/roles/get-a-role.md)
- [Update a Role](https://docs.envzero.com/api-reference/roles/update-a-role.md)
- [Delete a Role](https://docs.envzero.com/api-reference/roles/delete-a-role.md)
- [Get All Roles](https://docs.envzero.com/api-reference/roles/get-all-roles.md)
- [Create a Role](https://docs.envzero.com/api-reference/roles/create-a-role.md)
- [Get User Role Assignments](https://docs.envzero.com/api-reference/roles/get-user-role-assignments.md): Currently supports environment scope assignments only.
- [Create or Update a Role Assignment for a User](https://docs.envzero.com/api-reference/roles/create-or-update-a-role-assignment-for-a-user.md): Currently supports environment scope assignments only.
- [Remove a Role Assignment for a User](https://docs.envzero.com/api-reference/roles/remove-a-role-assignment-for-a-user.md): Currently supports environment scope assignments only.
- [Get Team Role Assignments](https://docs.envzero.com/api-reference/roles/get-team-role-assignments.md): Specifying `environmentId`, `projectId` or `organizationId` is required.
- [Create or Update a Role Assignment for a Team](https://docs.envzero.com/api-reference/roles/create-or-update-a-role-assignment-for-a-team.md): Specifying `environmentId`, `projectId`, or `organizationId` is required.
- [Remove a Role Assignment for a Team](https://docs.envzero.com/api-reference/roles/remove-a-role-assignment-for-a-team.md): Specifying `environmentId`, `projectId` or `organizationId` is required.

### Scheduling

- [Get Environment Scheduling](https://docs.envzero.com/api-reference/scheduling/get-environment-scheduling.md)
- [Set Environment Scheduling](https://docs.envzero.com/api-reference/scheduling/set-environment-scheduling.md)
- [Get Project Scheduling](https://docs.envzero.com/api-reference/scheduling/get-project-scheduling.md)
- [Get Drift Detection Environment Scheduling](https://docs.envzero.com/api-reference/scheduling/get-drift-detection-environment-scheduling.md)
- [Set Drift Detection Environment Scheduling](https://docs.envzero.com/api-reference/scheduling/set-drift-detection-environment-scheduling.md)

### Teams

- [Create Team](https://docs.envzero.com/api-reference/teams/create-team.md)
- [List Teams](https://docs.envzero.com/api-reference/teams/list-teams.md)
- [Get Team](https://docs.envzero.com/api-reference/teams/get-team.md)
- [Update Team](https://docs.envzero.com/api-reference/teams/update-team.md)
- [Delete Team](https://docs.envzero.com/api-reference/teams/delete-team.md)
- [List Project Teams Permissions](https://docs.envzero.com/api-reference/teams/list-project-teams-permissions.md): This API is deprecated. Please use "Get Team Role Assignments" instead.
- [Update Teams Assignments](https://docs.envzero.com/api-reference/teams/update-teams-assignments.md): This API is deprecated. Please use "Create or Update a Role Assignment for a Team" instead.
- [Create or Update a single Team to Project Assignment](https://docs.envzero.com/api-reference/teams/create-or-update-a-single-team-to-project-assignment.md): This API is deprecated. Please use "Create or Update a Role Assignment for a Team" instead.
- [Delete a single Team to Project Assignment](https://docs.envzero.com/api-reference/teams/delete-a-single-team-to-project-assignment.md): This API is deprecated. Please use "Remove a Role Assignment for a Team" instead.

### VCS

- [List VCS Connections](https://docs.envzero.com/api-reference/vcs/list-vcs-connections.md)
- [Create VCS Connection](https://docs.envzero.com/api-reference/vcs/create-vcs-connection.md): Only supported creation of Self-Hosted VCS connections
- [Get VCS Connection](https://docs.envzero.com/api-reference/vcs/get-vcs-connection.md)
- [Update VCS Connection](https://docs.envzero.com/api-reference/vcs/update-vcs-connection.md)
- [Delete VCS Connection](https://docs.envzero.com/api-reference/vcs/delete-vcs-connection.md)
- [Get VCS Repositories](https://docs.envzero.com/api-reference/vcs/get-vcs-repositories.md)
- [List the entities that use a VCS connection](https://docs.envzero.com/api-reference/vcs/list-the-entities-that-use-a-vcs-connection.md)

### Role Based Access

- [Get the user's role assignments in a project](https://docs.envzero.com/api-reference/role-based-access/get-the-users-role-assignments-in-a-project.md)
- [Assign a role to a user in a project](https://docs.envzero.com/api-reference/role-based-access/assign-a-role-to-a-user-in-a-project.md)
- [Update user's role assignment on project](https://docs.envzero.com/api-reference/role-based-access/update-users-role-assignment-on-project.md)
- [Remove user's role assignment on project](https://docs.envzero.com/api-reference/role-based-access/remove-users-role-assignment-on-project.md)

### Webhooks

- [Environment marked for auto destroy webhook](https://docs.envzero.com/api-reference/webhooks/environment-marked-for-auto-destroy-webhook.md): This webhook is fired when an environment is marked for auto destroy by a TTL Policy
- [Deployment started webhook](https://docs.envzero.com/api-reference/webhooks/deployment-started-webhook.md): This webhook is fired when a deployment has started
- [Destroy started webhook](https://docs.envzero.com/api-reference/webhooks/destroy-started-webhook.md): This webhook is fired when a destroy has started
- [Deploy succeeded webhook](https://docs.envzero.com/api-reference/webhooks/deploy-succeeded-webhook.md): This webhook is fired when a deploy has finished successfully
- [Destroy succeeded webhook](https://docs.envzero.com/api-reference/webhooks/destroy-succeeded-webhook.md): This webhook is fired when a destroy has finished successfully
- [Deploy failed webhook](https://docs.envzero.com/api-reference/webhooks/deploy-failed-webhook.md): This webhook is fired when a deploy has failed
- [Destroy failed webhook](https://docs.envzero.com/api-reference/webhooks/destroy-failed-webhook.md): This webhook is fired when a destroy has failed
- [Pr plan failed webhook](https://docs.envzero.com/api-reference/webhooks/pr-plan-failed-webhook.md): This webhook is fired when a PR plan has failed
- [Deployment waiting for user webhook](https://docs.envzero.com/api-reference/webhooks/deployment-waiting-for-user-webhook.md): This webhook is fired when a deployment requires an approval
- [Deployment cancelled webhook](https://docs.envzero.com/api-reference/webhooks/deployment-cancelled-webhook.md): This webhook is fired when a deployment has been cancelled
- [Deployment resumed webhook](https://docs.envzero.com/api-reference/webhooks/deployment-resumed-webhook.md): This webhook is fired when a deployment has been resumed after an approval
- [Destroy resumed webhook](https://docs.envzero.com/api-reference/webhooks/destroy-resumed-webhook.md): This webhook is fired when a destroy has been resumed after an approval
- [Drift detected webhook](https://docs.envzero.com/api-reference/webhooks/drift-detected-webhook.md): This webhook is fired when env zero detected a drift in an environment
- [Drift undetected webhook](https://docs.envzero.com/api-reference/webhooks/drift-undetected-webhook.md): This webhook is fired when a drift has been reconciled
- [Drift failed webhook](https://docs.envzero.com/api-reference/webhooks/drift-failed-webhook.md): This webhook is fired when an env zero drift detection failed to complete
- [Budget exceeded webhook](https://docs.envzero.com/api-reference/webhooks/budget-exceeded-webhook.md): This webhook is fired when a "Budget Exceeded" event has been triggered

## OpenAPI Specs

- [openapi](/api-reference/openapi.yml)