Simple filtering of deployments is available via query parameters:
Request Request Example
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
curl--location--request GET 'https://api.github.com/repos///deployments'
Response Response Example
[{"created_at":"2012-07-20T01:19:13.000Z","creator":{"avatar_url":"https://github.com/images/error/octocat_happy.gif","email":"string","events_url":"https://api.github.com/users/octocat/events{/privacy}","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}","gravatar_id":"41d064eb2195891e12d0413f63227ea7","html_url":"https://github.com/octocat","id":1,"login":"octocat","name":"string","node_id":"MDQ6VXNlcjE=","organizations_url":"https://api.github.com/users/octocat/orgs","received_events_url":"https://api.github.com/users/octocat/received_events","repos_url":"https://api.github.com/users/octocat/repos","site_admin":true,"starred_at":"\"2020-07-09T00:17:55Z\"","starred_url":"https://api.github.com/users/octocat/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/octocat/subscriptions","type":"User","url":"https://api.github.com/users/octocat"},"description":"Deploy request from hubot","environment":"production","id":42,"node_id":"MDEwOkRlcGxveW1lbnQx","original_environment":"staging","payload":{},"performed_via_github_app":{"client_id":"\"Iv1.25b5d1e65ffc4022\"","client_secret":"\"1d4b2097ac622ba702d19de498f005747a8b21d3\"","created_at":"2017-07-08T20:18:44.000Z","description":"The description of the app.","events":["label","deployment"],"external_url":"https://example.com","html_url":"https://github.com/apps/super-ci","id":37,"installations_count":5,"name":"Probot Owners","node_id":"MDExOkludGVncmF0aW9uMQ==","owner":{"avatar_url":"https://github.com/images/error/octocat_happy.gif","email":"string","events_url":"https://api.github.com/users/octocat/events{/privacy}","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}","gravatar_id":"41d064eb2195891e12d0413f63227ea7","html_url":"https://github.com/octocat","id":1,"login":"octocat","name":"string","node_id":"MDQ6VXNlcjE=","organizations_url":"https://api.github.com/users/octocat/orgs","received_events_url":"https://api.github.com/users/octocat/received_events","repos_url":"https://api.github.com/users/octocat/repos","site_admin":true,"starred_at":"\"2020-07-09T00:17:55Z\"","starred_url":"https://api.github.com/users/octocat/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/octocat/subscriptions","type":"User","url":"https://api.github.com/users/octocat"},"pem":"\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"","permissions":{"deployments":"write","issues":"read"},"slug":"probot-owners","updated_at":"2017-07-08T20:18:44.000Z","webhook_secret":"\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\""},"production_environment":true,"ref":"topic-branch","repository_url":"https://api.github.com/repos/octocat/example","sha":"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d","statuses_url":"https://api.github.com/repos/octocat/example/deployments/1/statuses","task":"deploy","transient_environment":true,"updated_at":"2012-07-20T01:19:13.000Z","url":"https://api.github.com/repos/octocat/example/deployments/1"}]
Request
Path Params
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Query Params
sha
string
optional
The SHA recorded at creation time.
ref
string
optional
The name of the ref. This can be a branch, tag, or SHA.
task
string
optional
The name of the task for the deployment (e.g., deploy or deploy:migrations).
environment
string
optional
The name of the environment that was deployed to (e.g., staging or production).
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.
client_id
string
optional
Example:
"Iv1.25b5d1e65ffc4022"
client_secret
string
optional
Example:
"1d4b2097ac622ba702d19de498f005747a8b21d3"
created_at
string<date-time>
required
Example:
2017-07-08T20:18:44.000Z
description
string|null
required
Example:
The description of the app.
events
array[string]
required
The list of events for the GitHub app
Example:
["label","deployment"]
external_url
string<uri>
required
Example:
https://example.com
html_url
string<uri>
required
Example:
https://github.com/apps/super-ci
id
integer
required
Unique identifier of the GitHub app
Example:
37
installations_count
integer
optional
The number of installations associated with the GitHub app