How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
GitHub

GitHub Deployments API

The Deployments API from GitHub — 8 operation(s) for deployments.

Documentation Provider Profile APIs.io OpenAPI GitHub

GitHub Deployments API is one of 350 APIs that GitHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Deployment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and an API reference.

This API exposes 15 operations across 8 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 1.1.4.

Requests are made against a single base URL, {protocol}://{hostname}.

15 operations 8 paths 17 schemas 2 DELETE7 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1.4
Base URL
https://api.github.com
Authentication
HTTP Bearer
Contact
Support
License
MIT
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

GitHub Deployments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerHttpAuthentication).

  • bearerHttpAuthentication — Bearer Token

Paths & Operations 15

Across 8 paths, the API surfaces 15 operations — 2 DELETE, 7 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Deployments 15
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments
GitHub Get Pending Deployments for Workflow Run
getPendingDeploymentsForWorkflowRun 6 params → 200
POST
/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments
GitHub Review Pending Deployments for Workflow Run
reviewPendingDeploymentsForWorkflowRun 6 params body → 200
GET
/repos/{owner}/{repo}/deployments
GitHub List Deployments
listDeployments 11 params → 200
POST
/repos/{owner}/{repo}/deployments
GitHub Create Deployment
createDeployment 5 params body → 201202409422
GET
/repos/{owner}/{repo}/deployments/{deployment_id}
GitHub Get Deployment
getDeployment 6 params → 200404
DELETE
/repos/{owner}/{repo}/deployments/{deployment_id}
GitHub Delete Deployment
deleteDeployment 6 params → 204404422
GET
/repos/{owner}/{repo}/deployments/{deployment_id}/statuses
GitHub List Deployment Statuses
listDeploymentStatuses 8 params → 200404
POST
/repos/{owner}/{repo}/deployments/{deployment_id}/statuses
GitHub Create Deployment Status
createDeploymentStatus 6 params body → 201422
GET
/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}
GitHub Get Deployment Status
getDeploymentStatus 7 params → 200404
GET
/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies
GitHub List Deployment Branch Policies
listDeploymentBranchPolicies 8 params → 200
POST
/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies
GitHub Create Deployment Branch Policy
createDeploymentBranchPolicy 6 params body → 200303404
GET
/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}
GitHub Get Deployment Branch Policy
getDeploymentBranchPolicy 7 params → 200
PUT
/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}
GitHub Update Deployment Branch Policy
updateDeploymentBranchPolicy 7 params body → 200
DELETE
/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}
GitHub Delete Deployment Branch Policy
deleteDeploymentBranchPolicy 7 params → 204
POST
/repos/{owner}/{repo}/pages/deployments
GitHub Create Github Pages Deployment
createGithubPagesDeployment 5 params body → 200400404422

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are simple-user (21 properties), nullable-simple-user (21 properties), deployment (18 properties), nullable-integration (17 properties). Each schema is shown below with its type and property counts.

team
object
Groups of organization members that gives permissions on specified repositories.
13 properties 11 required
pending-deployment
object
Details of a deployment that is waiting for protection rules to pass
5 properties 5 required
simple-user
object
GitHub user.
21 properties 18 required
deployment
object
request for a specific ref(branch,sha,tag) to be deployed
18 properties 14 required
nullable-integration
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…
17 properties 11 required
nullable-simple-user
object
GitHub user.
21 properties 18 required
deployment-reviewer-type
string
The type of reviewer.
nullable-team-simple
object
Groups of organization members that gives permissions on specified repositories.
12 properties 10 required
validation-error-simple
object
Validation Error Simple
3 properties 2 required
deployment-branch-policy-name-pattern-with-type
object
1 property 1 required
scim-error
object
Scim Error
6 properties
validation-error
object
Validation Error
3 properties 2 required
basic-error
object
Basic Error
4 properties
deployment-branch-policy-name-pattern
object
1 property 1 required
page-deployment
object
The GitHub Pages deployment status.
3 properties 2 required
deployment-branch-policy
object
Details of a deployment branch policy.
3 properties
deployment-status
object
The status of a deployment.
15 properties 11 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

github-deployments-api-openapi.yml Raw ↑

Other APIs GitHub publishes across the network.

GitHub Events API
AE Profile APIs.io
GitHub Feeds API
AE Profile APIs.io
GitHub Gists API
AE Profile APIs.io
GitHub Issues API
AE Profile APIs.io
GitHub Licenses API
AE Profile APIs.io
GitHub Markdown API
AE Profile APIs.io
GitHub Meta API
AE Profile APIs.io
GitHub Notifications API
AE Profile APIs.io
GitHub Octocat API
AE Profile APIs.io
GitHub Projects API
AE Profile APIs.io
GitHub Repos API
AE Profile APIs.io
GitHub Search API
AE Profile APIs.io
#Deployment
← Back to G APIs
API Details
ID
github:github-deployments-api
Base URL
https://api.github.com
Docs
https://docs.github.com/en/rest/apps?apiVersion=2022-11-28
Provider
GitHub
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=github-deployments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/github-deployments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of GitHub Deployments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.