Netlify API Documentation

This is the complete API documentation for connecting to the Netlify API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Netlify: Build websites, deploy apps, preview changes, and manage serverless functions. Keep reading to get started.

Quickstart

Before you run your first Netlify request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Netlify connection — create or choose one in Connections. Note its connectionId.

Every Netlify action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/netlify/latest/actions/{actionSlug}

You need a MindCloud API Key and a Netlify connection. Then call an action such as Get DNS for Site:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/netlify/latest/actions/get-dns-for-site" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Netlify account that should run the action. MindCloud stores and refreshes the Netlify credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

Netlify actions

All 30 published actions for this Netlify version. Each page documents the endpoint, arguments, and response controls.

• PUTCancel Site Deploy
• PUTConfigure DNS for Site
• POSTCreate Environment Variables
• POSTCreate Site
• POSTCreate Site Build Hook
• POSTCreate Site Deploy
• DELETEDelete Environment Variable
• DELETEDelete Site
• DELETEDelete Site Build Hook
• PUTDisable Site
• PUTEnable Site
• GETGet DNS for Site
• GETGet Environment Variable
• GETGet Site
• GETGet Site Build
• GETGet Site Deploy
• GETList Environment Variables
• GETList Form Submissions
• GETList Site Build Hooks
• GETList Site Builds
• GETList Site Deploys
• GETList Site Forms
• GETList Site Submissions
• GETList Sites
• PUTRestore Site Deploy
• PUTRollback Site Deploy
• GETSearch Site Functions
• PUTUpdate Environment Variable
• PUTUpdate Site
• PUTUpdate Site Build Hook

Related apps

More IT Operations apps on the Universal API, behind the same REST shape. Or browse all apps.

GitHubMySQLPostgreSQLFirebasePagerDutyGoogle Workspace AdminAdaloPDFMonkey