GET /repos/{owner}/{repo}/deployments

Simple filtering of deployments is available via query parameters:

Servers

Path parameters

Name Type Required Description
repo String Yes

The name of the repository without the .git extension. The name is not case sensitive.

owner String Yes

The account owner of the repository. The name is not case sensitive.

Query parameters

Name Type Required Description
sha String No

The SHA recorded at creation time.

Default value: "none"

page Integer No

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Default value: 1

per_page Integer No

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Default value: 30

ref String No

The name of the ref. This can be a branch, tag, or SHA.

Default value: "none"

environment String No

The name of the environment that was deployed to (e.g., staging or production).

Default value: "none"

task String No

The name of the task for the deployment (e.g., deploy or deploy:migrations).

Default value: "none"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.