Netlify

Netlify Build API

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

GitHub OpenAPI

Operations 5

GET /sites/{site_id}/builds #
POST /sites/{site_id}/builds #
GET /builds/{build_id} #
POST /builds/{build_id}/start #
GET /{account_id}/builds/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:
  title: Netlify Build API
  termsOfService: https://www.netlify.com/legal/terms-of-use/
  x-logo:
    url: netlify-logo.png
    href: https://www.netlify.com/docs/
    altText: Netlify
  version: '1.0'
  description: 'Operations tagged Build across 2 of this provider''s published API definitions: netlify-build-api-openapi.yml, netlify-openapi-2.57.0-swagger.json. Each path carries the servers of the definition it was published in.'
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
    servers:
    - url: https://api.netlify.com/api/v1
    get:
      tags:
      - Build
      operationId: listSiteBuilds
      parameters:
      - name: site_id
        in: path
        required: true
        schema:
          type: string
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: per_page
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/build'
        default:
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
    post:
      tags:
      - Build
      operationId: createSiteBuild
      parameters:
      - name: site_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/buildSetup'
        required: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/build'
        default:
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      x-codegen-request-body-name: build
  /builds/{build_id}:
    parameters:
    - name: build_id
      in: path
      required: true
      schema:
        type: string
    servers:
    - url: https://api.netlify.com/api/v1
    get:
      tags:
      - Build
      operationId: getSiteBuild
      parameters:
      - name: build_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/build'
        default:
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
  /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
    servers:
    - url: https://api.netlify.com/api/v1
    post:
      tags:
      - Build
      operationId: notifyBuildStart
      parameters:
      - name: build_id
        in: path
        required: true
        schema:
          type: string
      - name: buildbot_version
        in: query
        schema:
          type: string
      - name: build_version
        in: query
        schema:
          type: string
      responses:
        '204':
          description: No content
          content: {}
        default:
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
  /{account_id}/builds/status:
    parameters:
    - name: account_id
      in: path
      required: true
      schema:
        type: string
    servers:
    - url: https://api.netlify.com/api/v1
    get:
      tags:
      - Build
      operationId: getAccountBuildStatus
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/buildStatus'
        default:
          description: error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
components:
  schemas:
    buildStatus:
      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
    buildSetup:
      type: object
      properties:
        image:
          type: string
        clear_cache:
          type: boolean
    error:
      required:
      - message
      type: object
      properties:
        code:
          type: integer
          format: int64
        message:
          type: string
    build:
      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
  securitySchemes:
    netlifyAuth:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://app.netlify.com/authorize
          scopes: {}
externalDocs:
  description: Online documentation
  url: https://www.netlify.com/docs/api/
x-refined-from:
- netlify-build-api-openapi.yml
- netlify-openapi-2.57.0-swagger.json
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: Forms
  tags:
  - form
  - submission
- name: Split tests
  tags:
  - splitTest
- name: Large media
  tags:
  - asset
  - assetPublicSignature
x-original-swagger-version: '2.0'