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

Get a deployment status

Retrieves a status for a specific deployment in a repository. Use owner, repo, deployment_id, and status_id to identify the deployment status. The response includes the status state, associated environment, URLs, creator, and timestamps.

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

4 parameters
ownerstringrequired
The account owner of the repository; the name is not case sensitive.
repostringrequired
The repository name without the `.git` extension; the name is not case sensitive.
deployment_idintegerrequired
The numeric identifier of the deployment whose status to retrieve.
status_idintegerrequired
The numeric identifier of the deployment status to retrieve.

2 status codes
200Returns the deployment status object with its state, creator, description, deployment and repository URLs, environment details, and timestamps.
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.
404Returned when the repository, deployment, or deployment status does not exist.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 404 is returned when the repository, deployment, or status identified by owner, repo, deployment_id, and status_id cannot be found. state values are limited to error, failure, inactive, pending, success, queued, and in_progress, and description must not exceed 140 characters.