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
Netlify

Netlify Deploy API

The Deploy API from Netlify — 8 operation(s) for deploy.

Documentation Provider Profile APIs.io OpenAPI GitHub

Netlify Deploy API is one of 42 APIs that Netlify publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Deploy. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and a getting-started guide.

This API exposes 13 operations across 9 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

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

13 operations 9 paths 10 schemas 2 DELETE3 GET1 PATCH5 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.netlify.com/api/v1/
Authentication
OAuth 2.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Netlify Deploy API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (netlifyAuth) using the implicit flow. By default, every request must be authenticated.

Paths & Operations 13

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

Deploy 13
GET
/sites/{site_id}/deploys
listSiteDeploys 14 params → 200default
POST
/sites/{site_id}/deploys
createSiteDeploy 13 params body → 200default
GET
/sites/{site_id}/deploys/{deploy_id}
getSiteDeploy 2 params → 200default
PUT
/sites/{site_id}/deploys/{deploy_id}
updateSiteDeploy 2 params body → 200default
DELETE
/sites/{site_id}/deploys/{deploy_id}
deleteSiteDeploy 2 params → 204default
POST
/deploys/{deploy_id}/cancel
cancelSiteDeploy 1 param → 201default
POST
/sites/{site_id}/deploys/{deploy_id}/restore
restoreSiteDeploy 2 params → 201default
PUT
/sites/{site_id}/rollback
rollbackSiteDeploy 2 params → 204default
GET
/deploys/{deploy_id}
getDeploy 1 param → 200default
DELETE
/deploys/{deploy_id}
deleteDeploy 1 param → 204default
POST
/deploys/{deploy_id}/lock
lockDeploy 1 param → 200default
POST
/deploys/{deploy_id}/unlock
unlockDeploy 1 param → 200default
PATCH
/deploys/{deploy_id}/validations_report
Updates the deploy validations report for a deploy.
updateDeployValidations 1 param body → 200

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are deploy (30 properties), deployFiles (9 properties), functionConfig (7 properties), functionRoute (5 properties). Each schema is shown below with its type and property counts.

functionConfig
object
7 properties
trafficRulesRateLimitConfig
object
3 properties
trafficRulesAggregateConfig
object
1 property
functionRoute
object
5 properties
deployFiles
object
9 properties
trafficRulesConfig
object
1 property
deploy
object
30 properties
error
object
2 properties 1 required
functionSchedule
object
2 properties
excludedFunctionRoute
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netlify-deploy-api-openapi.yml Raw ↑

Other APIs Netlify publishes across the network.

Netlify accessToken API
AE Profile APIs.io
Netlify accountMembership API
AE Profile APIs.io
Netlify accountType API
AE Profile APIs.io
Netlify Asset API
AE Profile APIs.io
Netlify assetPublicSignature API
AE Profile APIs.io
Netlify auditLog API
AE Profile APIs.io
Netlify Build API
AE Profile APIs.io
Netlify buildHook API
AE Profile APIs.io
Netlify buildLogMsg API
AE Profile APIs.io
Netlify deployedBranch API
AE Profile APIs.io
Netlify deployKey API
AE Profile APIs.io
Netlify devServer API
AE Profile APIs.io
#Deploy
← Back to N APIs
API Details
ID
netlify:netlify-deploy-api
Base URL
https://api.netlify.com/api/v1/
Docs
https://docs.netlify.com/api-and-cli-guides/api-guides/get-started-with-api/
Provider
Netlify
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=netlify-deploy-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/netlify-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 Netlify 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.