provider repos GET /repos/{owner}/{repo}/deployments
@utdk/github /repos/{owner}/{repo}/deployments
List deployments
Simple filtering of deployments is available via query parameters:
owner path required
The account owner of the repository. The name is not case sensitive.
string
repo path required
The name of the repository without the `.git` extension. The name is not case sensitive.
string
sha query
The SHA recorded at creation time.
string
ref query
The name of the ref. This can be a branch, tag, or SHA.
string
task query
The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).
string
environment query
The name of the environment that was deployed to (e.g., `staging` or `production`).
string
per_page query
The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integer
page query
The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integer

Try it

Authentication
Configure credentials for GitHub v3 REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

repos.listDeployments
GET/repos/{owner}/{repo}/deployments
Simple filtering of deployments is available via query parameters:

Parameters

required

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

required

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

The SHA recorded at creation time.

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

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

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

The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."

The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import github from '@utdk/github';

await github.repos.listDeployments({
  "sha": "none",
  "ref": "none",
  "task": "none",
  "environment": "none",
  "per_page": 30,
  "page": 1
})