Netlify

Netlify Build API

The Build API from Netlify — 4 operation(s) for build.

GitHub OpenAPI
Business capability
Continuous Integration Management BC-4210.10

Operations 5

GET /sites/{site_id}/builds List site builds #
POST /sites/{site_id}/builds Create site build #
GET /builds/{build_id} Get site build #
POST /builds/{build_id}/start Notify build start #
GET /{account_id}/builds/status Get account build status #

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-build-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-build-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-build-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-build-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 2.57.0
  title: Netlify's API documentation Build 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:
- name: Build
  x-displayName: Build
paths:
  /sites/{site_id}/builds:
    parameters:
    - name: site_id
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: listSiteBuilds
      tags:
      - Build
      parameters:
      - name: page
        required: false
        in: query
        schema:
          type: integer
          format: int32
      - name: per_page
        required: false
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    deploy_id:
                      type: string
                    sha:
                      type: string
                    done:
                      type: boolean
                    error:
                      type: string
                    created_at:
                      type: string
                      format: dateTime
        default:
          description: error
          content:
            application/json:
              schema:
                type: object
                required:
                - message
                properties:
                  code:
                    type: integer
                    format: int64
                  message:
                    type: string
      summary: List site builds
      x-summary-source: derived
    post:
      operationId: createSiteBuild
      tags:
      - Build
      description: 'Runs a build for a site. The build will be scheduled to run at the first opportunity, but it might not start immediately if insufficient account build capacity is available.


        Files for build can be uploaded as a zipped site using one of these methods:

        1. Set Content-Type to ''application/zip'' and send the zip file as the raw request body

        2. Set Content-Type to ''multipart/form-data'' and include the zip file in the ''zip'' field'
      parameters:
      - name: branch
        description: If no branch is specified, it is treated as a production deploy If a branch IS specified and matches the main branch, it is also production If a branch is specified and doesn't match the main branch, it is a branch deploy
        required: false
        in: query
        schema:
          type: string
      - name: clear_cache
        description: Whether to clear the build cache before building
        required: false
        in: query
        schema:
          type: boolean
      - name: image
        description: The build image tag to use for the build
        required: false
        in: query
        schema:
          type: string
      - name: template_id
        description: The build template to use for the build
        required: false
        in: query
        schema:
          type: string
      - name: title
        description: The title of the build
        required: false
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  deploy_id:
                    type: string
                  sha:
                    type: string
                  done:
                    type: boolean
                  error:
                    type: string
                  created_at:
                    type: string
                    format: dateTime
        '400':
          description: Bad Request
        '404':
          description: Not Found
        '422':
          description: Unprocessable Entity
        default:
          description: error
          content:
            application/json:
              schema:
                type: object
                required:
                - message
                properties:
                  code:
                    type: integer
                    format: int64
                  message:
                    type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                zip:
                  type: string
                  description: 'A zip file containing the site files to build.

                    Only used with Content-Type ''multipart/form-data''.

                    Alternatively, set Content-Type to ''application/zip'' and send the zip as the raw request body (no ''zip'' parameter needed).

                    '
                  format: binary
      summary: Create site build
      x-summary-source: derived
  /builds/{build_id}:
    parameters:
    - name: build_id
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: getSiteBuild
      tags:
      - Build
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  deploy_id:
                    type: string
                  sha:
                    type: string
                  done:
                    type: boolean
                  error:
                    type: string
                  created_at:
                    type: string
                    format: dateTime
        default:
          description: error
          content:
            application/json:
              schema:
                type: object
                required:
                - message
                properties:
                  code:
                    type: integer
                    format: int64
                  message:
                    type: string
      summary: Get site build
      x-summary-source: derived
  /builds/{build_id}/start:
    parameters:
    - name: build_id
      in: path
      required: true
      schema:
        type: string
    - name: buildbot_version
      in: query
      required: false
      schema:
        type: string
    - name: build_version
      in: query
      required: false
      schema:
        type: string
    - name: task_id
      in: query
      required: false
      schema:
        type: string
    post:
      operationId: notifyBuildStart
      tags:
      - Build
      responses:
        '204':
          description: No content
        default:
          description: error
          content:
            application/json:
              schema:
                type: object
                required:
                - message
                properties:
                  code:
                    type: integer
                    format: int64
                  message:
                    type: string
      summary: Notify build start
      x-summary-source: derived
  /{account_id}/builds/status:
    parameters:
    - name: account_id
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: getAccountBuildStatus
      tags:
      - Build
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    active:
                      type: integer
                    pending_concurrency:
                      type: integer
                    enqueued:
                      type: integer
                    build_count:
                      type: integer
                    minutes:
                      type: object
                      properties:
                        current:
                          type: integer
                        current_average_sec:
                          type: integer
                        previous:
                          type: integer
                        period_start_date:
                          type: string
                          format: dateTime
                        period_end_date:
                          type: string
                          format: dateTime
                        last_updated_at:
                          type: string
                          format: dateTime
                        included_minutes:
                          type: string
                        included_minutes_with_packs:
                          type: string
        default:
          description: error
          content:
            application/json:
              schema:
                type: object
                required:
                - message
                properties:
                  code:
                    type: integer
                    format: int64
                  message:
                    type: string
      summary: Get account build status
      x-summary-source: derived
components:
  securitySchemes:
    netlifyAuth:
      type: oauth2
      flows:
        implicit:
          scopes: {}
          authorizationUrl: https://app.netlify.com/authorize
externalDocs:
  url: https://www.netlify.com/docs/api/
  description: Online documentation
x-tagGroups:
- name: OAuth
  tags:
  - ticket
  - accessToken
- name: User accounts
  tags:
  - user
  - accountMembership
  - member
  - accountType
  - paymentMethod
  - auditLog
- name: Site
  tags:
  - site
  - environmentVariables
  - file
  - metadata
  - purge
  - snippet
- name: Domain names
  tags:
  - dnsZone
  - sniCertificate
- name: Deploys
  tags:
  - deploy
  - deployedBranch
  - deployKey
- name: Builds
  tags:
  - build
  - buildLogMsg
- name: Dev servers
  tags:
  - devServer
- name: Webhooks and notifications
  tags:
  - hook
  - hookType
  - buildHook
  - devServerHook
- name: Services
  tags:
  - service
  - serviceInstance
- name: Functions
  tags:
  - function
- name: Database
  tags:
  - database
- name: Forms
  tags:
  - form
  - submission
- name: Split tests
  tags:
  - splitTest
- name: Large media
  tags:
  - asset
  - assetPublicSignature