GitHub API (unofficial showcase)
GET/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}

Get a deployment status

Retrieves a status record for a deployment in a repository. You must have pull access to the repository to view the deployment status.

4 parameters
ownerstringrequired
The account that owns 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 integer identifier of the deployment whose status to retrieve.
status_idintegerrequired
The integer identifier of the deployment status to retrieve.

2 status codes
200Returns the deployment status object, including its state, description, creator, deployment and environment URLs, 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 status cannot be found.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 404 is returned when the repository, deployment, or status cannot be found. The deployment_id and status_id path parameters must identify a deployment and its status in the specified repository.