Get Drift Causes
Returns the drift causes detected across an organization, grouped by root cause rather than by environment, so a single cause affecting many environments is reported once with the full list of environments it affects. Each group carries its causeKind, the causeKeyParts identifying what changed (the shape of which varies by kind), when it was first and last seen, and the affected environments. Narrow the result to specific projects with projectIds.
Authorization
env0_API_Key env zero API authentication is done via API keys. An API Key can either be created by an organization administrator, in which case it will not be connected to any specific user, or via Personal API Keys to authenticate as a user.
Creating an API Key with a Specific Role
- Once you've created your organization, you can set up and manage API Keys.
- Navigate to the Organization Settings page and click the API Keys tab.
- Click Add API Key and enter a name for your key in the Name field. This name is for reference purposes only and isn't used directly in authentication.
❗️Save Your API Key ID and secret The secret will not be available after you close this window.
Creating a Personal API Key
- Click on your avatar (located on the top right of the screen)
- Click on Personal Settings
- Select the API Keys tab
- Click Add API Key, and enter a name for your key in the Name field. This name is for reference purposes and isn't used directly in authentication.
❗️Save your API Key ID & secret The secret will not be available after you close this window.
Using an API Key to Authenticate
Authentication of the env zero API is done using the Basic Authentication method. Each request made should include the API Key ID as the username, and the API Key secret as the password. For example, when using curl, we can include these parameters via flag --user {API Key ID}:{API Key Secret}.
API Key Permissions
When creating an API key through the organization settings, you will need to choose if you’d like to grant it Organization Admin or User permissions. In case of the latter, you can assign fine-grained permissions per project. Personal API Keys can be created through the user’s profile page and will have the same permissions as the user has.
Rate Limits
env zero API allows up to 1K requests per 60 seconds, requests are aggregated by IP, HTTP Method and URI. If you exceed this limit, you will receive a 429 status code.
In: header
Query Parameters
The organization id
Optional comma-separated project ids to narrow the results to
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/drift-causes?organizationId=string"{ "causes": [ { "causeKind": "unmanagedChange", "causeKeyParts": { "resourceType": "string", "strippedPath": "string", "changeType": "modified" }, "causeId": "string", "firstSeenAt": "string", "lastSeenAt": "string", "environments": [ { "id": "string", "name": "string", "projectId": "string", "driftDeploymentId": "string" } ] } ]}Get logs for specific step GET
Returns the log events of one deployment step. The response carries `nextStartTime` and `hasMoreLogs`, so a step that is still running, or whose log is long, is read by repeating the call until `hasMoreLogs` is false.
Get Drift Fix Stats GET
Returns how long drift causes have been taking to resolve across an organization: the median fix duration in milliseconds, the number of resolved causes the median was computed from, and the trailing window used. The window defaults to 90 days and is capped at 365. `medianFixDurationInMillis` is null when no causes closed within the window.