--- title: "Netlify" description: "Manage Netlify sites, deploy metadata, DNS, forms, functions and account resources through the official API. Your account permissions determine access. Each command performs one request; writes can deploy or remove resou" --- > Documentation Index > Fetch the complete documentation index at: https://help.tooluse.net/llms.txt > Use this file to discover all available pages before exploring further. # Netlify

Manage Netlify sites, deploy metadata, DNS, forms, functions and account resources through the official API. Your account permissions determine access. Each command performs one request; writes can deploy or remove resources and incur charges. Binary and multipart uploads are explicitly excluded.

What you can do (181)

What you can do

Available commands: 181 (79 read, 102 write). Enable only the commands your application needs.

Command Effect
List sites — netlify.listsites Read
Create a site — netlify.createsite Write
Get a site — netlify.getsite Read
Update a site — netlify.updatesite Write
Delete a site — netlify.deletesite Write
Provision or update a site's TLS certificate — netlify.provisionsitetlscertificate Write
Get a site's TLS certificate — netlify.showsitetlscertificate Read
List TLS certificates for a site's domain — netlify.getallcertificates Read
List environment variables for a team or site — netlify.getenvvars Read
Create environment variables — netlify.createenvvars Write
List environment variables for a site — netlify.getsiteenvvars Read
Get an environment variable — netlify.getenvvar Read
Update an environment variable — netlify.updateenvvar Write
Set a value on an environment variable — netlify.setenvvarvalue Write
Delete an environment variable — netlify.deleteenvvar Write
Delete an environment variable value — netlify.deleteenvvarvalue Write
Search a site's functions — netlify.searchsitefunctions Read
List a site's forms — netlify.listsiteforms Read
Delete a form — netlify.deletesiteform Write
List a site's form submissions — netlify.listsitesubmissions Read
List a site's files — netlify.listsitefiles Read
List a site's assets — netlify.listsiteassets Read
Create a site asset — netlify.createsiteasset Write
Get a site asset — netlify.getsiteassetinfo Read
Update a site asset's state — netlify.updatesiteasset Write
Delete a site asset — netlify.deletesiteasset Write
Get a site asset's URL — netlify.getsiteassetpublicsignature Read
Get a site file by path — netlify.getsitefilebypathname Read
Purge cached content — netlify.purgecache Write
List a site's snippets — netlify.listsitesnippets Read
Create a snippet — netlify.createsitesnippet Write
Get a snippet — netlify.getsitesnippet Read
Update a snippet — netlify.updatesitesnippet Write
Delete a snippet — netlify.deletesitesnippet Write
Get a site's metadata — netlify.getsitemetadata Read
Update a site's metadata — netlify.updatesitemetadata Write
List a site's build hooks — netlify.listsitebuildhooks Read
Create a build hook — netlify.createsitebuildhook Write
Get a build hook — netlify.getsitebuildhook Read
Update a build hook — netlify.updatesitebuildhook Write
Delete a build hook — netlify.deletesitebuildhook Write
List a site's deploys — netlify.listsitedeploys Read
Get a site's deploy — netlify.getsitedeploy Read
Delete a site's deploy — netlify.deletesitedeploy Write
Cancel a deploy — netlify.cancelsitedeploy Write
Restore a previous deploy — netlify.restoresitedeploy Write
List a site's builds — netlify.listsitebuilds Read
List a site's deployed branches — netlify.listsitedeployedbranches Read
Unlink a site's repository — netlify.unlinksiterepo Write
Enable a site — netlify.enablesite Write
Disable a site — netlify.disablesite Write
Get a build — netlify.getsitebuild Read
Add a message to a build log — netlify.updatesitebuildlog Write
Mark a build as started — netlify.notifybuildstart Write
Get a team's build status — netlify.getaccountbuildstatus Read
Get a site's DNS configuration — netlify.getdnsforsite Read
Configure a site's DNS — netlify.configurednsforsite Write
Roll back a site's production deploy — netlify.rollbacksitedeploy Write
Get a deploy — netlify.getdeploy Read
Delete a deploy — netlify.deletedeploy Write
Update a deploy's validations report — netlify.updatedeployvalidations Write
Lock a deploy — netlify.lockdeploy Write
Unlock a deploy — netlify.unlockdeploy Write
Update a site's build plugin — netlify.updateplugin Write
List a site's latest build plugin runs — netlify.getlatestpluginruns Read
Create a build plugin run — netlify.createpluginrun Write
List a form's submissions — netlify.listformsubmissions Read
List a site's outgoing hooks — netlify.listhooksbysiteid Read
Create an outgoing hook — netlify.createhookbysiteid Write
Get an outgoing hook — netlify.gethook Read
Update an outgoing hook — netlify.updatehook Write
Delete an outgoing hook — netlify.deletehook Write
Re-enable an outgoing hook — netlify.enablehook Write
List outgoing hook types — netlify.listhooktypes Read
Create an OAuth ticket — netlify.createticket Write
Get an OAuth ticket — netlify.showticket Read
Exchange an OAuth ticket for an access token — netlify.exchangeticket Write
List deploy keys — netlify.listdeploykeys Read
Create a deploy key — netlify.createdeploykey Write
Get a deploy key — netlify.getdeploykey Read
Delete a deploy key — netlify.deletedeploykey Write
Create a site in a team — netlify.createsiteinteam Write
List a team's sites — netlify.listsitesforaccount Read
List a team's members — netlify.listmembersforaccount Read
Add a member to a team — netlify.addmembertoaccount Write
Get a team member — netlify.getaccountmember Read
Update a team member — netlify.updateaccountmember Write
Remove a team member — netlify.removeaccountmember Write
List payment methods — netlify.listpaymentmethodsforuser Read
List plans available for new teams — netlify.listaccounttypesforuser Read
List the current user's teams — netlify.listaccountsforuser Read
Create a team — netlify.createaccount Write
Get a team — netlify.getaccount Read
Update a team — netlify.updateaccount Write
Cancel a team — netlify.cancelaccount Write
List a team's audit log events — netlify.listaccountauditevents Read
List a site's agent runs — netlify.listagentrunners Read
Start an agent run — netlify.createagentrunner Write
Start an agent run on a site — netlify.createsiteagentrunner Write
Create an upload URL for agent run files — netlify.createagentrunneruploadurl Write
Get an agent run — netlify.getagentrunner Read
Update an agent run — netlify.updateagentrunner Write
Stop an agent run (alias) — netlify.deleteagentrunner Write
Stop an agent run — netlify.stopagentrunner Write
Get an agent run's diff — netlify.getagentrunnerdiff Read
Archive an agent run — netlify.archiveagentrunner Write
Open a pull request from an agent run — netlify.agentrunnerpullrequest Write
Commit an agent run's changes to a branch — netlify.agentrunnercommittobranch Write
List an agent run's sessions — netlify.listagentrunnersessions Read
Start a follow-up agent run session — netlify.createagentrunnersession Write
Get an agent run session — netlify.getagentrunnersession Read
Update an agent run session — netlify.updateagentrunnersession Write
Stop an agent run session (alias) — netlify.deleteagentrunnersession Write
Stop an agent run session — netlify.stopagentrunnersession Write
Answer an agent run session's pending interaction — netlify.answeragentrunnersession Write
Get a form submission — netlify.listformsubmission Read
Delete a form submission — netlify.deletesubmission Write
List a site's add-on instances — netlify.listserviceinstancesforsite Read
Create an add-on instance — netlify.createserviceinstance Write
Get an add-on instance — netlify.showserviceinstance Read
Update an add-on instance — netlify.updateserviceinstance Write
Delete an add-on instance — netlify.deleteserviceinstance Write
Get an Identity user — netlify.getidentityuser Read
Look up an Identity user by email — netlify.lookupidentityuser Write
List add-on services — netlify.getservices Read
Get an add-on service — netlify.showservice Read
Get an add-on service's manifest — netlify.showservicemanifest Read
Get the current user — netlify.getcurrentuser Read
Create a split test — netlify.createsplittest Write
List a site's split tests — netlify.getsplittests Read
Update a split test — netlify.updatesplittest Write
Get a split test — netlify.getsplittest Read
Publish a split test — netlify.enablesplittest Write
Unpublish a split test — netlify.disablesplittest Write
Create a DNS zone — netlify.creatednszone Write
List DNS zones — netlify.getdnszones Read
Get a DNS zone — netlify.getdnszone Read
Delete a DNS zone — netlify.deletednszone Write
Transfer a DNS zone to another team — netlify.transferdnszone Write
List a DNS zone's records — netlify.getdnsrecords Read
Create a DNS record — netlify.creatednsrecord Write
Get a DNS record — netlify.getindividualdnsrecord Read
Delete a DNS record — netlify.deletednsrecord Write
List a site's dev servers — netlify.listsitedevservers Read
Start a dev server — netlify.createsitedevserver Write
Stop a branch's dev servers — netlify.deletesitedevservers Write
Get a dev server — netlify.getsitedevserver Read
Record dev server activity — netlify.markdevserveractivity Write
Update a dev server's state — netlify.updatedevserverstate Write
List a site's dev server hooks — netlify.listsitedevserverhooks Read
Create a dev server hook — netlify.createsitedevserverhook Write
Get a dev server hook — netlify.getsitedevserverhook Read
Update a dev server hook — netlify.updatesitedevserverhook Write
Delete a dev server hook — netlify.deletesitedevserverhook Write
List a site's agent runner hooks — netlify.listsiteagentrunnerhooks Read
Create an agent runner hook — netlify.createsiteagentrunnerhook Write
Get an agent runner hook — netlify.getsiteagentrunnerhook Read
Update an agent runner hook — netlify.updatesiteagentrunnerhook Write
Delete an agent runner hook — netlify.deletesiteagentrunnerhook Write
List AI Gateway providers and models — netlify.getaigatewayproviders Read
Get a site's AI Gateway token — netlify.getaigatewaytoken Read
Get a team's AI Gateway token — netlify.getaccountaigatewaytoken Read
Create a site database — netlify.createsitedatabase Write
Get a site database — netlify.getsitedatabase Read
Delete a site database — netlify.deletesitedatabase Write
Create a database branch — netlify.createsitedatabasebranch Write
List database branches — netlify.listsitedatabasebranches Read
Get a database branch — netlify.getsitedatabasebranch Read
Delete a database branch — netlify.deletesitedatabasebranch Write
Reset a database branch — netlify.resetsitedatabasebranch Write
Set a database branch's compute settings — netlify.setsitedatabasebranchcomputesettings Write
Set database compute settings — netlify.setsitedatabasecomputesettings Write
Get database compute settings — netlify.getsitedatabasecomputesettings Read
Reset database compute settings to defaults — netlify.clearsitedatabasecomputesettings Write
List database migrations — netlify.listsitedatabasemigrations Read
Get a database migration — netlify.getsitedatabasemigration Read
Run database migrations for a deploy — netlify.runsitedatabasemigrations Write
Create a database snapshot — netlify.createsitedatabasesnapshot Write
List database snapshots — netlify.listsitedatabasesnapshots Read
Delete a database snapshot — netlify.deletesitedatabasesnapshot Write
Restore a database snapshot — netlify.restoresitedatabasesnapshot Write

Connect and use

Connect and use

Open the integration's connection form to check the available credential source. The source has not been resolved for this documentation export. The instructions below apply when using your own provider account.

Get your provider credentials

Follow these steps for Netlify, then enter the issued values in the connection form below.

  1. In Netlify, open User settings → Applications → Personal access tokens → New access token. Name the token, set an expiry, and allow your SAML team only if needed. Copy it into the Netlify personal access token field in this connection. Choose commands, save, and create a Tooluse.net API key for your client. Site and deploy changes can affect production and billing. A password reset invalidates existing Netlify tokens.

Official credential setup

Where to enter credentials

In the integration page, sign in, choose your workspace and open Connect. If a Credentials choice is shown, select Use my credentials. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.

Connection field Requirement
Netlify personal access token Required

Open API keys and create a Tooluse.net key for the enabled commands.

Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.

Configure Claude Code, Codex or Cursor once

Permissions and results

If you have more than one workspace, check the selected workspace in the connection or API-key dialog before saving. Roles, enabled commands, expiry and revocation use Tooluse.net's existing permissions. Disabling a connection or revoking a key immediately prevents new calls.

Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.

Your connection's daily allowance and key permissions also apply. Adding a connection does not make a provider request.

Calls return the shared execution receipt and a Claude tool_result. Provider output varies by operation; consult the provider documentation for its response fields. Unconfirmed calls should be checked before retrying.

Call from your client

Use the shared MCP configuration. Refresh your client's tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.

Configure Claude Code, Codex or Cursor once

Discover your enabled tools

List permitted tools in Claude format. Read every page using page and size (maximum 100) until all results have been received. Use the returned name, not a catalog capability identifier, in the tool_use block.

curl 'https://api.tooluse.net/v1/tools' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY"

Find this command in the tool list permitted by your key. Replace svc_FROM_YOUR_TOOL_LIST with its returned name. Use a new Idempotency-Key for each new call and retain it when retrying that same call.

HTTP call

curl 'https://api.tooluse.net/v1/tool-calls' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: replace-with-a-new-call-id' \
  --data '{
  "type": "tool_use",
  "id": "toolu_example",
  "name": "svc_FROM_YOUR_TOOL_LIST",
  "input": {}
}'

Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.

Commands

List sites — netlify.listsites

Run List sites with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.name string Optional
query.filter string Optional enum: ["all","owner","guest"]
query.page integer Optional
query.per_page integer Optional

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a site — netlify.createsite

Run Create a site with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.configure_dns boolean Optional
body — Required $ref: "#/definitions/siteSetup"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a site — netlify.getsite

Run Get a site with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
query object Optional additionalProperties: false
query.feature_flags string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a site — netlify.updatesite

Run Update a site with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
body — Required $ref: "#/definitions/siteSetup"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a site — netlify.deletesite

Run Delete a site with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Provision or update a site's TLS certificate — netlify.provisionsitetlscertificate

Run Provision or update a site's TLS certificate with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
query object Optional additionalProperties: false
query.certificate string Optional PEM-encoded certificate. Required when updating an existing certificate.
query.key string Optional PEM-encoded private key. Required when updating an existing certificate.
query.ca_certificates string Optional PEM-encoded CA certificate chain. Required when updating an existing certificate.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a site's TLS certificate — netlify.showsitetlscertificate

Run Get a site's TLS certificate with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List TLS certificates for a site's domain — netlify.getallcertificates

Run List TLS certificates for a site's domain with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
query object Required additionalProperties: false
query.domain string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  },
  "query": {
    "domain": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List environment variables for a team or site — netlify.getenvvars

Run List environment variables for a team or site with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Scope response to account_id
query object Optional additionalProperties: false
query.context_name string Optional Filter by deploy context enum: ["all","dev","dev-server","branch-deploy","deploy-preview","production"]
query.scope string Optional Filter by scope enum: ["builds","functions","runtime","post-processing"]
query.site_id string Optional If specified, only return environment variables set on this site

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create environment variables — netlify.createenvvars

Run Create environment variables with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Scope response to account_id
query object Optional additionalProperties: false
query.site_id string Optional If provided, create an environment variable on the site level, not the account level
body array Optional
body[] object Optional
body[].key string Optional The existing or new name of the key, if you wish to rename it (case-sensitive)
body[].scopes array Optional The scopes that this environment variable is set to (Pro plans and above)
body[].scopes[] string Optional enum: ["builds","functions","runtime","post-processing"]
body[].values array Optional
body[].values[] — Optional $ref: "#/definitions/envVarValue"
body[].is_secret boolean Optional Secret values are only readable by code running on Netlify's systems. With secrets, only the local development context values are readable from the UI, API, and CLI. By default, environment variable values are not secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List environment variables for a site — netlify.getsiteenvvars

Run List environment variables for a site with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.context_name string Optional Filter by deploy context enum: ["all","dev","dev-server","branch-deploy","deploy-preview","production"]
query.scope string Optional Filter by scope enum: ["builds","functions","runtime","post_processing"]
path object Required additionalProperties: false
path.site_id string Required Scope response to site_id

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an environment variable — netlify.getenvvar

Run Get an environment variable with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Scope response to account_id
path.key string Required The environment variable key (case-sensitive)
query object Optional additionalProperties: false
query.site_id string Optional If provided, return the environment variable for a specific site (no merging is performed)

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "key": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an environment variable — netlify.updateenvvar

Run Update an environment variable with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Scope response to account_id
path.key string Required The existing environment variable key name (case-sensitive)
query object Optional additionalProperties: false
query.site_id string Optional If provided, update an environment variable set on this site
body object Optional
body.key string Optional The existing or new name of the key, if you wish to rename it (case-sensitive)
body.scopes array Optional The scopes that this environment variable is set to (Pro plans and above)
body.scopes[] string Optional enum: ["builds","functions","runtime","post-processing"]
body.values array Optional
body.values[] — Optional $ref: "#/definitions/envVarValue"
body.is_secret boolean Optional Secret values are only readable by code running on Netlify's systems. With secrets, only the local development context values are readable from the UI, API, and CLI. By default, environment variable values are not secret.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "key": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set a value on an environment variable — netlify.setenvvarvalue

Run Set a value on an environment variable with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Scope response to account_id
path.key string Required The existing environment variable key name (case-sensitive)
query object Optional additionalProperties: false
query.site_id string Optional If provided, update an environment variable set on this site
body object Optional
body.context string Optional The deploy context in which this value will be used. dev refers to local development when running netlify dev. branch must be provided with a value in context_parameter. enum: ["all","dev","dev-server","branch-deploy","deploy-preview","production","branch"]
body.context_parameter string Optional An additional parameter for custom branches. Currently, this is used for providing a branch name when context=branch.
body.value string Optional The environment variable's unencrypted value

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "key": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an environment variable — netlify.deleteenvvar

Run Delete an environment variable with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Scope response to account_id
path.key string Required The environment variable key (case-sensitive)
query object Optional additionalProperties: false
query.site_id string Optional If provided, delete the environment variable from this site

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "key": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an environment variable value — netlify.deleteenvvarvalue

Run Delete an environment variable value with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required Scope response to account_id
path.id string Required The environment variable value's ID
path.key string Required The environment variable key name (case-sensitive)
query object Optional additionalProperties: false
query.site_id string Optional If provided, delete the value from an environment variable on this site

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example",
    "id": "example",
    "key": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search a site's functions — netlify.searchsitefunctions

Run Search a site's functions with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
query object Optional additionalProperties: false
query.filter string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a site's forms — netlify.listsiteforms

Run List a site's forms with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a form — netlify.deletesiteform

Run Delete a form with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.form_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "form_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a site's form submissions — netlify.listsitesubmissions

Run List a site's form submissions with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
query object Optional additionalProperties: false
query.page integer Optional
query.per_page integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a site's files — netlify.listsitefiles

Run List a site's files with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a site's assets — netlify.listsiteassets

Run List a site's assets with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a site asset — netlify.createsiteasset

Run Create a site asset with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
query object Required additionalProperties: false
query.name string Required
query.size integer Required
query.content_type string Required
query.visibility string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  },
  "query": {
    "name": "example",
    "size": 1,
    "content_type": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a site asset — netlify.getsiteassetinfo

Run Get a site asset with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.asset_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "asset_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a site asset's state — netlify.updatesiteasset

Run Update a site asset's state with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.asset_id string Required
query object Required additionalProperties: false
query.state string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "asset_id": "example"
  },
  "query": {
    "state": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a site asset — netlify.deletesiteasset

Run Delete a site asset with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.asset_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "asset_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a site asset's URL — netlify.getsiteassetpublicsignature

Run Get a site asset's URL with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.asset_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "asset_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a site file by path — netlify.getsitefilebypathname

Run Get a site file by path with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.file_path string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "file_path": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Purge cached content — netlify.purgecache

Run Purge cached content with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/purge"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a site's snippets — netlify.listsitesnippets

Run List a site's snippets with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a snippet — netlify.createsitesnippet

Run Create a snippet with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
body — Required $ref: "#/definitions/snippet"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a snippet — netlify.getsitesnippet

Run Get a snippet with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.snippet_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "snippet_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a snippet — netlify.updatesitesnippet

Run Update a snippet with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.snippet_id string Required
body — Required $ref: "#/definitions/snippet"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "snippet_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a snippet — netlify.deletesitesnippet

Run Delete a snippet with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.snippet_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "snippet_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a site's metadata — netlify.getsitemetadata

Run Get a site's metadata with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a site's metadata — netlify.updatesitemetadata

Run Update a site's metadata with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
body — Required $ref: "#/definitions/metadata"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a site's build hooks — netlify.listsitebuildhooks

Run List a site's build hooks with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a build hook — netlify.createsitebuildhook

Run Create a build hook with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
body — Required $ref: "#/definitions/buildHookSetup"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a build hook — netlify.getsitebuildhook

Run Get a build hook with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a build hook — netlify.updatesitebuildhook

Run Update a build hook with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.id string Required
body — Required $ref: "#/definitions/buildHookSetup"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a build hook — netlify.deletesitebuildhook

Run Delete a build hook with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a site's deploys — netlify.listsitedeploys

Run List a site's deploys with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
query object Optional additionalProperties: false
query.deploy-previews boolean Optional
query.production boolean Optional
query.state string Optional enum: ["new","pending_review","accepted","rejected","enqueued","building","uploading","uploaded","preparing","prepared","processing","processed","ready","error","retrying"]
query.branch string Optional
query.latest-published boolean Optional
query.page integer Optional
query.per_page integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a site's deploy — netlify.getsitedeploy

Run Get a site's deploy with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.deploy_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "deploy_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a site's deploy — netlify.deletesitedeploy

Run Delete a site's deploy with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.deploy_id string Required
path.site_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "deploy_id": "example",
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Cancel a deploy — netlify.cancelsitedeploy

Run Cancel a deploy with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.deploy_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "deploy_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Restore a previous deploy — netlify.restoresitedeploy

Run Restore a previous deploy with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.deploy_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "deploy_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a site's builds — netlify.listsitebuilds

Run List a site's builds with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
query object Optional additionalProperties: false
query.page integer Optional
query.per_page integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a site's deployed branches — netlify.listsitedeployedbranches

Run List a site's deployed branches with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Unlink a site's repository — netlify.unlinksiterepo

Run Unlink a site's repository with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Enable a site — netlify.enablesite

Run Enable a site with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Disable a site — netlify.disablesite

Run Disable a site with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
query object Required additionalProperties: false
query.reason string Required Reason for disabling the site

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  },
  "query": {
    "reason": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a build — netlify.getsitebuild

Run Get a build with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.build_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "build_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add a message to a build log — netlify.updatesitebuildlog

Run Add a message to a build log with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.build_id string Required
body — Required $ref: "#/definitions/buildLogMsg"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "build_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Mark a build as started — netlify.notifybuildstart

Run Mark a build as started with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.build_id string Required
query object Optional additionalProperties: false
query.buildbot_version string Optional
query.build_version string Optional
query.task_id string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "build_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a team's build status — netlify.getaccountbuildstatus

Run Get a team's build status with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a site's DNS configuration — netlify.getdnsforsite

Run Get a site's DNS configuration with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Configure a site's DNS — netlify.configurednsforsite

Run Configure a site's DNS with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Roll back a site's production deploy — netlify.rollbacksitedeploy

Run Roll back a site's production deploy with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a deploy — netlify.getdeploy

Run Get a deploy with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.deploy_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "deploy_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a deploy — netlify.deletedeploy

Run Delete a deploy with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.deploy_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "deploy_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a deploy's validations report — netlify.updatedeployvalidations

Run Update a deploy's validations report with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.deploy_id string Required The ID of the deploy
body object Required
body.secrets_scan object Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "deploy_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Lock a deploy — netlify.lockdeploy

Run Lock a deploy with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.deploy_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "deploy_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Unlock a deploy — netlify.unlockdeploy

Run Unlock a deploy with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.deploy_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "deploy_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a site's build plugin — netlify.updateplugin

Run Update a site's build plugin with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.package string Required
body — Optional $ref: "#/definitions/pluginParams"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "package": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a site's latest build plugin runs — netlify.getlatestpluginruns

Run List a site's latest build plugin runs with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
query object Required additionalProperties: false
query.packages array Required
query.packages[] string Optional
query.state string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  },
  "query": {
    "packages": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a build plugin run — netlify.createpluginrun

Run Create a build plugin run with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.deploy_id string Required
body — Optional $ref: "#/definitions/pluginRunData"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "deploy_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a form's submissions — netlify.listformsubmissions

Run List a form's submissions with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.form_id string Required
query object Optional additionalProperties: false
query.page integer Optional
query.per_page integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "form_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a site's outgoing hooks — netlify.listhooksbysiteid

Run List a site's outgoing hooks with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.site_id string Required
query.form_id string Optional Only return hooks attached to this form.
query.event string Optional Only return hooks for this event name.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an outgoing hook — netlify.createhookbysiteid

Run Create an outgoing hook with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.site_id string Required
body — Required $ref: "#/definitions/hook"

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "site_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an outgoing hook — netlify.gethook

Run Get an outgoing hook with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.hook_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "hook_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an outgoing hook — netlify.updatehook

Run Update an outgoing hook with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.hook_id string Required
body — Required $ref: "#/definitions/hook"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "hook_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an outgoing hook — netlify.deletehook

Run Delete an outgoing hook with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.hook_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "hook_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Re-enable an outgoing hook — netlify.enablehook

Run Re-enable an outgoing hook with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.hook_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "hook_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List outgoing hook types — netlify.listhooktypes

Run List outgoing hook types with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.site_id string Optional Only return the hook types available to this site.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an OAuth ticket — netlify.createticket

Run Create an OAuth ticket with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.client_id string Required
body object Optional
body.message string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "client_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an OAuth ticket — netlify.showticket

Run Get an OAuth ticket with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ticket_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ticket_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Exchange an OAuth ticket for an access token — netlify.exchangeticket

Run Exchange an OAuth ticket for an access token with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ticket_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ticket_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List deploy keys — netlify.listdeploykeys

Run List deploy keys with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a deploy key — netlify.createdeploykey

Run Create a deploy key with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a deploy key — netlify.getdeploykey

Run Get a deploy key with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.key_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "key_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a deploy key — netlify.deletedeploykey

Run Delete a deploy key with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.key_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "key_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a site in a team — netlify.createsiteinteam

Run Create a site in a team with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.configure_dns boolean Optional
path object Required additionalProperties: false
path.account_slug string Required
body — Optional $ref: "#/definitions/siteSetup"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_slug": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a team's sites — netlify.listsitesforaccount

Run List a team's sites with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.name string Optional
query.page integer Optional
query.per_page integer Optional
path object Required additionalProperties: false
path.account_slug string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_slug": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a team's members — netlify.listmembersforaccount

Run List a team's members with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_slug string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_slug": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add a member to a team — netlify.addmembertoaccount

Run Add a member to a team with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_slug string Required
body — Required $ref: "#/definitions/accountAddMemberSetup"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_slug": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a team member — netlify.getaccountmember

Run Get a team member with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_slug string Required
path.member_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_slug": "example",
    "member_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a team member — netlify.updateaccountmember

Run Update a team member with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_slug string Required
path.member_id string Required
body — Required $ref: "#/definitions/accountUpdateMemberSetup"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_slug": "example",
    "member_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove a team member — netlify.removeaccountmember

Run Remove a team member with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_slug string Required
path.member_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_slug": "example",
    "member_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List payment methods — netlify.listpaymentmethodsforuser

Run List payment methods with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List plans available for new teams — netlify.listaccounttypesforuser

Run List plans available for new teams with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List the current user's teams — netlify.listaccountsforuser

Run List the current user's teams with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.minimal boolean Optional

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a team — netlify.createaccount

Run Create a team with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/accountSetup"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "name": "example",
    "type_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a team — netlify.getaccount

Run Get a team with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a team — netlify.updateaccount

Run Update a team with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
body — Optional $ref: "#/definitions/accountUpdateSetup"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Cancel a team — netlify.cancelaccount

Run Cancel a team with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a team's audit log events — netlify.listaccountauditevents

Run List a team's audit log events with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required
query object Optional additionalProperties: false
query.query string Optional
query.log_type string Optional
query.page integer Optional
query.per_page integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a site's agent runs — netlify.listagentrunners

Run List a site's agent runs with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.site_id string Required
query.account_id string Required
query.page integer Optional
query.per_page integer Optional
query.state string Optional Only runs in this state: new, running, await_input, interrupted, error, done, cancelled or archived.
query.title string Optional
query.branch string Optional
query.result_branch string Optional
query.user_id string Optional Only runs started by this user.
query.from integer Optional Unix timestamp. Only runs created at or after this time.
query.to integer Optional Unix timestamp. Only runs created before this time.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "site_id": "example",
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Start an agent run — netlify.createagentrunner

Run Start an agent run with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.site_id string Required
query.deploy_id string Optional
query.branch string Optional
query.prompt string Optional
query.agent string Optional
query.model string Optional
query.parent_agent_runner_id string Optional
query.dev_server_image string Optional
query.file_keys array Optional
query.file_keys[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Start an agent run on a site — netlify.createsiteagentrunner

Run Start an agent run on a site with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required The site's ID or one of its hostnames.
body — Required $ref: "#/definitions/agentRunnerSetup"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  },
  "body": {
    "prompt": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an upload URL for agent run files — netlify.createagentrunneruploadurl

Run Create an upload URL for agent run files with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.account_id string Required
query.filename string Required
query.content_type string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "account_id": "example",
    "filename": "example",
    "content_type": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an agent run — netlify.getagentrunner

Run Get an agent run with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.agent_runner_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "agent_runner_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an agent run — netlify.updateagentrunner

Run Update an agent run with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.agent_runner_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "agent_runner_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Stop an agent run (alias) — netlify.deleteagentrunner

Run Stop an agent run (alias) with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.agent_runner_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "agent_runner_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Stop an agent run — netlify.stopagentrunner

Run Stop an agent run with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.agent_runner_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "agent_runner_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an agent run's diff — netlify.getagentrunnerdiff

Run Get an agent run's diff with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.agent_runner_id string Required
query object Optional additionalProperties: false
query.page integer Optional
query.per_page integer Optional
query.strip_binary boolean Optional Replace binary file contents with a placeholder, keeping the file headers.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "agent_runner_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Archive an agent run — netlify.archiveagentrunner

Run Archive an agent run with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.agent_runner_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "agent_runner_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Open a pull request from an agent run — netlify.agentrunnerpullrequest

Run Open a pull request from an agent run with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.agent_runner_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "agent_runner_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Commit an agent run's changes to a branch — netlify.agentrunnercommittobranch

Run Commit an agent run's changes to a branch with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.agent_runner_id string Required
query object Required additionalProperties: false
query.target_branch string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "agent_runner_id": "example"
  },
  "query": {
    "target_branch": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List an agent run's sessions — netlify.listagentrunnersessions

Run List an agent run's sessions with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.agent_runner_id string Required
query object Optional additionalProperties: false
query.page integer Optional
query.per_page integer Optional
query.state string Optional Only sessions in this state: new, running, await_input, interrupted, error, done or cancelled.
query.from integer Optional Unix timestamp. Only sessions created at or after this time.
query.to integer Optional Unix timestamp. Only sessions created before this time.
query.order_by string Optional enum: ["asc","desc"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "agent_runner_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Start a follow-up agent run session — netlify.createagentrunnersession

Run Start a follow-up agent run session with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.agent_runner_id string Required
query object Optional additionalProperties: false
query.prompt string Optional Use the request body instead.
query.agent string Optional Use the request body instead.
query.model string Optional Use the request body instead.
query.file_keys array Optional Use the request body instead.
query.file_keys[] string Optional
body — Optional $ref: "#/definitions/agentRunnerSessionSetup"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "agent_runner_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an agent run session — netlify.getagentrunnersession

Run Get an agent run session with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.agent_runner_id string Required
path.agent_runner_session_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "agent_runner_id": "example",
    "agent_runner_session_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an agent run session — netlify.updateagentrunnersession

Run Update an agent run session with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.agent_runner_id string Required
path.agent_runner_session_id string Required
query object Optional additionalProperties: false
query.is_published boolean Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "agent_runner_id": "example",
    "agent_runner_session_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Stop an agent run session (alias) — netlify.deleteagentrunnersession

Run Stop an agent run session (alias) with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.agent_runner_id string Required
path.agent_runner_session_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "agent_runner_id": "example",
    "agent_runner_session_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Stop an agent run session — netlify.stopagentrunnersession

Run Stop an agent run session with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.agent_runner_id string Required
path.agent_runner_session_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "agent_runner_id": "example",
    "agent_runner_session_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Answer an agent run session's pending interaction — netlify.answeragentrunnersession

Run Answer an agent run session's pending interaction with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.agent_runner_id string Required
path.agent_runner_session_id string Required
body — Required $ref: "#/definitions/agentRunnerSessionAnswer"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "agent_runner_id": "example",
    "agent_runner_session_id": "example"
  },
  "body": {
    "refId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a form submission — netlify.listformsubmission

Run Get a form submission with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.submission_id string Required
query object Optional additionalProperties: false
query.query string Optional
query.page integer Optional
query.per_page integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "submission_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a form submission — netlify.deletesubmission

Run Delete a form submission with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.submission_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "submission_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a site's add-on instances — netlify.listserviceinstancesforsite

Run List a site's add-on instances with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an add-on instance — netlify.createserviceinstance

Run Create an add-on instance with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.addon string Required
body object Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "addon": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an add-on instance — netlify.showserviceinstance

Run Get an add-on instance with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.addon string Required
path.instance_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "addon": "example",
    "instance_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an add-on instance — netlify.updateserviceinstance

Run Update an add-on instance with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.addon string Required
path.instance_id string Required
body object Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "addon": "example",
    "instance_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an add-on instance — netlify.deleteserviceinstance

Run Delete an add-on instance with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.addon string Required
path.instance_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "addon": "example",
    "instance_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an Identity user — netlify.getidentityuser

Run Get an Identity user with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.identity_id string Required The site's Identity instance ID, returned as identity_instance_id by getSite.
path.user_id string Required The Identity user's UUID.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "identity_id": "example",
    "user_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Look up an Identity user by email — netlify.lookupidentityuser

Run Look up an Identity user by email with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.identity_id string Required The site's Identity instance ID, returned as identity_instance_id by getSite.
body object Required
body.email string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "identity_id": "example"
  },
  "body": {
    "email": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List add-on services — netlify.getservices

Run List add-on services with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.search string Optional

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an add-on service — netlify.showservice

Run Get an add-on service with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.addonName string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "addonName": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an add-on service's manifest — netlify.showservicemanifest

Run Get an add-on service's manifest with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.addonName string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "addonName": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the current user — netlify.getcurrentuser

Run Get the current user with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a split test — netlify.createsplittest

Run Create a split test with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
body — Required $ref: "#/definitions/splitTestSetup"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a site's split tests — netlify.getsplittests

Run List a site's split tests with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a split test — netlify.updatesplittest

Run Update a split test with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.split_test_id string Required
body — Required $ref: "#/definitions/splitTestSetup"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "split_test_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a split test — netlify.getsplittest

Run Get a split test with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.split_test_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "split_test_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Publish a split test — netlify.enablesplittest

Run Publish a split test with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.split_test_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "split_test_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Unpublish a split test — netlify.disablesplittest

Run Unpublish a split test with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.split_test_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "split_test_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a DNS zone — netlify.creatednszone

Run Create a DNS zone with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/dnsZoneSetup"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List DNS zones — netlify.getdnszones

Run List DNS zones with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.account_slug string Optional

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a DNS zone — netlify.getdnszone

Run Get a DNS zone with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a DNS zone — netlify.deletednszone

Run Delete a DNS zone with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Transfer a DNS zone to another team — netlify.transferdnszone

Run Transfer a DNS zone to another team with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required
query object Required additionalProperties: false
query.account_id string Required the account of the dns zone
query.transfer_account_id string Required the account you want to transfer the dns zone to
query.transfer_user_id string Required the user you want to transfer the dns zone to

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  },
  "query": {
    "account_id": "example",
    "transfer_account_id": "example",
    "transfer_user_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a DNS zone's records — netlify.getdnsrecords

Run List a DNS zone's records with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a DNS record — netlify.creatednsrecord

Run Create a DNS record with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required
body — Required $ref: "#/definitions/dnsRecordCreate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a DNS record — netlify.getindividualdnsrecord

Run Get a DNS record with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required
path.dns_record_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example",
    "dns_record_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a DNS record — netlify.deletednsrecord

Run Delete a DNS record with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.zone_id string Required
path.dns_record_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "zone_id": "example",
    "dns_record_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a site's dev servers — netlify.listsitedevservers

Run List a site's dev servers with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
query object Optional additionalProperties: false
query.page integer Optional
query.per_page integer Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Start a dev server — netlify.createsitedevserver

Run Start a dev server with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
query object Optional additionalProperties: false
query.branch string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Stop a branch's dev servers — netlify.deletesitedevservers

Run Stop a branch's dev servers with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
query object Optional additionalProperties: false
query.branch string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a dev server — netlify.getsitedevserver

Run Get a dev server with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.dev_server_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "dev_server_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Record dev server activity — netlify.markdevserveractivity

Run Record dev server activity with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.dev_server_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "dev_server_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a dev server's state — netlify.updatedevserverstate

Run Update a dev server's state with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.dev_server_id string Required
body object Required
body.state string Required enum: ["starting","live","error","done"]
body.task_id string Optional
body.error string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "dev_server_id": "example"
  },
  "body": {
    "state": "starting"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a site's dev server hooks — netlify.listsitedevserverhooks

Run List a site's dev server hooks with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a dev server hook — netlify.createsitedevserverhook

Run Create a dev server hook with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
body — Required $ref: "#/definitions/devServerHookSetup"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a dev server hook — netlify.getsitedevserverhook

Run Get a dev server hook with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a dev server hook — netlify.updatesitedevserverhook

Run Update a dev server hook with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.id string Required
body — Required $ref: "#/definitions/devServerHookSetup"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a dev server hook — netlify.deletesitedevserverhook

Run Delete a dev server hook with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List a site's agent runner hooks — netlify.listsiteagentrunnerhooks

Run List a site's agent runner hooks with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an agent runner hook — netlify.createsiteagentrunnerhook

Run Create an agent runner hook with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
body — Required $ref: "#/definitions/agentRunnerHookSetup"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an agent runner hook — netlify.getsiteagentrunnerhook

Run Get an agent runner hook with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an agent runner hook — netlify.updatesiteagentrunnerhook

Run Update an agent runner hook with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.id string Required
body — Required $ref: "#/definitions/agentRunnerHookSetup"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an agent runner hook — netlify.deletesiteagentrunnerhook

Run Delete an agent runner hook with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List AI Gateway providers and models — netlify.getaigatewayproviders

Run List AI Gateway providers and models with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a site's AI Gateway token — netlify.getaigatewaytoken

Run Get a site's AI Gateway token with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required The site ID

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a team's AI Gateway token — netlify.getaccountaigatewaytoken

Run Get a team's AI Gateway token with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.account_id string Required The account ID

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a site database — netlify.createsitedatabase

Run Create a site database with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
body — Optional $ref: "#/definitions/createDatabaseRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a site database — netlify.getsitedatabase

Run Get a site database with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
query object Optional additionalProperties: false
query.role string Optional The database role to use for the connection string. Defaults to netlifydb_owner if not specified. enum: ["netlifydb_owner","netlifydb_readonly"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a site database — netlify.deletesitedatabase

Run Delete a site database with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a database branch — netlify.createsitedatabasebranch

Run Create a database branch with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
body — Required $ref: "#/definitions/createDatabaseBranchRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  },
  "body": {
    "branch_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List database branches — netlify.listsitedatabasebranches

Run List database branches with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a database branch — netlify.getsitedatabasebranch

Run Get a database branch with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.branch_id string Required The branch ID
query object Optional additionalProperties: false
query.role string Optional The database role to use for the connection string. Defaults to netlifydb_owner if not specified. enum: ["netlifydb_owner","netlifydb_readonly"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "branch_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a database branch — netlify.deletesitedatabasebranch

Run Delete a database branch with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.branch_id string Required The branch ID

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "branch_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Reset a database branch — netlify.resetsitedatabasebranch

Run Reset a database branch with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.branch_id string Required The branch ID to reset
query object Optional additionalProperties: false
query.force boolean Optional If true, resets the branch even when it is already in sync with the source.
query.role string Optional The database role to use for the returned connection string. Defaults to netlifydb_owner if not specified. enum: ["netlifydb_owner","netlifydb_readonly"]
body — Optional $ref: "#/definitions/resetDatabaseBranchRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "branch_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set a database branch's compute settings — netlify.setsitedatabasebranchcomputesettings

Run Set a database branch's compute settings with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.branch_id string Required The branch ID
body — Required $ref: "#/definitions/databaseComputeSettingsRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "branch_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set database compute settings — netlify.setsitedatabasecomputesettings

Run Set database compute settings with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
body — Required $ref: "#/definitions/databaseComputeSettingsRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get database compute settings — netlify.getsitedatabasecomputesettings

Run Get database compute settings with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Reset database compute settings to defaults — netlify.clearsitedatabasecomputesettings

Run Reset database compute settings to defaults with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List database migrations — netlify.listsitedatabasemigrations

Run List database migrations with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
query object Optional additionalProperties: false
query.branch string Optional The branch ID to list migrations for. Defaults to "production" if not specified.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a database migration — netlify.getsitedatabasemigration

Run Get a database migration with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.name string Required The migration name
query object Optional additionalProperties: false
query.branch string Optional The branch ID to look up the migration on. Defaults to the currently published deploy's branch.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Run database migrations for a deploy — netlify.runsitedatabasemigrations

Run Run database migrations for a deploy with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.deploy_id string Required The deploy ID to run migrations for
body — Optional $ref: "#/definitions/runDatabaseMigrationsRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "deploy_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a database snapshot — netlify.createsitedatabasesnapshot

Run Create a database snapshot with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
body — Optional $ref: "#/definitions/createDatabaseSnapshotRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List database snapshots — netlify.listsitedatabasesnapshots

Run List database snapshots with Netlify. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a database snapshot — netlify.deletesitedatabasesnapshot

Run Delete a database snapshot with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.snapshot_id string Required The snapshot ID

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "snapshot_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Restore a database snapshot — netlify.restoresitedatabasesnapshot

Run Restore a database snapshot with Netlify. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.site_id string Required
path.snapshot_id string Required The snapshot ID to restore
body — Optional $ref: "#/definitions/restoreDatabaseSnapshotRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "site_id": "example",
    "snapshot_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Errors

Check the key's expiry, revocation, workspace and allowed operations.

Reuse the same idempotency key only for the same request.

The connection or provider limit has been reached. Check the receipt before retrying.

Test the connection

Open the integration's commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client's tool list, use the returned tool name, and check the execution result and usage. Provider charges and permissions still apply. Never test a write against production data without reviewing it.

Official provider documentation

Source: https://help.tooluse.net/integrations/netlify/index.mdx