Create a deployment status

POST {{baseUrl}}/repos/:owner/:repo/deployments/:deployment_id/statuses

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.

Request Body

{"state"=>"<string>", "target_url"=>"", "log_url"=>"", "description"=>"", "environment"=>"<string>", "environment_url"=>"", "auto_inactive"=>"<boolean>"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: Created

{&quot;url&quot;:&quot;https://api.github.com/repos/octocat/example/deployments/42/statuses/1&quot;,&quot;id&quot;:1,&quot;node_id&quot;:&quot;MDE2OkRlcGxveW1lbnRTdGF0dXMx&quot;,&quot;state&quot;:&quot;success&quot;,&quot;creator&quot;:{&quot;login&quot;:&quot;octocat&quot;,&quot;id&quot;:1,&quot;node_id&quot;:&quot;MDQ6VXNlcjE=&quot;,&quot;avatar_url&quot;:&quot;https://github.com/images/error/octocat_happy.gif&quot;,&quot;gravatar_id&quot;:&quot;&quot;,&quot;url&quot;:&quot;https://api.github.com/users/octocat&quot;,&quot;html_url&quot;:&quot;https://github.com/octocat&quot;,&quot;followers_url&quot;:&quot;https://api.github.com/users/octocat/followers&quot;,&quot;following_url&quot;:&quot;https://api.github.com/users/octocat/following{/other_user}&quot;,&quot;gists_url&quot;:&quot;https://api.github.com/users/octocat/gists{/gist_id}&quot;,&quot;starred_url&quot;:&quot;https://api.github.com/users/octocat/starred{/owner}{/repo}&quot;,&quot;subscriptions_url&quot;:&quot;https://api.github.com/users/octocat/subscriptions&quot;,&quot;organizations_url&quot;:&quot;https://api.github.com/users/octocat/orgs&quot;,&quot;repos_url&quot;:&quot;https://api.github.com/users/octocat/repos&quot;,&quot;events_url&quot;:&quot;https://api.github.com/users/octocat/events{/privacy}&quot;,&quot;received_events_url&quot;:&quot;https://api.github.com/users/octocat/received_events&quot;,&quot;type&quot;:&quot;User&quot;,&quot;site_admin&quot;:false},&quot;description&quot;:&quot;Deployment finished successfully.&quot;,&quot;environment&quot;:&quot;production&quot;,&quot;target_url&quot;:&quot;https://example.com/deployment/42/output&quot;,&quot;created_at&quot;:&quot;2012-07-20T01:19:13Z&quot;,&quot;updated_at&quot;:&quot;2012-07-20T01:19:13Z&quot;,&quot;deployment_url&quot;:&quot;https://api.github.com/repos/octocat/example/deployments/42&quot;,&quot;repository_url&quot;:&quot;https://api.github.com/repos/octocat/example&quot;,&quot;environment_url&quot;:&quot;https://test-branch.lab.acme.com&quot;,&quot;log_url&quot;:&quot;https://example.com/deployment/42/output&quot;}