Skip to main content
Manja / GitHub
Schema1.1.4object

deployment-status

The status of a deployment.

Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Deployment Status

object

The status of a deployment.

created_at string (date-time)
required

Example:2012-07-20T01:19:13Z

deployment_url string (uri)
required

Example:https://api.github.com/repos/octocat/example/deployments/42

description string
required

A short description of the status.

Example:Deployment finished successfully.

maxLength:140

environment string
optional

The environment of the deployment that the status is for.

Example:production

environment_url string (uri)
optional

The URL for accessing your environment.

Example:https://staging.example.com/

id integer
required

Example:1

log_url string (uri)
optional

The URL to associate with this status.

Example:https://example.com/deployment/42/output

node_id string
required

Example:MDE2OkRlcGxveW1lbnRTdGF0dXMx

performed_via_github_app GitHub app object
optionalnullable

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.

repository_url string (uri)
required

Example:https://api.github.com/repos/octocat/example

state string
required

The state of the status.

Example:success

Allowed: "error""failure""inactive""pending""success""queued""in_progress"

target_url string (uri)
required

Deprecated: the URL to associate with this status.

Example:https://example.com/deployment/42/output

updated_at string (date-time)
required

Example:2012-07-20T01:19:13Z

url string (uri)
required

Example:https://api.github.com/repos/octocat/example/deployments/42/statuses/1