Sample - GitHub REST API
GET/repos/{owner}/{repo}/deployments/{deployment_id}/statuses

List deployment statuses

Users with pull access can view deployment statuses for a deployment:

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

5 parameters
ownerstringrequired
The account owner of the repository. The name is not case sensitive.
repostringrequired
The name of the repository without the `.git` extension. The name is not case sensitive.
deployment_idintegerrequired
deployment_id parameter
per_pageintegeroptional
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)."
Default:30
pageintegeroptional
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)."
Default:1

2 status codes
200Response
urlstringrequired
idintegerrequired
node_idstringrequired
statestringrequired
The state of the status.
Allowed:errorfailureinactivependingsuccessqueuedin_progress
creatorobjectrequired
A GitHub user.
descriptionstringrequired
A short description of the status.
Default:
environmentstringoptional
The environment of the deployment that the status is for.
Default:
target_urlstringrequired
Closing down notice: the URL to associate with this status.
Default:
created_atstringrequired
updated_atstringrequired
deployment_urlstringrequired
repository_urlstringrequired
environment_urlstringoptional
The URL for accessing your environment.
Default:
log_urlstringoptional
The URL to associate with this status.
Default:
performed_via_github_appobjectoptional
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 404 is returned: Resource not found.