List deployments - GitHub API

Simple filtering of deployments is available via query parameters:

[ { "created_at": "2012-07-20T01:19:13Z", "description": "Deploy request from hubot", "environment": "production", "id": 42, "node_id": "MDEwOkRlcGxveW1lbnQx", "original_environment": "staging", "performed_via_github_app": {}, "production_environment": true, "repository_url": "https://api.github.com/repos/octocat/example", "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", "task": "deploy", "transient_environment": true, "updated_at": "2012-07-20T01:19:13Z", "url": "https://api.github.com/repos/octocat/example/deployments/1" } ]

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

owner

string

必需

repo

string

必需

Query 参数

sha

string

可选

The SHA recorded at creation time.

ref

string

可选

The name of the ref. This can be a branch, tag, or SHA.

task

string

可选

The name of the task for the deployment (e.g., deploy or deploy:migrations).

environment

string

可选

The name of the environment that was deployed to (e.g., staging or production).

per_page

integer

可选

Results per page (max 100).

page

integer

可选

Page number of the results to fetch.

返回响应

🟢200Response

application/json

Body

array of:

created_at

string <date-time>

必需

示例值:

2012-07-20T01:19:13Z

description

string | null

必需

示例值:

Deploy request from hubot

environment

string

必需

Name for the target deployment environment.

示例值:

production

integer

必需

Unique identifier of the deployment

示例值:

node_id

string

必需

示例值:

MDEwOkRlcGxveW1lbnQx

original_environment

string

可选

示例值:

staging

performed_via_github_app

null | allOf {1}

可选

object

可选

production_environment

boolean

可选

Specifies if the given environment is one that end-users directly interact with. Default: false.

示例值:

true

repository_url

string <uri>

必需

示例值:

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

statuses_url

string <uri>

必需

示例值:

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

task

string

必需

Parameter to specify a task to execute

示例值:

deploy

transient_environment

boolean

可选

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

示例值:

true

updated_at

string <date-time>

必需

示例值:

2012-07-20T01:19:13Z

url

string <uri>

必需

示例值:

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