repos

List deployments

Simple filtering of deployments is available via query parameters:

get/repos/{owner}/{repo}/deployments

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/repos/{owner}/{repo}/deployments
  • Auth: none declared

Path parameters

ownerstring required

The account owner of the repository. The name is not case sensitive.

repostring required

The name of the repository without the .git extension. The name is not case sensitive.

Query parameters

shastring

The SHA recorded at creation time.

refstring

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

taskstring

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

environmentstring nullable

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

per_pageinteger

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

pageinteger

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Response

Response

urlstring uri required
idinteger required

Unique identifier of the deployment

node_idstring required
shastring required
refstring required

The ref to deploy. This can be a branch, tag, or sha.

taskstring required

Parameter to specify a task to execute

original_environmentstring
environmentstring required

Name for the target deployment environment.

descriptionstring nullable required
created_atstring date-time required
updated_atstring date-time required
statuses_urlstring uri required
repository_urlstring uri required
transient_environmentboolean

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

production_environmentboolean

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

Example response

[
  {
    "url": "https://api.github.com/repos/octocat/example/deployments/1",
    "id": 42,
    "node_id": "MDEwOkRlcGxveW1lbnQx",
    "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d",
    "ref": "topic-branch",
    "task": "deploy",
    "original_environment": "staging",
    "environment": "production",
    "description": "Deploy request from hubot",
    "creator": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "starred_at": "\"2020-07-09T00:17:55Z\"",
      "user_view_type": "public"
    },
    "created_at": "2012-07-20T01:19:13Z",
    "updated_at": "2012-07-20T01:19:13Z",
    "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses",
    "repository_url": "https://api.github.com/repos/octocat/example",
    "transient_environment": true,
    "production_environment": true,
    "performed_via_github_app": {
      "id": 37,
      "slug": "probot-owners",
      "node_id": "MDExOkludGVncmF0aW9uMQ==",
      "client_id": "\"Iv1.25b5d1e65ffc4022\"",
      "owner": {
        "login": "octocat",
        "id": 1,
        "node_id": "MDQ6VXNlcjE=",
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
        "url": "https://api.github.com/users/octocat",
        "html_url": "https://github.com/octocat",
        "followers_url": "https://api.github.com/users/octocat/followers",
        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
        "organizations_url": "https://api.github.com/users/octocat/orgs",
        "repos_url": "https://api.github.com/users/octocat/repos",
        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
        "received_events_url": "https://api.github.com/users/octocat/received_events",
        "type": "User",
        "starred_at": "\"2020-07-09T00:17:55Z\"",
        "user_view_type": "public"
      },
      "name": "Probot Owners",
      "description": "The description of the app.",
      "external_url": "https://example.com",
      "html_url": "https://github.com/apps/super-ci",
      "created_at": "2017-07-08T16:18:44-04:00",
      "updated_at": "2017-07-08T16:18:44-04:00",
      "permissions": {
        "issues": "read",
        "deployments": "write"
      },
      "events": [
        "label",
        "deployment"
      ],
      "installations_count": 5
    }
  }
]

Changes

No recorded changes to this operation across all 23 revisions of this API.