Netlify

Netlify Deploy API

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

GitHub OpenAPI
Business capability
Deployment Orchestration BC-4210.40

Operations 13

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /sites/{site_id}/deploys List a site's deploys · List site deploys #
Ask an LLM
“How do I see the deploy history for my site?”
“Can I filter deploys to only production or only a specific branch?”
Tell an agent
List deploys for site {site}.
List deploys on site {site} from branch {branch}.
POST /sites/{site_id}/deploys Create a new deploy for a site · Create site deploy #
Ask an LLM
“How do I deploy files to my Netlify site through the API?”
“Can I create a draft deploy instead of publishing to production?”
Tell an agent
Create a new deploy for site {site}.
Create a draft deploy on site {site} for branch {branch}.
GET /sites/{site_id}/deploys/{deploy_id} Get a deploy scoped to a site · Get site deploy #
Ask an LLM
“Can I look up a deploy's details within a specific site?”
“What state is a given deploy of my site in?”
Tell an agent
Get deploy {deploy} of site {site}.
Show the status of deploy {deploy} under site {site}.
PUT /sites/{site_id}/deploys/{deploy_id} Update an existing site deploy · Update site deploy #
Ask an LLM
“Can I add files to a deploy I already created?”
“How do I attach a commit ref to an existing deploy?”
Tell an agent
Update deploy {deploy} on site {site} with new files.
Set commit ref {commit} on deploy {deploy} of site {site}.
DELETE /sites/{site_id}/deploys/{deploy_id} Delete a deploy from a site · Delete site deploy #
Ask an LLM
“Can I delete a specific deploy from my site's history?”
“Is removing a deploy under a site permanent?”
Tell an agent destructive · confirm first
Delete deploy {deploy} from site {site}.
Remove deploy {deploy} in the history of site {site}.
POST /deploys/{deploy_id}/cancel Cancel a running deploy · Cancel site deploy #
Ask an LLM
“How do I stop a deploy that's still in progress?”
“Can I cancel a deploy that is taking too long?”
Tell an agent destructive · confirm first
Cancel deploy {deploy}.
Stop the in-progress deploy {deploy}.
POST /sites/{site_id}/deploys/{deploy_id}/restore Restore a previous deploy as live · Restore site deploy #
Ask an LLM
“Can I republish an older deploy of my site?”
“How do I make a past deploy the live version again?”
Tell an agent
Restore deploy {deploy} as the live version of site {site}.
Republish old deploy {deploy} on site {site}.
PUT /sites/{site_id}/rollback Roll back a site to its previous deploy · Rollback site deploy #
Ask an LLM
“Can I quickly undo my latest production deploy?”
“What's the fastest way to go back to the previously published deploy?”
Tell an agent
Roll back site {site} to the previous deploy.
Undo the latest publish on site {site}.
GET /deploys/{deploy_id} Get a deploy by its ID · Get deploy #
Ask an LLM
“Can I look up a deploy with just its deploy ID and no site?”
“Where do I check a deploy's state if I only have its ID?”
Tell an agent
Get deploy {deploy} by ID.
Look up deploy {deploy} without a site ID.
DELETE /deploys/{deploy_id} Delete a deploy by its ID · Delete deploy #
Ask an LLM
“Can I delete a deploy knowing only its deploy ID?”
“Is there a way to remove a deploy without specifying the site?”
Tell an agent destructive · confirm first
Delete deploy {deploy} by ID.
Remove deploy {deploy} without referencing its site.
PATCH /deploys/{deploy_id}/validations_report Update a deploy's validations report · Update deploy validations #
Ask an LLM
“How do I record secrets scan results on a deploy?”
“Can I update the validations report for a deploy?”
Tell an agent
Update the validations report for deploy {deploy}.
Attach secrets scan results {scan} to deploy {deploy}.
POST /deploys/{deploy_id}/lock Lock a deploy to stop auto publishing · Lock deploy #
Ask an LLM
“Can I pin my site to one deploy so new builds don't auto-publish?”
“How do I lock the currently published deploy?”
Tell an agent
Lock deploy {deploy}.
Pin deploy {deploy} so later deploys are not auto-published.
POST /deploys/{deploy_id}/unlock Unlock a deploy to resume auto publishing · Unlock deploy #
Ask an LLM
“How do I turn auto publishing back on after locking a deploy?”
“Can I unlock a deploy I pinned earlier?”
Tell an agent
Unlock deploy {deploy}.
Release the lock on deploy {deploy} so new deploys publish again.

Documentation

📖
Documentation
https://open-api.netlify.com/
📖
GettingStarted
https://docs.netlify.com/api-and-cli-guides/api-guides/get-started-with-api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/netlify/refs/heads/main/openapi/netlify-deploy-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/netlify/refs/heads/main/asyncapi/netlify-webhooks-asyncapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/netlify/refs/heads/main/overlays/netlify-deploy-overlay.yaml
🔗
API Guides
https://docs.netlify.com/api-and-cli-guides/overview/
🔗
OpenAPI Source
https://github.com/netlify/open-api
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/netlify/refs/heads/main/graphql/netlify-graphql.md

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/netlify:netlify-deploy-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

netlify-deploy-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 2.57.0
  title: Netlify's API documentation Deploy API
  description: Netlify is a hosting service for the programmable web.
  termsOfService: https://www.netlify.com/legal/terms-of-use/
  x-logo:
    url: netlify-logo.png
    href: https://www.netlify.com/docs/
    altText: Netlify
servers:
- url: https://api.netlify.com/api/v1
security:
- netlifyAuth: []
tags:


# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/netlify/refs/heads/main/openapi/netlify-deploy-api-openapi.yml