Update site with the Netlify API

Changes the name or the domains of a site and returns it. Only the fields sent change. The DNS of a new custom domain still has to point to Netlify.

Identifier
netlify_update_site

The request

POST https://connect.reportei.com/api/tools/netlify_update_site/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "site_id": "<site_id>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
site_idstringYesThe id of the site from List sites, or its domain, such as mysite.netlify.app.
namestringNoNew name of the site, which also changes its netlify.app address.
custom_domainstringNoMain custom domain, such as www.example.com.
domain_aliasesarrayNoOther custom domains of the site, replacing the current list.
force_sslbooleanNoRedirects every HTTP request to HTTPS, once the certificate is active.

Supported connections

Your customer connects their Netlify account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/netlify_update_site. It becomes your agent's tool definition with no conversion.

Other Netlify tools

See all 11 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.