Skip to main content

status_deployments

Overview

Namestatus_deployments
TypeResource
Idgithub.repos.status_deployments

Fields

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

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.