Skip to main content
Netlify logo

​
Overview

Add Netlify to any ModuleX agent or workflow. Web hosting and automation platform for modern web projects, interfacing with the Netlify REST API (api.netlify.com/api/v1).
Categories: Developer Tools & Infrastructure · Hosting · Ci Cd · Auth: OAuth2 · Actions: 4

​
Authentication

​
OAuth2 Authentication

Connect using Netlify OAuth (recommended)

​
Required Credentials

FieldDescriptionRequiredFormat
Client IDNetlify OAuth App Client IDYes-
Client SecretNetlify OAuth App Client SecretYes-

​
OAuth Configuration

  • Authorization URL: https://app.netlify.com/authorize
  • Token URL: https://api.netlify.com/oauth/token

​
Available Actions

​
Parameters

​
site_id
string
required
The Netlify site ID to retrieve information for

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Name"
    },
    "url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Url"
    },
    "ssl_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Ssl Url"
    },
    "admin_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Admin Url"
    },
    "state": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "State"
    },
    "created_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Created At"
    },
    "updated_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Updated At"
    },
    "default_domain": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Default Domain"
    },
    "custom_domain": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Custom Domain"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetSiteOutput",
  "type": "object"
}

​
Parameters

​
site_id
string
required
The Netlify site ID to list files for

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "files": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Files",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListFilesOutput",
  "type": "object"
}

​
Parameters

​
site_id
string
required
The Netlify site ID to list deploys for
​
max_results
integer
Maximum number of deploys to return
​
max_pages
integer
Maximum number of pages to fetch (1-500) (Default: 50)

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "deploys": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Deploys",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListSiteDeploysOutput",
  "type": "object"
}

​
Parameters

​
site_id
string
required
The Netlify site ID to rollback a deploy for
​
deploy_id
string
required
The deploy ID to restore

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "state": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "State"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Name"
    },
    "url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Url"
    },
    "ssl_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Ssl Url"
    },
    "created_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Created At"
    },
    "updated_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Updated At"
    }
  },
  "required": [
    "success"
  ],
  "title": "RollbackDeployOutput",
  "type": "object"
}

​
Limits & Quotas

  • Netlify API rate limit: 500 requests per minute per access token (as documented by Netlify).
  • Non-2xx responses and timeouts are caught and returned as success=False + error rather than raising.
  • Deploy operations (rollback) may take a few seconds to propagate.

Railway

Algolia

Amazon Web Services