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

The Configuration API from GitHub — 6 operation(s) for configuration.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 10 operations across 6 paths, and defines 11 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}.

10 operations 6 paths 11 schemas 5 GET4 PATCH1 POST

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 Configuration API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerHttpAuthentication).

  • bearerHttpAuthentication — Bearer Token

Paths & Operations 10

Across 6 paths, the API surfaces 10 operations — 5 GET, 4 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Configuration 10
GET
/app/hook/config
GitHub Getwebhook Configuration for an App
getwebhookConfigurationForAnApp → 200
PATCH
/app/hook/config
GitHub Updatewebhook Configuration for an App
updatewebhookConfigurationForAnApp body → 200
GET
/orgs/{org}/hooks/{hook_id}/config
GitHub Get Webhook Configuration for an Organization
getWebhookConfigurationForAnOrganization 2 params → 200
PATCH
/orgs/{org}/hooks/{hook_id}/config
GitHub Update Webhook Configuration for an Organization
updateWebhookConfigurationForAnOrganization 2 params body → 200
GET
/repos/{owner}/{repo}/code-scanning/default-setup
GitHub Get Code Scanning Default Setup Configuration
getCodeScanningDefaultSetupConfiguration 5 params → 200403404503
PATCH
/repos/{owner}/{repo}/code-scanning/default-setup
GitHub Update Code Scanning Default Setup Configuration
updateCodeScanningDefaultSetupConfiguration 5 params body → 200202403404409503
GET
/repos/{owner}/{repo}/hooks/{hook_id}/config
GitHub Get Webhook Configuration for Repository
getWebhookConfigurationForRepository 6 params → 200
PATCH
/repos/{owner}/{repo}/hooks/{hook_id}/config
GitHub Update Webhook Configuration for Repository
updateWebhookConfigurationForRepository 6 params body → 200
GET
/setup/api/configcheck
GitHub Get the Configuration Status
getTheConfigurationStatus → 200401
POST
/setup/api/configure
GitHub Start Configuration Process
startConfigurationProcess → 202401

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are webhook-config (4 properties), basic-error (4 properties), code-scanning-default-setup (4 properties), code-scanning-default-setup-update-response (2 properties). Each schema is shown below with its type and property counts.

webhook-config-insecure-ssl
webhook-config-content-type
string
The media type used to serialize the payloads. Supported values include json and form. The default is form.
webhook-config-secret
string
If provided, the secret will be used as the key to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-serve…
webhook-config-url
string
The URL to which the payloads will be delivered.
webhook-config
object
Configuration object of the webhook
4 properties
empty-object
object
An object without any properties.
code-scanning-default-setup
object
Configuration for code scanning default setup.
4 properties
basic-error
object
Basic Error
4 properties
code-scanning-default-setup-update
object
Configuration for code scanning default setup.
2 properties 1 required
code-scanning-default-setup-update-response
object
You can use runurl to track the status of the run. This includes a property status and conclusion. You should not rely on this always being an actions workflow…
2 properties
configuration-status
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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