List the deployment environments.

post/filter/environments

Request

Base URL
{{ server_url }}/v1
Auth
- HTTP bearer
- or API key in header X-API-Key
TypeScript
https://skmtc.dev/athenian/apis/title/docs/filter/environments/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

accountinteger required

Account ID.

repositoriesRepositoryID[]

At least one repository in the list must be deployed in [date_from, date_to).

date_fromstring date required

Date from when to start looking for deployments.

date_tostring date required

Date until which to look for deployments.

timezoneinteger

Local time zone offset in minutes, used to adjust date_from and date_to.

Example request

{
  "repositories": [
    "github.com/athenianco/athenian-api",
    "github.com/athenianco/athenian-webapp"
  ],
  "date_to": "2022-02-23",
  "account": 1,
  "date_from": "2022-01-23"
}

Response

Deployment environments that satisfy the specified filters.

deployments_countinteger required

Number of deployments (successful or not) in the specified time interval.

last_conclusion'SUCCESS' | 'FAILURE' | 'CANCELLED' required

The conclusion of the most recent deployment before date_to.

namestring required

Name of the environment.

repositoriesRepositoryID[] required

List of repositories which had at least one deployment between date_from and date_to.

Example response

[
  {
    "deployments_count": 100,
    "last_conclusion": "SUCCESS",
    "name": "production",
    "repositories": [
      "github.com/athenianco/athenian-api",
      "github.com/athenianco/athenian-webapp"
    ]
  }
]

Changes

No recorded changes to this operation across all 70 revisions of this API.