Skip to main content

deployment_statuses

Overview

Namedeployment_statuses
TypeResource
Idgithub.repos.deployment_statuses

Fields

NameDatatypeDescription
idinteger
descriptionstringA short description of the status.
node_idstring
deployment_urlstring
log_urlstringThe URL to associate with this status.
creatorobjectSimple User
updated_atstring
created_atstring
statestringThe state of the status.
urlstring
target_urlstringDeprecated: the URL to associate with this status.
environment_urlstringThe URL for accessing your environment.
performed_via_github_appobjectGitHub 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_urlstring
environmentstringThe environment of the deployment that the status is for.

Methods

NameAccessible byRequired ParamsDescription
get_deployment_statusSELECTdeployment_id, owner, repo, status_idUsers with pull access can view a deployment status for a deployment:
list_deployment_statusesSELECTdeployment_id, owner, repoUsers with pull access can view deployment statuses for a deployment:
create_deployment_statusINSERTdeployment_id, owner, repo, data__stateUsers with push access can create deployment statuses for a given deployment.

GitHub Apps require read & write access to "Deployments" and read-only access to "Repo contents" (for private repos). OAuth Apps require the repo_deployment scope.