Netlify Service API
The service API from Netlify — 3 operation(s) for service.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/netlify-service-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
version: 2.57.0
title: Netlify's API documentation Service API
description: 'Netlify is a hosting service for the programmable web. It understands your documents and provides an API to handle atomic deploys of websites, manage form submissions, inject JavaScript snippets, and much more. This is a REST-style API that uses JSON for serialization and OAuth 2 for authentication.
This document is an OpenAPI reference for the Netlify API that you can explore. For more detailed instructions for common uses, please visit the [online documentation](https://www.netlify.com/docs/api/). Visit our Community forum to join the conversation about [understanding and using Netlify''s API](https://community.netlify.com/t/common-issue-understanding-and-using-netlifys-api/160).
Additionally, we have two API clients for your convenience:
- [Go Client](https://github.com/netlify/open-api#go-client)
- [JS Client](https://github.com/netlify/build/tree/main/packages/js-client)'
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: service
x-displayName: Service
paths:
/services/:
parameters:
- name: search
in: query
schema:
type: string
get:
operationId: getServices
tags:
- service
responses:
'200':
description: services
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
slug:
type: string
service_path:
type: string
long_description:
type: string
description:
type: string
events:
type: array
items:
type: object
tags:
type: array
items:
type: string
icon:
type: string
manifest_url:
type: string
environments:
type: array
items:
type: string
created_at:
type: string
format: dateTime
updated_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
/services/{addonName}:
parameters:
- name: addonName
in: path
required: true
schema:
type: string
get:
operationId: showService
tags:
- service
responses:
'200':
description: services
content:
application/json:
schema:
type: object
properties:
id:
type: string
name:
type: string
slug:
type: string
service_path:
type: string
long_description:
type: string
description:
type: string
events:
type: array
items:
type: object
tags:
type: array
items:
type: string
icon:
type: string
manifest_url:
type: string
environments:
type: array
items:
type: string
created_at:
type: string
format: dateTime
updated_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
/services/{addonName}/manifest:
parameters:
- name: addonName
in: path
required: true
schema:
type: string
get:
operationId: showServiceManifest
tags:
- service
responses:
'201':
description: retrieving from provider
content:
application/json:
schema:
type: object
default:
description: error
content:
application/json:
schema:
type: object
required:
- message
properties:
code:
type: integer
format: int64
message:
type: string
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