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
CircleCI

CircleCI SSH Key API

Endpoints for managing SSH keys and checkout keys for projects.

Documentation Provider Profile APIs.io OpenAPI GitHub

CircleCI SSH Key API is one of 18 APIs that CircleCI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SSH Key. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 3 paths, and defines 1 schema. It is described by OpenAPI 3.2.0, at version 1.1.

Requests are made against a single base URL, https://circleci.com/api/v1.1.

5 operations 3 paths 1 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1
Base URL
https://circleci.com/api/v2
Authentication
API Key
Contact
CircleCI Support
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

CircleCI SSH Key API declares 1 security scheme for authenticating requests. An API key is passed in the header as Circle-Token (apiToken). By default, every request must be authenticated.

  • apiToken — Personal API token for authenticating with the CircleCI API. Can also be passed as a query parameter.

Paths & Operations 5

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

SSH Key 5

Endpoints for managing SSH keys and checkout keys for projects.

POST
/project/{vcs-type}/{username}/{project}/ssh-key
Add an SSH key
addSSHKey 3 params body → 200401
GET
/project/{vcs-type}/{username}/{project}/checkout-key
List checkout keys
listCheckoutKeys 3 params → 200401
POST
/project/{vcs-type}/{username}/{project}/checkout-key
Create a checkout key
createCheckoutKey 3 params body → 201401
GET
/project/{vcs-type}/{username}/{project}/checkout-key/{fingerprint}
Get a checkout key
getCheckoutKey 4 params → 200401404
DELETE
/project/{vcs-type}/{username}/{project}/checkout-key/{fingerprint}
Delete a checkout key
deleteCheckoutKey 4 params → 200401

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is CheckoutKey (6 properties). Each schema is shown below with its type and property counts.

CheckoutKey
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

circleci-ssh-key-api-openapi.yml Raw ↑

Other APIs CircleCI publishes across the network.

CircleCI Self-Hosted Runner API
AE Profile APIs.io
CircleCI Webhooks
AE Profile APIs.io
CircleCI Orbs Registry
AE Profile APIs.io
CircleCI Artifact API
AE Profile APIs.io
CircleCI Build API
AE Profile APIs.io
CircleCI Context API
AE Profile APIs.io
CircleCI Insights API
AE Profile APIs.io
CircleCI Job API
AE Profile APIs.io
CircleCI Pipeline API
AE Profile APIs.io
CircleCI Project API
AE Profile APIs.io
CircleCI Resource Class API
AE Profile APIs.io
CircleCI Runner Task API
AE Profile APIs.io
#SSH Key
← Back to C APIs
API Details
ID
circleci:circleci-ssh-key-api
Base URL
https://circleci.com/api/v2
Docs
https://circleci.com/docs/api/v2/
Provider
CircleCI
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=circleci-ssh-key-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/circleci-ssh-key-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 CircleCI SSH Key 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.