Netlify

Netlify X-Internal API

The X-Internal API from Netlify — 3 operation(s) for x-internal.

GitHub OpenAPI

Operations 3

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

PUT /sites/{site_id}/plugins/{package} Pin a build plugin version · Update plugin #
Ask an LLM
“Can I pin a build plugin to a specific version on my site?”
“How is a build plugin's pinned version changed?”
Tell an agent
Pin plugin {package} on site {site} to version {version}.
Update build plugin {package} settings for site {site}.
GET /sites/{site_id}/plugin_runs/latest Get the latest build plugin runs · Get latest plugin runs #
Ask an LLM
“What happened the last time my build plugins ran?”
“Can I filter the latest plugin runs by state?”
Tell an agent
Get the latest runs of plugins {packages} on site {site}.
Show recent runs of {packages} on site {site} in state {state}.
POST /deploys/{deploy_id}/plugin_runs Record a build plugin run on a deploy · Create plugin run #
Ask an LLM
“How does a build plugin report its result on a deploy?”
“Can a plugin run include a summary and details text?”
Tell an agent
Record a run of plugin {package} on deploy {deploy}.
Log plugin {package} run on deploy {deploy} with state {state} and summary {summary}.

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://artifacts.apis.io/netlify/openapi/netlify-x-internal-api-openapi.yml
⚙
AsyncAPI
https://artifacts.apis.io/netlify/asyncapi/netlify-webhooks-asyncapi.yml

Other Resources

🔗
Overlay
https://artifacts.apis.io/netlify/overlays/netlify-x-internal-overlay.yaml
🔗
API Guides
https://docs.netlify.com/api-and-cli-guides/overview/
🔗
OpenAPI Source
https://github.com/netlify/open-api
🔗
GraphQL
https://artifacts.apis.io/netlify/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-x-internal-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-x-internal-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 2.57.0
  title: Netlify's API documentation X Internal 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: x Internal
paths:
  /sites/{site_id}/plugins/{package}:
    put:
      x-internal: true
      operationId: updatePlugin
      tags:
      - x Internal
      description: This is an internal-only endpoint.
      parameters:
      - name: site_id
        in: path
        required: true
        schema:
          type: string
      - name: package
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  package:
                    type: string
                  pinned_version:
                    type: string
        default:
          description: error
          content:
            application/json:
              schema:
                type: object
                required:
                - message
                properties:
                  code:
                    type: integer
                    format: int64
                  message:
                    type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                pinned_version:
                  type: string
      summary: Update plugin
      x-summary-source: derived
  /sites/{site_id}/plugin_runs/latest:
    get:
      x-internal: true
      operationId: getLatestPluginRuns
      tags:
      - x Internal
      description: This is an internal-only endpoint.
      parameters:
      - name: site_id
        in: path
        required: true
        schema:
          type: string
      - name: packages
        in: query
        required: true
        schema:
          type: array
          items:
            type: string
      - name: state
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  allOf:
                  - type: object
                    properties:
                      package:
                        type: string
                      version:
                        type: string
                      state:
                        type: string
                      reporting_event:
                        type: string
                      title:
                        type: string
                      summary:
                        type: string
                      text:
                        type: string
                  - type: object
                    properties:
                      deploy_id:
                        type: string
        default:
          description: error
          content:
            application/json:
              schema:
                type: object
                required:
                - message
                properties:
                  code:
                    type: integer
                    format: int64
                  message:
                    type: string
      summary: Get latest plugin runs
      x-summary-source: derived
  /deploys/{deploy_id}/plugin_runs:
    post:
      x-internal: true
      operationId: createPluginRun
      tags:
      - x Internal
      description: This is an internal-only endpoint.
      parameters:
      - name: deploy_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: CREATED
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    package:
                      type: string
                    version:
                      type: string
                    state:
                      type: string
                    reporting_event:
                      type: string
                    title:
                      type: string
                    summary:
                      type: string
                    text:
                      type: string
                - type: object
                  properties:
                    deploy_id:
                      type: string
        default:
          description: error
          content:
            application/json:
              schema:
                type: object
                required:
                - message
                properties:
                  code:
                    type: integer
                    format: int64
                  message:
                    type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                package:
                  type: string
                version:
                  type: string
                state:
                  type: string
                reporting_event:
                  type: string
                title:
                  type: string
                summary:
                  type: string
                text:
                  type: string
      summary: Create plugin run
      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
x-provenance:
  method: harvested
  publisher: Netlify
  source: https://open-api.netlify.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)