status_deployments
Overview
Name | status_deployments |
Type | Resource |
Id | github.repos.status_deployments |
Fields
Name | Datatype | Description |
---|---|---|
id | integer | |
description | string | A short description of the status. |
created_at | string | |
creator | object | A GitHub user. |
deployment_url | string | |
environment | string | The environment of the deployment that the status is for. |
environment_url | string | The URL for accessing your environment. |
log_url | string | The URL to associate with this status. |
node_id | string | |
performed_via_github_app | object | 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 | |
state | string | The state of the status. |
target_url | string | Deprecated: the URL to associate with this status. |
updated_at | string | |
url | string |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get_deployment_status | SELECT | deployment_id, owner, repo, status_id | Users with pull access can view a deployment status for a deployment: |
list_deployment_statuses | SELECT | deployment_id, owner, repo | Users with pull access can view deployment statuses for a deployment: |
create_deployment_status | INSERT | deployment_id, owner, repo, data__state | Users 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. |