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
Unkey

Unkey deploy API

Deployment operations

Documentation Provider Profile APIs.io OpenAPI GitHub

Unkey deploy API is one of 8 APIs that Unkey publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Deploy. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 3 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 18 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.unkey.com.

2 operations 2 paths 18 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.unkey.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Unkey deploy API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (root key) (rootKey). By default, every request must be authenticated.

  • rootKey — Unkey uses API keys (root keys) for authentication. These keys authorize access to management operations in the API. To authenticate, include your root key in…

Paths & Operations 2

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

deploy 2

Deployment operations

POST
/v2/deploy.createDeployment
Create Deployment
deploy.createDeployment body → 201400401403404429500
POST
/v2/deploy.getDeployment
Get Deployment
deploy.getDeployment body → 200400401403404429500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are V2DeployCreateDeploymentRequestBody (7 properties), V2DeployGitCommit (5 properties), V2DeployGetDeploymentResponseData (5 properties), BaseError (4 properties). Each schema is shown below with its type and property counts.

BadRequestErrorResponse
object
Error response for invalid requests that cannot be processed due to client-side errors. This typically occurs when request parameters are missing, malformed, o…
2 properties 2 required
V2DeployCreateDeploymentRequestBody
object
Create a deployment from a pre-built Docker image
7 properties 5 required
InternalServerErrorResponse
object
Error response when an unexpected error occurs on the server. This indicates a problem with Unkey's systems rather than your request. When you encounter this e…
2 properties 2 required
V2DeployGetDeploymentResponseBody
object
2 properties 2 required
V2DeployGitCommit
object
Optional git commit information
5 properties
Meta
object
Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. Th…
1 property 1 required
NotFoundErrorResponse
object
Error response when the requested resource cannot be found. This occurs when: - The specified resource ID doesn't exist in your workspace - The resource has be…
2 properties 2 required
V2DeployCreateDeploymentResponseBody
object
2 properties 2 required
UnauthorizedErrorResponse
object
Error response when authentication has failed or credentials are missing. This occurs when: - No authentication token is provided in the request - The provided…
2 properties 2 required
TooManyRequestsErrorResponse
object
Error response when the client has sent too many requests in a given time period. This occurs when you've exceeded a rate limit or quota for the resource you'r…
2 properties 2 required
BaseError
object
Base error structure following Problem Details for HTTP APIs (RFC 7807). This provides a standardized way to carry machine-readable details of errors in HTTP r…
4 properties 4 required
BadRequestErrorDetails
Extended error details specifically for bad request (400) errors. This builds on the BaseError structure by adding an array of individual validation errors, ma…
ForbiddenErrorResponse
object
Error response when the provided credentials are valid but lack sufficient permissions for the requested operation. This occurs when: - The root key doesn't ha…
2 properties 2 required
V2DeployGetDeploymentResponseData
object
5 properties 2 required
V2DeployCreateDeploymentResponseData
object
1 property 1 required
ValidationError
object
Individual validation error details. Each validation error provides precise information about what failed, where it failed, and how to fix it, enabling efficie…
3 properties 2 required
V2DeployDeploymentStep
object
4 properties
V2DeployGetDeploymentRequestBody
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

unkey-deploy-api-openapi.yml Raw ↑

Other APIs Unkey publishes across the network.

Unkey analytics API
AE Profile APIs.io
Unkey apis API
AE Profile APIs.io
Unkey identities API
AE Profile APIs.io
Unkey keys API
AE Profile APIs.io
Unkey liveness API
AE Profile APIs.io
Unkey permissions API
AE Profile APIs.io
Unkey ratelimit API
AE Profile APIs.io
#Deploy
← Back to U APIs
API Details
ID
unkey:unkey-deploy-api
Base URL
https://api.unkey.com
Docs
https://www.unkey.com
Provider
Unkey
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=unkey-deploy-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/unkey-deploy-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 Unkey deploy 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.