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

Scalar github API

The github API from Scalar — 16 operation(s) for github.

Scalar github API is one of 30 APIs that Scalar publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include GitHub. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 16 operations across 16 paths, and defines 13 schemas. It is described by OpenAPI 3.1.1, at version 1.0.1.

16 operations 16 paths 13 schemas 8 GET8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.1
API Version
1.0.1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Scalar github API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 16

Across 16 paths, the API surfaces 16 operations — 8 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.

github 16
GET
/github/authorize
Get and save a user github token to their database object. This allows subsequent queries for github data from the users scope.
getgithubAuthorize 2 params → 200400401403404422500
GET
/github/link/initiate
Issue a signed OAuth state token for the GitHub user-authorization flow and return the GitHub authorize URL the client should redirect to. Optionally remembers a dashboard path to return the user to…
getgithubLinkInitiate 1 param → 200400401403404422500
GET
/github/repos
Get a list of repositories that can be linked to a project
getgithubRepos → 200400401403404422500
GET
/github/repos/{id}
Get repository info
getgithubReposId 1 param → 200400401403404422500
POST
/github/link-repo
Links a github repo to a Scalar github project
postgithubLinkRepo body → 200400401403404422500
GET
/github/docs-project/{uid}/commits
List commits from the GitHub repo backing a provider: github DocsProject
getgithubDocsProjectUidCommits 4 params → 200400401403404422500
GET
/github/docs-project/{uid}/branches
List branches on the GitHub repo backing a provider: github DocsProject. Supports prefix search.
getgithubDocsProjectUidBranches 4 params → 200400401403404422500
POST
/github/docs-project/{uid}/pull-request
Create a pull request on the GitHub repo backing a provider: github DocsProject
postgithubDocsProjectUidPullRequest 1 param body → 200400401403404422500
POST
/github/slug/available
Check if github slug is available
postgithubSlugAvailable body → 200400401403404422500
POST
/github/slug
Update a github project slug
postgithubSlug body → 200400401403404422500
POST
/github/create
Create a github project that is not linked to a github repo. This project will be used by the cli flow.
postgithubCreate body → 200400401403404422500
POST
/github/unlink-repo
Unlink a github repo from a Scalar github project
postgithubUnlinkRepo body → 200400401403404422500
POST
/github/config/validate
Validate configuration file for a github project
postgithubConfigValidate body → 200400401403404422500
GET
/github/{slug}
Get a github project.
getgithubSlug 1 param → 200400401403404422500
GET
/github/list-projects
Get github projects for the team
getgithubListProjects → 200400401403404422500
POST
/github/delete
Deletes a Github project
postgithubDelete body → 200400401403404422500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are github-project (18 properties), github-project-repository (9 properties), github-install (4 properties), active-deployment (3 properties). Each schema is shown below with its type and property counts.

github-project-repository
object
9 properties 9 required
github-install
object
4 properties 3 required
github-project
object
18 properties 16 required
nanoid
string
404
object
2 properties 2 required
401
object
2 properties 2 required
slug
string
500
object
2 properties 2 required
active-deployment
object
3 properties 3 required
400
object
2 properties 2 required
403
object
2 properties 2 required
timestamp
integer
422
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

scalar-github-api-openapi.yml Raw ↑

Other APIs Scalar publishes across the network.

Scalar API References
Scalar API Client
Scalar Docs
Scalar Registry
Scalar SDKs
Scalar CLI
Scalar access-groups API
Scalar analytics API
Scalar api-docs API
Scalar auth API
Scalar docs API
Scalar Docs Projects API
Where this information came from

This is an independent, third-party profile of Scalar github 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.