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 Status API

The Status API from GitHub — 11 operation(s) for status.

Documentation Provider Profile APIs.io OpenAPI GitHub

GitHub Status 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 Status. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and an API reference.

This API exposes 16 operations across 11 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version 1.1.4.

Requests are made against 2 base URLs: {protocol}://{hostname}/api/v3, {protocol}://{hostname}.

16 operations 11 paths 22 schemas 2 DELETE9 GET1 PATCH3 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
License
MIT
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

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

  • bearerHttpAuthentication — Bearer Token

Paths & Operations 16

Across 11 paths, the API surfaces 16 operations — 2 DELETE, 9 GET, 1 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Status 16
GET
/manage/v1/replication/status
GitHub Get the Status of Services Running on All Replica Nodes
getTheStatusOfServicesRunningOnAllReplicaNodes 2 params → 200401500
GET
/orgs/{org}/migrations/{migration_id}
GitHub Get an Organization Migration Status
getAnOrganizationMigrationStatus 3 params → 200404
GET
/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks
GitHub Get Status Checks Protection
getStatusChecksProtection 6 params → 200404
PATCH
/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks
GitHub Update Status Check Protection
updateStatusCheckProtection 6 params body → 200404422
DELETE
/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks
GitHub Remove Status Check Protection
removeStatusCheckProtection 6 params → 204
GET
/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts
GitHub Get All Status Check Contexts
getAllStatusCheckContexts 6 params → 200404
POST
/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts
GitHub Add Status Check Contexts
addStatusCheckContexts 6 params body → 200403404422
PUT
/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts
GitHub Set Status Check Contexts
setStatusCheckContexts 6 params body → 200404422
DELETE
/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts
GitHub Remove Status Check Contexts
removeStatusCheckContexts 6 params body → 200404422
GET
/repos/{owner}/{repo}/commits/{ref}/status
GitHub Get the Combined Status for Specific Reference
getTheCombinedStatusForSpecificReference 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}/replicas/caches
GitHub List Repository Cache Replication Status
listRepositoryCacheReplicationStatus 7 params → 200403404
POST
/repos/{owner}/{repo}/statuses/{sha}
GitHub Create Commit Status
createCommitStatus 6 params body → 201
GET
/setup/api/configcheck
GitHub Get the Configuration Status
getTheConfigurationStatus → 200401
GET
/setup/api/maintenance
GitHub Get the Maintenance Status
getTheMaintenanceStatus → 200401

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are repository (95 properties), minimal-repository (87 properties), nullable-simple-user (21 properties), nullable-simple-user_2 (21 properties). Each schema is shown below with its type and property counts.

ghes-replication-status-indicator
string
ghes-replication-status
object
2 properties
simple-user
object
A GitHub user.
21 properties 18 required
repository
object
A repository on GitHub.
95 properties 73 required
nullable-simple-user
objectnull
A GitHub user.
21 properties 18 required
basic-error
object
Basic Error
4 properties
migration
object
A migration.
18 properties 16 required
nullable-license-simple
objectnull
License Simple
6 properties 5 required
status-check-policy
object
Status Check Policy
5 properties 5 required
validation-error
object
Validation Error
3 properties 2 required
code-of-conduct
object
Code Of Conduct
5 properties 4 required
minimal-repository
object
Minimal Repository
87 properties 46 required
security-and-analysis
object
3 properties
simple-commit-status
object
11 properties 10 required
simple-user_2
object
GitHub user.
21 properties 18 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
status
object
The status of a commit.
11 properties 11 required
combined-commit-status
object
Combined Commit Status
7 properties 7 required
deployment-status
object
The status of a deployment.
15 properties 11 required
nullable-simple-user_2
object
GitHub user.
21 properties 18 required
configuration-status
object
2 properties
maintenance-status
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

github-status-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
#Status
← Back to G APIs
API Details
ID
github:github-status-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-status-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/github-status-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 Status 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.