naftiko: 1.0.0-alpha2
info:
label: Netlify Netlify's API documentation
description: Netlify is a hosting service for the programmable web. It understands your documents and provides an API to
handle atomic deploys of websites, manage form submissions, inject JavaScript snippets, and much more. This is a REST-style
API that uses JSON for serialization and OAuth 2 for authentication. This document is an OpenAPI reference for the Netlify
API that you can explore. For more detailed instructions for common uses, please visit the [online documentation](https://www.netlify.com/docs/api/).
Visit our Community forum to join the conversation about [understanding and using Netlify’s API
tags:
- Netlify
- API
created: '2026-05-06'
modified: '2026-05-06'
capability:
consumes:
- type: http
namespace: netlify
baseUri: https://api.netlify.com/api/v1
description: Netlify Netlify's API documentation HTTP API.
authentication:
type: bearer
token: '{{NETLIFY_TOKEN}}'
resources:
- name: sites
path: /sites
operations:
- name: listsites
method: GET
description: '**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to
a new endpoint. Please use [getEnvVars](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment
variables.'
inputParameters:
- name: name
in: query
type: string
- name: filter
in: query
type: string
- name: page
in: query
type: integer
- name: per_page
in: query
type: integer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: createsite
method: POST
description: '**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to
a new endpoint. Please use [createEnvVars](#tag/environmentVariables/operation/createEnvVars) to create environment
variables for a site.'
inputParameters:
- name: configure_dns
in: query
type: boolean
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: sites-site-id
path: /sites/{site_id}
operations:
- name: getsite
method: GET
description: '**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to
a new endpoint. Please use [getEnvVars](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment
variables.'
inputParameters:
- name: site_id
in: path
type: string
required: true
- name: feature_flags
in: query
type: string
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: deletesite
method: DELETE
description: DELETE /sites/{site_id}
inputParameters:
- name: site_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: updatesite
method: PATCH
description: '**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to
a new endpoint. Please use [updateEnvVar](#tag/environmentVariables/operation/updateEnvVar) to update a site''s
environment variables.'
inputParameters:
- name: site_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: sites-site-id-ssl
path: /sites/{site_id}/ssl
operations:
- name: showsitetlscertificate
method: GET
description: GET /sites/{site_id}/ssl
inputParameters:
- name: site_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: provisionsitetlscertificate
method: POST
description: POST /sites/{site_id}/ssl
inputParameters:
- name: site_id
in: path
type: string
required: true
- name: certificate
in: query
type: string
- name: key
in: query
type: string
- name: ca_certificates
in: query
type: string
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: accounts-account-id-env
path: /accounts/{account_id}/env
operations:
- name: getenvvars
method: GET
description: Returns all environment variables for an account or site. An account corresponds to a team in the Netlify
UI. To use this endpoint, your site must no longer be using the classic
enviro
inputParameters:
- name: account_id
in: path
type: string
required: true
description: Scope response to account_id
- name: site_id
in: query
type: string
description: If provided, create an environment variable on the site level, not the account level
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: api-v1-sites-site-id-env
path: /api/v1/sites/{site_id}/env
operations:
- name: getsiteenvvars
method: GET
description: Returns all environment variables for a site. This convenience method behaves the same as `getEnvVars`
but doesn't require an `account_id` as input.
inputParameters:
- name: context_name
in: query
type: string
description: Filter by deploy context
- name: scope
in: query
type: string
description: Filter by scope
- name: site_id
in: path
type: string
required: true
description: Scope response to site_id
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: accounts-account-id-env-key
path: /accounts/{account_id}/env/{key}
operations:
- name: getenvvar
method: GET
description: Returns an individual environment variable. To use this endpoint, your site must no longer be using the
classic environment variables experience.
Migrate now w
inputParameters:
- name: account_id
in: path
type: string
required: true
description: Scope response to account_id
- name: key
in: path
type: string
required: true
description: The environment variable key (case-sensitive)
- name: site_id
in: query
type: string
description: If provided, return the environment variable for a specific site (no merging is performed)
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: updateenvvar
method: PUT
description: Updates an existing environment variable and all of its values. Existing values will be replaced by values
provided. To use this endpoint, your site must no longer be using the classic
environment variables experience. Migrate now with the Net
inputParameters:
- name: account_id
in: path
type: string
required: true
description: Scope response to account_id
- name: key
in: path
type: string
required: true
description: The environment variable key (case-sensitive)
- name: site_id
in: query
type: string
description: If provided, delete the environment variable from this site
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: setenvvarvalue
method: PATCH
description: Updates or creates a new value for an existing environment variable. To use this endpoint, your site
must no longer be using the classic
environment variables expe
inputParameters:
- name: account_id
in: path
type: string
required: true
description: Scope response to account_id
- name: key
in: path
type: string
required: true
description: The existing environment variable key name (case-sensitive)
- name: site_id
in: query
type: string
description: If provided, update an environment variable set on this site
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: accounts-account-id-env-key-value-id
path: /accounts/{account_id}/env/{key}/value/{id}
operations:
- name: deleteenvvarvalue
method: DELETE
description: Deletes a specific environment variable value. To use this endpoint, your site must no longer be using
the classic environment variables experience.
Migrate no
inputParameters:
- name: account_id
in: path
type: string
required: true
description: Scope response to account_id
- name: id
in: path
type: string
required: true
description: The environment variable value's ID
- name: key
in: path
type: string
required: true
description: The environment variable key name (case-sensitive)
- name: site_id
in: query
type: string
description: If provided, delete the value from an environment variable on this site
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: sites-site-id-functions
path: /sites/{site_id}/functions
operations:
- name: searchsitefunctions
method: GET
description: GET /sites/{site_id}/functions
inputParameters:
- name: site_id
in: path
type: string
required: true
- name: filter
in: query
type: string
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: sites-site-id-forms
path: /sites/{site_id}/forms
operations:
- name: listsiteforms
method: GET
description: GET /sites/{site_id}/forms
inputParameters:
- name: site_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: sites-site-id-forms-form-id
path: /sites/{site_id}/forms/{form_id}
operations:
- name: deletesiteform
method: DELETE
description: DELETE /sites/{site_id}/forms/{form_id}
inputParameters:
- name: site_id
in: path
type: string
required: true
- name: form_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: sites-site-id-submissions
path: /sites/{site_id}/submissions
operations:
- name: listsitesubmissions
method: GET
description: GET /sites/{site_id}/submissions
inputParameters:
- name: site_id
in: path
type: string
required: true
- name: page
in: query
type: integer
- name: per_page
in: query
type: integer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: sites-site-id-files
path: /sites/{site_id}/files
operations:
- name: listsitefiles
method: GET
description: GET /sites/{site_id}/files
inputParameters:
- name: site_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: sites-site-id-assets
path: /sites/{site_id}/assets
operations:
- name: listsiteassets
method: GET
description: GET /sites/{site_id}/assets
inputParameters:
- name: site_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: createsiteasset
method: POST
description: POST /sites/{site_id}/assets
inputParameters:
- name: site_id
in: path
type: string
required: true
- name: name
in: query
type: string
required: true
- name: size
in: query
type: integer
required: true
- name: content_type
in: query
type: string
required: true
- name: visibility
in: query
type: string
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: sites-site-id-assets-asset-id
path: /sites/{site_id}/assets/{asset_id}
operations:
- name: getsiteassetinfo
method: GET
description: GET /sites/{site_id}/assets/{asset_id}
inputParameters:
- name: site_id
in: path
type: string
required: true
- name: asset_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: updatesiteasset
method: PUT
description: PUT /sites/{site_id}/assets/{asset_id}
inputParameters:
- name: site_id
in: path
type: string
required: true
- name: asset_id
in: path
type: string
required: true
- name: state
in: query
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: deletesiteasset
method: DELETE
description: DELETE /sites/{site_id}/assets/{asset_id}
inputParameters:
- name: site_id
in: path
type: string
required: true
- name: asset_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: sites-site-id-assets-asset-id-public-signature
path: /sites/{site_id}/assets/{asset_id}/public_signature
operations:
- name: getsiteassetpublicsignature
method: GET
description: GET /sites/{site_id}/assets/{asset_id}/public_signature
inputParameters:
- name: site_id
in: path
type: string
required: true
- name: asset_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: sites-site-id-files-file-path
path: /sites/{site_id}/files/{file_path}
operations:
- name: getsitefilebypathname
method: GET
description: GET /sites/{site_id}/files/{file_path}
inputParameters:
- name: site_id
in: path
type: string
required: true
- name: file_path
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: purge
path: /purge
operations:
- name: purgecache
method: POST
description: Purges cached content from Netlify's CDN. Supports purging by Cache-Tag.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: sites-site-id-snippets
path: /sites/{site_id}/snippets
operations:
- name: listsitesnippets
method: GET
description: GET /sites/{site_id}/snippets
inputParameters:
- name: site_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: createsitesnippet
method: POST
description: POST /sites/{site_id}/snippets
inputParameters:
- name: site_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: sites-site-id-snippets-snippet-id
path: /sites/{site_id}/snippets/{snippet_id}
operations:
- name: getsitesnippet
method: GET
description: GET /sites/{site_id}/snippets/{snippet_id}
inputParameters:
- name: site_id
in: path
type: string
required: true
- name: snippet_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: updatesitesnippet
method: PUT
description: PUT /sites/{site_id}/snippets/{snippet_id}
inputParameters:
- name: site_id
in: path
type: string
required: true
- name: snippet_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: deletesitesnippet
method: DELETE
description: DELETE /sites/{site_id}/snippets/{snippet_id}
inputParameters:
- name: site_id
in: path
type: string
required: true
- name: snippet_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: sites-site-id-metadata
path: /sites/{site_id}/metadata
operations:
- name: getsitemetadata
method: GET
description: GET /sites/{site_id}/metadata
inputParameters:
- name: site_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: updatesitemetadata
method: PUT
description: PUT /sites/{site_id}/metadata
inputParameters:
- name: site_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: sites-site-id-build-hooks
path: /sites/{site_id}/build_hooks
operations:
- name: listsitebuildhooks
method: GET
description: GET /sites/{site_id}/build_hooks
inputParameters:
- name: site_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: createsitebuildhook
method: POST
description: POST /sites/{site_id}/build_hooks
inputParameters:
- name: site_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: sites-site-id-build-hooks-id
path: /sites/{site_id}/build_hooks/{id}
operations:
- name: getsitebuildhook
method: GET
description: GET /sites/{site_id}/build_hooks/{id}
inputParameters:
- name: site_id
in: path
type: string
required: true
- name: id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: updatesitebuildhook
method: PUT
description: PUT /sites/{site_id}/build_hooks/{id}
inputParameters:
- name: site_id
in: path
type: string
required: true
- name: id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: deletesitebuildhook
method: DELETE
description: DELETE /sites/{site_id}/build_hooks/{id}
inputParameters:
- name: site_id
in: path
type: string
required: true
- name: id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: sites-site-id-deploys
path: /sites/{site_id}/deploys
operations:
- name: listsitedeploys
method: GET
description: GET /sites/{site_id}/deploys
inputParameters:
- name: site_id
in: path
type: string
required: true
- name: deploy-previews
in: query
type: boolean
- name: production
in: query
type: boolean
- name: state
in: query
type: string
- name: branch
in: query
type: string
- name: latest-published
in: query
type: boolean
- name: page
in: query
type: integer
- name: per_page
in: query
type: integer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: createsitedeploy
method: POST
description: POST /sites/{site_id}/deploys
inputParameters:
- name: site_id
in: path
type: string
required: true
- name: deploy-previews
in: query
type: boolean
- name: production
in: query
type: boolean
- name: state
in: query
type: string
- name: branch
in: query
type: string
- name: latest-published
in: query
type: boolean
- name: title
in: query
type: string
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: sites-site-id-deploys-deploy-id
path: /sites/{site_id}/deploys/{deploy_id}
operations:
- name: getsitedeploy
method: GET
description: GET /sites/{site_id}/deploys/{deploy_id}
inputParameters:
- name: site_id
in: path
type: string
required: true
- name: deploy_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: updatesitedeploy
method: PUT
description: PUT /sites/{site_id}/deploys/{deploy_id}
inputParameters:
- name: site_id
in: path
type: string
required: true
- name: deploy_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: deletesitedeploy
method: DELETE
description: DELETE /sites/{site_id}/deploys/{deploy_id}
inputParameters:
- name: deploy_id
in: path
type: string
required: true
- name: site_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: deploys-deploy-id-cancel
path: /deploys/{deploy_id}/cancel
operations:
- name: cancelsitedeploy
method: POST
description: POST /deploys/{deploy_id}/cancel
inputParameters:
- name: deploy_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: sites-site-id-deploys-deploy-id-restore
path: /sites/{site_id}/deploys/{deploy_id}/restore
operations:
- name: restoresitedeploy
method: POST
description: POST /sites/{site_id}/deploys/{deploy_id}/restore
inputParameters:
- name: site_id
in: path
type: string
required: true
- name: deploy_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: sites-site-id-builds
path: /sites/{site_id}/builds
operations:
- name: listsitebuilds
method: GET
description: GET /sites/{site_id}/builds
inputParameters:
- name: site_id
in: path
type: string
required: true
- name: page
in: query
type: integer
- name: per_page
in: query
type: integer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: createsitebuild
method: POST
description: POST /sites/{site_id}/builds
inputParameters:
- name: site_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: sites-site-id-deployed-branches
path: /sites/{site_id}/deployed-branches
operations:
- name: listsitedeployedbranches
method: GET
description: GET /sites/{site_id}/deployed-branches
inputParameters:
- name: site_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: sites-site-id-unlink-repo
path: /sites/{site_id}/unlink_repo
operations:
- name: unlinksiterepo
method: PUT
description: '[Beta] Unlinks the repo from the site. This action will also: - Delete associated deploy keys - Delete
outgoing webhooks for the repo - Delete the site''s build hooks'
inputParameters:
- name: site_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: builds-build-id
path: /builds/{build_id}
operations:
- name: getsitebuild
method: GET
description: GET /builds/{build_id}
inputParameters:
- name: build_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: builds-build-id-log
path: /builds/{build_id}/log
operations:
- name: updatesitebuildlog
method: POST
description: POST /builds/{build_id}/log
inputParameters:
- name: build_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: builds-build-id-start
path: /builds/{build_id}/start
operations:
- name: notifybuildstart
method: POST
description: POST /builds/{build_id}/start
inputParameters:
- name: build_id
in: path
type: string
required: true
- name: buildbot_version
in: query
type: string
- name: build_version
in: query
type: string
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: account-id-builds-status
path: /{account_id}/builds/status
operations:
- name: getaccountbuildstatus
method: GET
description: GET /{account_id}/builds/status
inputParameters:
- name: account_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: sites-site-id-dns
path: /sites/{site_id}/dns
operations:
- name: getdnsforsite
method: GET
description: GET /sites/{site_id}/dns
inputParameters:
- name: site_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: configurednsforsite
method: PUT
description: PUT /sites/{site_id}/dns
inputParameters:
- name: site_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: sites-site-id-rollback
path: /sites/{site_id}/rollback
operations:
- name: rollbacksitedeploy
method: PUT
description: PUT /sites/{site_id}/rollback
inputParameters:
- name: site_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: deploys-deploy-id
path: /deploys/{deploy_id}
operations:
- name: getdeploy
method: GET
description: GET /deploys/{deploy_id}
inputParameters:
- name: deploy_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
- name: deletedeploy
method: DELETE
description: DELETE /deploys/{deploy_id}
inputParameters:
- name: deploy_id
in: path
type: string
required: true
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
exposes:
- type: rest
port: 8080
namespace: netlify-rest
description: REST adapter for Netlify Netlify's API documentation.
resources:
- path: /sites
name: listsites
operations:
- method: GET
name: listsites
description: '**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to
a new endpoint. Please use [getEnvVars](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment
variables.'
call: netlify.listsites
outputParameters:
- type: object
mapping: $.
- path: /sites
name: createsite
operations:
- method: POST
name: createsite
description: '**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to
a new endpoint. Please use [createEnvVars](#tag/environmentVariables/operation/createEnvVars) to create environment
variables for a site.'
call: netlify.createsite
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}
name: getsite
operations:
- method: GET
name: getsite
description: '**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to
a new endpoint. Please use [getEnvVars](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment
variables.'
call: netlify.getsite
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}
name: deletesite
operations:
- method: DELETE
name: deletesite
description: DELETE /sites/{site_id}
call: netlify.deletesite
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}
name: updatesite
operations:
- method: PATCH
name: updatesite
description: '**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to
a new endpoint. Please use [updateEnvVar](#tag/environmentVariables/operation/updateEnvVar) to update a site''s
environment variables.'
call: netlify.updatesite
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/ssl
name: showsitetlscertificate
operations:
- method: GET
name: showsitetlscertificate
description: GET /sites/{site_id}/ssl
call: netlify.showsitetlscertificate
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/ssl
name: provisionsitetlscertificate
operations:
- method: POST
name: provisionsitetlscertificate
description: POST /sites/{site_id}/ssl
call: netlify.provisionsitetlscertificate
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /accounts/{account_id}/env
name: getenvvars
operations:
- method: GET
name: getenvvars
description: Returns all environment variables for an account or site. An account corresponds to a team in the Netlify
UI. To use this endpoint, your site must no longer be using the classic
enviro
call: netlify.createenvvars
with:
account_id: rest.account_id
outputParameters:
- type: object
mapping: $.
- path: /api/v1/sites/{site_id}/env
name: getsiteenvvars
operations:
- method: GET
name: getsiteenvvars
description: Returns all environment variables for a site. This convenience method behaves the same as `getEnvVars`
but doesn't require an `account_id` as input.
call: netlify.getsiteenvvars
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /accounts/{account_id}/env/{key}
name: getenvvar
operations:
- method: GET
name: getenvvar
description: Returns an individual environment variable. To use this endpoint, your site must no longer be using the
classic environment variables experience.
Migrate now w
call: netlify.getenvvar
with:
account_id: rest.account_id
key: rest.key
outputParameters:
- type: object
mapping: $.
- path: /accounts/{account_id}/env/{key}
name: updateenvvar
operations:
- method: PUT
name: updateenvvar
description: Updates an existing environment variable and all of its values. Existing values will be replaced by values
provided. To use this endpoint, your site must no longer be using the classic
environment variables experience. Migrate now with the Net
call: netlify.deleteenvvar
with:
account_id: rest.account_id
key: rest.key
outputParameters:
- type: object
mapping: $.
- path: /accounts/{account_id}/env/{key}
name: setenvvarvalue
operations:
- method: PATCH
name: setenvvarvalue
description: Updates or creates a new value for an existing environment variable. To use this endpoint, your site
must no longer be using the classic
environment variables expe
call: netlify.setenvvarvalue
with:
account_id: rest.account_id
key: rest.key
outputParameters:
- type: object
mapping: $.
- path: /accounts/{account_id}/env/{key}/value/{id}
name: deleteenvvarvalue
operations:
- method: DELETE
name: deleteenvvarvalue
description: Deletes a specific environment variable value. To use this endpoint, your site must no longer be using
the classic environment variables experience.
Migrate no
call: netlify.deleteenvvarvalue
with:
account_id: rest.account_id
id: rest.id
key: rest.key
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/functions
name: searchsitefunctions
operations:
- method: GET
name: searchsitefunctions
description: GET /sites/{site_id}/functions
call: netlify.searchsitefunctions
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/forms
name: listsiteforms
operations:
- method: GET
name: listsiteforms
description: GET /sites/{site_id}/forms
call: netlify.listsiteforms
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/forms/{form_id}
name: deletesiteform
operations:
- method: DELETE
name: deletesiteform
description: DELETE /sites/{site_id}/forms/{form_id}
call: netlify.deletesiteform
with:
site_id: rest.site_id
form_id: rest.form_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/submissions
name: listsitesubmissions
operations:
- method: GET
name: listsitesubmissions
description: GET /sites/{site_id}/submissions
call: netlify.listsitesubmissions
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/files
name: listsitefiles
operations:
- method: GET
name: listsitefiles
description: GET /sites/{site_id}/files
call: netlify.listsitefiles
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/assets
name: listsiteassets
operations:
- method: GET
name: listsiteassets
description: GET /sites/{site_id}/assets
call: netlify.listsiteassets
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/assets
name: createsiteasset
operations:
- method: POST
name: createsiteasset
description: POST /sites/{site_id}/assets
call: netlify.createsiteasset
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/assets/{asset_id}
name: getsiteassetinfo
operations:
- method: GET
name: getsiteassetinfo
description: GET /sites/{site_id}/assets/{asset_id}
call: netlify.getsiteassetinfo
with:
site_id: rest.site_id
asset_id: rest.asset_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/assets/{asset_id}
name: updatesiteasset
operations:
- method: PUT
name: updatesiteasset
description: PUT /sites/{site_id}/assets/{asset_id}
call: netlify.updatesiteasset
with:
site_id: rest.site_id
asset_id: rest.asset_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/assets/{asset_id}
name: deletesiteasset
operations:
- method: DELETE
name: deletesiteasset
description: DELETE /sites/{site_id}/assets/{asset_id}
call: netlify.deletesiteasset
with:
site_id: rest.site_id
asset_id: rest.asset_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/assets/{asset_id}/public_signature
name: getsiteassetpublicsignature
operations:
- method: GET
name: getsiteassetpublicsignature
description: GET /sites/{site_id}/assets/{asset_id}/public_signature
call: netlify.getsiteassetpublicsignature
with:
site_id: rest.site_id
asset_id: rest.asset_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/files/{file_path}
name: getsitefilebypathname
operations:
- method: GET
name: getsitefilebypathname
description: GET /sites/{site_id}/files/{file_path}
call: netlify.getsitefilebypathname
with:
site_id: rest.site_id
file_path: rest.file_path
outputParameters:
- type: object
mapping: $.
- path: /purge
name: purgecache
operations:
- method: POST
name: purgecache
description: Purges cached content from Netlify's CDN. Supports purging by Cache-Tag.
call: netlify.purgecache
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/snippets
name: listsitesnippets
operations:
- method: GET
name: listsitesnippets
description: GET /sites/{site_id}/snippets
call: netlify.listsitesnippets
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/snippets
name: createsitesnippet
operations:
- method: POST
name: createsitesnippet
description: POST /sites/{site_id}/snippets
call: netlify.createsitesnippet
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/snippets/{snippet_id}
name: getsitesnippet
operations:
- method: GET
name: getsitesnippet
description: GET /sites/{site_id}/snippets/{snippet_id}
call: netlify.getsitesnippet
with:
site_id: rest.site_id
snippet_id: rest.snippet_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/snippets/{snippet_id}
name: updatesitesnippet
operations:
- method: PUT
name: updatesitesnippet
description: PUT /sites/{site_id}/snippets/{snippet_id}
call: netlify.updatesitesnippet
with:
site_id: rest.site_id
snippet_id: rest.snippet_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/snippets/{snippet_id}
name: deletesitesnippet
operations:
- method: DELETE
name: deletesitesnippet
description: DELETE /sites/{site_id}/snippets/{snippet_id}
call: netlify.deletesitesnippet
with:
site_id: rest.site_id
snippet_id: rest.snippet_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/metadata
name: getsitemetadata
operations:
- method: GET
name: getsitemetadata
description: GET /sites/{site_id}/metadata
call: netlify.getsitemetadata
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/metadata
name: updatesitemetadata
operations:
- method: PUT
name: updatesitemetadata
description: PUT /sites/{site_id}/metadata
call: netlify.updatesitemetadata
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/build_hooks
name: listsitebuildhooks
operations:
- method: GET
name: listsitebuildhooks
description: GET /sites/{site_id}/build_hooks
call: netlify.listsitebuildhooks
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/build_hooks
name: createsitebuildhook
operations:
- method: POST
name: createsitebuildhook
description: POST /sites/{site_id}/build_hooks
call: netlify.createsitebuildhook
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/build_hooks/{id}
name: getsitebuildhook
operations:
- method: GET
name: getsitebuildhook
description: GET /sites/{site_id}/build_hooks/{id}
call: netlify.getsitebuildhook
with:
site_id: rest.site_id
id: rest.id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/build_hooks/{id}
name: updatesitebuildhook
operations:
- method: PUT
name: updatesitebuildhook
description: PUT /sites/{site_id}/build_hooks/{id}
call: netlify.updatesitebuildhook
with:
site_id: rest.site_id
id: rest.id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/build_hooks/{id}
name: deletesitebuildhook
operations:
- method: DELETE
name: deletesitebuildhook
description: DELETE /sites/{site_id}/build_hooks/{id}
call: netlify.deletesitebuildhook
with:
site_id: rest.site_id
id: rest.id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/deploys
name: listsitedeploys
operations:
- method: GET
name: listsitedeploys
description: GET /sites/{site_id}/deploys
call: netlify.listsitedeploys
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/deploys
name: createsitedeploy
operations:
- method: POST
name: createsitedeploy
description: POST /sites/{site_id}/deploys
call: netlify.createsitedeploy
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/deploys/{deploy_id}
name: getsitedeploy
operations:
- method: GET
name: getsitedeploy
description: GET /sites/{site_id}/deploys/{deploy_id}
call: netlify.getsitedeploy
with:
site_id: rest.site_id
deploy_id: rest.deploy_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/deploys/{deploy_id}
name: updatesitedeploy
operations:
- method: PUT
name: updatesitedeploy
description: PUT /sites/{site_id}/deploys/{deploy_id}
call: netlify.updatesitedeploy
with:
site_id: rest.site_id
deploy_id: rest.deploy_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/deploys/{deploy_id}
name: deletesitedeploy
operations:
- method: DELETE
name: deletesitedeploy
description: DELETE /sites/{site_id}/deploys/{deploy_id}
call: netlify.deletesitedeploy
with:
deploy_id: rest.deploy_id
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /deploys/{deploy_id}/cancel
name: cancelsitedeploy
operations:
- method: POST
name: cancelsitedeploy
description: POST /deploys/{deploy_id}/cancel
call: netlify.cancelsitedeploy
with:
deploy_id: rest.deploy_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/deploys/{deploy_id}/restore
name: restoresitedeploy
operations:
- method: POST
name: restoresitedeploy
description: POST /sites/{site_id}/deploys/{deploy_id}/restore
call: netlify.restoresitedeploy
with:
site_id: rest.site_id
deploy_id: rest.deploy_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/builds
name: listsitebuilds
operations:
- method: GET
name: listsitebuilds
description: GET /sites/{site_id}/builds
call: netlify.listsitebuilds
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/builds
name: createsitebuild
operations:
- method: POST
name: createsitebuild
description: POST /sites/{site_id}/builds
call: netlify.createsitebuild
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/deployed-branches
name: listsitedeployedbranches
operations:
- method: GET
name: listsitedeployedbranches
description: GET /sites/{site_id}/deployed-branches
call: netlify.listsitedeployedbranches
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/unlink_repo
name: unlinksiterepo
operations:
- method: PUT
name: unlinksiterepo
description: '[Beta] Unlinks the repo from the site. This action will also: - Delete associated deploy keys - Delete
outgoing webhooks for the repo - Delete the site''s build hooks'
call: netlify.unlinksiterepo
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /builds/{build_id}
name: getsitebuild
operations:
- method: GET
name: getsitebuild
description: GET /builds/{build_id}
call: netlify.getsitebuild
with:
build_id: rest.build_id
outputParameters:
- type: object
mapping: $.
- path: /builds/{build_id}/log
name: updatesitebuildlog
operations:
- method: POST
name: updatesitebuildlog
description: POST /builds/{build_id}/log
call: netlify.updatesitebuildlog
with:
build_id: rest.build_id
outputParameters:
- type: object
mapping: $.
- path: /builds/{build_id}/start
name: notifybuildstart
operations:
- method: POST
name: notifybuildstart
description: POST /builds/{build_id}/start
call: netlify.notifybuildstart
with:
build_id: rest.build_id
outputParameters:
- type: object
mapping: $.
- path: /{account_id}/builds/status
name: getaccountbuildstatus
operations:
- method: GET
name: getaccountbuildstatus
description: GET /{account_id}/builds/status
call: netlify.getaccountbuildstatus
with:
account_id: rest.account_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/dns
name: getdnsforsite
operations:
- method: GET
name: getdnsforsite
description: GET /sites/{site_id}/dns
call: netlify.getdnsforsite
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/dns
name: configurednsforsite
operations:
- method: PUT
name: configurednsforsite
description: PUT /sites/{site_id}/dns
call: netlify.configurednsforsite
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /sites/{site_id}/rollback
name: rollbacksitedeploy
operations:
- method: PUT
name: rollbacksitedeploy
description: PUT /sites/{site_id}/rollback
call: netlify.rollbacksitedeploy
with:
site_id: rest.site_id
outputParameters:
- type: object
mapping: $.
- path: /deploys/{deploy_id}
name: getdeploy
operations:
- method: GET
name: getdeploy
description: GET /deploys/{deploy_id}
call: netlify.getdeploy
with:
deploy_id: rest.deploy_id
outputParameters:
- type: object
mapping: $.
- path: /deploys/{deploy_id}
name: deletedeploy
operations:
- method: DELETE
name: deletedeploy
description: DELETE /deploys/{deploy_id}
call: netlify.deletedeploy
with:
deploy_id: rest.deploy_id
outputParameters:
- type: object
mapping: $.
- type: mcp
port: 9090
namespace: netlify-mcp
transport: http
description: MCP adapter for Netlify Netlify's API documentation for AI agent use.
tools:
- name: listsites
description: '**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to
a new endpoint. Please use [getEnvVars](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment
variables.'
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.listsites
with:
name: tools.name
filter: tools.filter
page: tools.page
per_page: tools.per_page
inputParameters:
- name: name
type: string
description: name
- name: filter
type: string
description: filter
- name: page
type: integer
description: page
- name: per_page
type: integer
description: per_page
outputParameters:
- type: object
mapping: $.
- name: createsite
description: '**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to
a new endpoint. Please use [createEnvVars](#tag/environmentVariables/operation/createEnvVars) to create environment
variables for a site.'
hints:
readOnly: false
destructive: false
idempotent: false
call: netlify.createsite
with:
configure_dns: tools.configure_dns
inputParameters:
- name: configure_dns
type: boolean
description: configure_dns
outputParameters:
- type: object
mapping: $.
- name: getsite
description: '**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to
a new endpoint. Please use [getEnvVars](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment
variables.'
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.getsite
with:
site_id: tools.site_id
feature_flags: tools.feature_flags
inputParameters:
- name: site_id
type: string
description: site_id
required: true
- name: feature_flags
type: string
description: feature_flags
outputParameters:
- type: object
mapping: $.
- name: deletesite
description: DELETE /sites/{site_id}
hints:
readOnly: false
destructive: true
idempotent: true
call: netlify.deletesite
with:
site_id: tools.site_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
outputParameters:
- type: object
mapping: $.
- name: updatesite
description: '**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to
a new endpoint. Please use [updateEnvVar](#tag/environmentVariables/operation/updateEnvVar) to update a site''s environment
variables.'
hints:
readOnly: false
destructive: false
idempotent: false
call: netlify.updatesite
with:
site_id: tools.site_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
outputParameters:
- type: object
mapping: $.
- name: showsitetlscertificate
description: GET /sites/{site_id}/ssl
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.showsitetlscertificate
with:
site_id: tools.site_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
outputParameters:
- type: object
mapping: $.
- name: provisionsitetlscertificate
description: POST /sites/{site_id}/ssl
hints:
readOnly: false
destructive: false
idempotent: false
call: netlify.provisionsitetlscertificate
with:
site_id: tools.site_id
certificate: tools.certificate
key: tools.key
ca_certificates: tools.ca_certificates
inputParameters:
- name: site_id
type: string
description: site_id
required: true
- name: certificate
type: string
description: certificate
- name: key
type: string
description: key
- name: ca_certificates
type: string
description: ca_certificates
outputParameters:
- type: object
mapping: $.
- name: getenvvars
description: Returns all environment variables for an account or site. An account corresponds to a team in the Netlify
UI. To use this endpoint, your site must no longer be using the classic
enviro
hints:
readOnly: false
destructive: false
idempotent: false
call: netlify.createenvvars
with:
account_id: tools.account_id
site_id: tools.site_id
inputParameters:
- name: account_id
type: string
description: Scope response to account_id
required: true
- name: site_id
type: string
description: If provided, create an environment variable on the site level, not the account level
outputParameters:
- type: object
mapping: $.
- name: getsiteenvvars
description: Returns all environment variables for a site. This convenience method behaves the same as `getEnvVars`
but doesn't require an `account_id` as input.
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.getsiteenvvars
with:
site_id: tools.site_id
context_name: tools.context_name
scope: tools.scope
inputParameters:
- name: site_id
type: string
description: Scope response to site_id
required: true
- name: context_name
type: string
description: Filter by deploy context
- name: scope
type: string
description: Filter by scope
outputParameters:
- type: object
mapping: $.
- name: getenvvar
description: Returns an individual environment variable. To use this endpoint, your site must no longer be using the
classic environment variables experience.
Migrate now w
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.getenvvar
with:
account_id: tools.account_id
key: tools.key
site_id: tools.site_id
inputParameters:
- name: account_id
type: string
description: Scope response to account_id
required: true
- name: key
type: string
description: The environment variable key (case-sensitive)
required: true
- name: site_id
type: string
description: If provided, return the environment variable for a specific site (no merging is performed)
outputParameters:
- type: object
mapping: $.
- name: updateenvvar
description: Updates an existing environment variable and all of its values. Existing values will be replaced by values
provided. To use this endpoint, your site must no longer be using the classic
environment variables experience. Migrate now with the Net
hints:
readOnly: false
destructive: true
idempotent: true
call: netlify.deleteenvvar
with:
account_id: tools.account_id
key: tools.key
site_id: tools.site_id
inputParameters:
- name: account_id
type: string
description: Scope response to account_id
required: true
- name: key
type: string
description: The environment variable key (case-sensitive)
required: true
- name: site_id
type: string
description: If provided, delete the environment variable from this site
outputParameters:
- type: object
mapping: $.
- name: setenvvarvalue
description: Updates or creates a new value for an existing environment variable. To use this endpoint, your site must
no longer be using the classic environment
variables expe
hints:
readOnly: false
destructive: false
idempotent: false
call: netlify.setenvvarvalue
with:
account_id: tools.account_id
key: tools.key
site_id: tools.site_id
inputParameters:
- name: account_id
type: string
description: Scope response to account_id
required: true
- name: key
type: string
description: The existing environment variable key name (case-sensitive)
required: true
- name: site_id
type: string
description: If provided, update an environment variable set on this site
outputParameters:
- type: object
mapping: $.
- name: deleteenvvarvalue
description: Deletes a specific environment variable value. To use this endpoint, your site must no longer be using
the classic environment variables experience.
Migrate no
hints:
readOnly: false
destructive: true
idempotent: true
call: netlify.deleteenvvarvalue
with:
account_id: tools.account_id
id: tools.id
key: tools.key
site_id: tools.site_id
inputParameters:
- name: account_id
type: string
description: Scope response to account_id
required: true
- name: id
type: string
description: The environment variable value's ID
required: true
- name: key
type: string
description: The environment variable key name (case-sensitive)
required: true
- name: site_id
type: string
description: If provided, delete the value from an environment variable on this site
outputParameters:
- type: object
mapping: $.
- name: searchsitefunctions
description: GET /sites/{site_id}/functions
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.searchsitefunctions
with:
site_id: tools.site_id
filter: tools.filter
inputParameters:
- name: site_id
type: string
description: site_id
required: true
- name: filter
type: string
description: filter
outputParameters:
- type: object
mapping: $.
- name: listsiteforms
description: GET /sites/{site_id}/forms
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.listsiteforms
with:
site_id: tools.site_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
outputParameters:
- type: object
mapping: $.
- name: deletesiteform
description: DELETE /sites/{site_id}/forms/{form_id}
hints:
readOnly: false
destructive: true
idempotent: true
call: netlify.deletesiteform
with:
site_id: tools.site_id
form_id: tools.form_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
- name: form_id
type: string
description: form_id
required: true
outputParameters:
- type: object
mapping: $.
- name: listsitesubmissions
description: GET /sites/{site_id}/submissions
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.listsitesubmissions
with:
site_id: tools.site_id
page: tools.page
per_page: tools.per_page
inputParameters:
- name: site_id
type: string
description: site_id
required: true
- name: page
type: integer
description: page
- name: per_page
type: integer
description: per_page
outputParameters:
- type: object
mapping: $.
- name: listsitefiles
description: GET /sites/{site_id}/files
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.listsitefiles
with:
site_id: tools.site_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
outputParameters:
- type: object
mapping: $.
- name: listsiteassets
description: GET /sites/{site_id}/assets
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.listsiteassets
with:
site_id: tools.site_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
outputParameters:
- type: object
mapping: $.
- name: createsiteasset
description: POST /sites/{site_id}/assets
hints:
readOnly: false
destructive: false
idempotent: false
call: netlify.createsiteasset
with:
site_id: tools.site_id
name: tools.name
size: tools.size
content_type: tools.content_type
visibility: tools.visibility
inputParameters:
- name: site_id
type: string
description: site_id
required: true
- name: name
type: string
description: name
required: true
- name: size
type: integer
description: size
required: true
- name: content_type
type: string
description: content_type
required: true
- name: visibility
type: string
description: visibility
outputParameters:
- type: object
mapping: $.
- name: getsiteassetinfo
description: GET /sites/{site_id}/assets/{asset_id}
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.getsiteassetinfo
with:
site_id: tools.site_id
asset_id: tools.asset_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
- name: asset_id
type: string
description: asset_id
required: true
outputParameters:
- type: object
mapping: $.
- name: updatesiteasset
description: PUT /sites/{site_id}/assets/{asset_id}
hints:
readOnly: false
destructive: false
idempotent: true
call: netlify.updatesiteasset
with:
site_id: tools.site_id
asset_id: tools.asset_id
state: tools.state
inputParameters:
- name: site_id
type: string
description: site_id
required: true
- name: asset_id
type: string
description: asset_id
required: true
- name: state
type: string
description: state
required: true
outputParameters:
- type: object
mapping: $.
- name: deletesiteasset
description: DELETE /sites/{site_id}/assets/{asset_id}
hints:
readOnly: false
destructive: true
idempotent: true
call: netlify.deletesiteasset
with:
site_id: tools.site_id
asset_id: tools.asset_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
- name: asset_id
type: string
description: asset_id
required: true
outputParameters:
- type: object
mapping: $.
- name: getsiteassetpublicsignature
description: GET /sites/{site_id}/assets/{asset_id}/public_signature
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.getsiteassetpublicsignature
with:
site_id: tools.site_id
asset_id: tools.asset_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
- name: asset_id
type: string
description: asset_id
required: true
outputParameters:
- type: object
mapping: $.
- name: getsitefilebypathname
description: GET /sites/{site_id}/files/{file_path}
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.getsitefilebypathname
with:
site_id: tools.site_id
file_path: tools.file_path
inputParameters:
- name: site_id
type: string
description: site_id
required: true
- name: file_path
type: string
description: file_path
required: true
outputParameters:
- type: object
mapping: $.
- name: purgecache
description: Purges cached content from Netlify's CDN. Supports purging by Cache-Tag.
hints:
readOnly: false
destructive: false
idempotent: false
call: netlify.purgecache
outputParameters:
- type: object
mapping: $.
- name: listsitesnippets
description: GET /sites/{site_id}/snippets
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.listsitesnippets
with:
site_id: tools.site_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
outputParameters:
- type: object
mapping: $.
- name: createsitesnippet
description: POST /sites/{site_id}/snippets
hints:
readOnly: false
destructive: false
idempotent: false
call: netlify.createsitesnippet
with:
site_id: tools.site_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
outputParameters:
- type: object
mapping: $.
- name: getsitesnippet
description: GET /sites/{site_id}/snippets/{snippet_id}
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.getsitesnippet
with:
site_id: tools.site_id
snippet_id: tools.snippet_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
- name: snippet_id
type: string
description: snippet_id
required: true
outputParameters:
- type: object
mapping: $.
- name: updatesitesnippet
description: PUT /sites/{site_id}/snippets/{snippet_id}
hints:
readOnly: false
destructive: false
idempotent: true
call: netlify.updatesitesnippet
with:
site_id: tools.site_id
snippet_id: tools.snippet_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
- name: snippet_id
type: string
description: snippet_id
required: true
outputParameters:
- type: object
mapping: $.
- name: deletesitesnippet
description: DELETE /sites/{site_id}/snippets/{snippet_id}
hints:
readOnly: false
destructive: true
idempotent: true
call: netlify.deletesitesnippet
with:
site_id: tools.site_id
snippet_id: tools.snippet_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
- name: snippet_id
type: string
description: snippet_id
required: true
outputParameters:
- type: object
mapping: $.
- name: getsitemetadata
description: GET /sites/{site_id}/metadata
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.getsitemetadata
with:
site_id: tools.site_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
outputParameters:
- type: object
mapping: $.
- name: updatesitemetadata
description: PUT /sites/{site_id}/metadata
hints:
readOnly: false
destructive: false
idempotent: true
call: netlify.updatesitemetadata
with:
site_id: tools.site_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
outputParameters:
- type: object
mapping: $.
- name: listsitebuildhooks
description: GET /sites/{site_id}/build_hooks
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.listsitebuildhooks
with:
site_id: tools.site_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
outputParameters:
- type: object
mapping: $.
- name: createsitebuildhook
description: POST /sites/{site_id}/build_hooks
hints:
readOnly: false
destructive: false
idempotent: false
call: netlify.createsitebuildhook
with:
site_id: tools.site_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
outputParameters:
- type: object
mapping: $.
- name: getsitebuildhook
description: GET /sites/{site_id}/build_hooks/{id}
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.getsitebuildhook
with:
site_id: tools.site_id
id: tools.id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
- name: id
type: string
description: id
required: true
outputParameters:
- type: object
mapping: $.
- name: updatesitebuildhook
description: PUT /sites/{site_id}/build_hooks/{id}
hints:
readOnly: false
destructive: false
idempotent: true
call: netlify.updatesitebuildhook
with:
site_id: tools.site_id
id: tools.id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
- name: id
type: string
description: id
required: true
outputParameters:
- type: object
mapping: $.
- name: deletesitebuildhook
description: DELETE /sites/{site_id}/build_hooks/{id}
hints:
readOnly: false
destructive: true
idempotent: true
call: netlify.deletesitebuildhook
with:
site_id: tools.site_id
id: tools.id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
- name: id
type: string
description: id
required: true
outputParameters:
- type: object
mapping: $.
- name: listsitedeploys
description: GET /sites/{site_id}/deploys
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.listsitedeploys
with:
site_id: tools.site_id
deploy-previews: tools.deploy-previews
production: tools.production
state: tools.state
branch: tools.branch
latest-published: tools.latest-published
page: tools.page
per_page: tools.per_page
inputParameters:
- name: site_id
type: string
description: site_id
required: true
- name: deploy-previews
type: boolean
description: deploy-previews
- name: production
type: boolean
description: production
- name: state
type: string
description: state
- name: branch
type: string
description: branch
- name: latest-published
type: boolean
description: latest-published
- name: page
type: integer
description: page
- name: per_page
type: integer
description: per_page
outputParameters:
- type: object
mapping: $.
- name: createsitedeploy
description: POST /sites/{site_id}/deploys
hints:
readOnly: false
destructive: false
idempotent: false
call: netlify.createsitedeploy
with:
site_id: tools.site_id
deploy-previews: tools.deploy-previews
production: tools.production
state: tools.state
branch: tools.branch
latest-published: tools.latest-published
title: tools.title
inputParameters:
- name: site_id
type: string
description: site_id
required: true
- name: deploy-previews
type: boolean
description: deploy-previews
- name: production
type: boolean
description: production
- name: state
type: string
description: state
- name: branch
type: string
description: branch
- name: latest-published
type: boolean
description: latest-published
- name: title
type: string
description: title
outputParameters:
- type: object
mapping: $.
- name: getsitedeploy
description: GET /sites/{site_id}/deploys/{deploy_id}
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.getsitedeploy
with:
site_id: tools.site_id
deploy_id: tools.deploy_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
- name: deploy_id
type: string
description: deploy_id
required: true
outputParameters:
- type: object
mapping: $.
- name: updatesitedeploy
description: PUT /sites/{site_id}/deploys/{deploy_id}
hints:
readOnly: false
destructive: false
idempotent: true
call: netlify.updatesitedeploy
with:
site_id: tools.site_id
deploy_id: tools.deploy_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
- name: deploy_id
type: string
description: deploy_id
required: true
outputParameters:
- type: object
mapping: $.
- name: deletesitedeploy
description: DELETE /sites/{site_id}/deploys/{deploy_id}
hints:
readOnly: false
destructive: true
idempotent: true
call: netlify.deletesitedeploy
with:
deploy_id: tools.deploy_id
site_id: tools.site_id
inputParameters:
- name: deploy_id
type: string
description: deploy_id
required: true
- name: site_id
type: string
description: site_id
required: true
outputParameters:
- type: object
mapping: $.
- name: cancelsitedeploy
description: POST /deploys/{deploy_id}/cancel
hints:
readOnly: false
destructive: false
idempotent: false
call: netlify.cancelsitedeploy
with:
deploy_id: tools.deploy_id
inputParameters:
- name: deploy_id
type: string
description: deploy_id
required: true
outputParameters:
- type: object
mapping: $.
- name: restoresitedeploy
description: POST /sites/{site_id}/deploys/{deploy_id}/restore
hints:
readOnly: false
destructive: false
idempotent: false
call: netlify.restoresitedeploy
with:
site_id: tools.site_id
deploy_id: tools.deploy_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
- name: deploy_id
type: string
description: deploy_id
required: true
outputParameters:
- type: object
mapping: $.
- name: listsitebuilds
description: GET /sites/{site_id}/builds
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.listsitebuilds
with:
site_id: tools.site_id
page: tools.page
per_page: tools.per_page
inputParameters:
- name: site_id
type: string
description: site_id
required: true
- name: page
type: integer
description: page
- name: per_page
type: integer
description: per_page
outputParameters:
- type: object
mapping: $.
- name: createsitebuild
description: POST /sites/{site_id}/builds
hints:
readOnly: false
destructive: false
idempotent: false
call: netlify.createsitebuild
with:
site_id: tools.site_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
outputParameters:
- type: object
mapping: $.
- name: listsitedeployedbranches
description: GET /sites/{site_id}/deployed-branches
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.listsitedeployedbranches
with:
site_id: tools.site_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
outputParameters:
- type: object
mapping: $.
- name: unlinksiterepo
description: '[Beta] Unlinks the repo from the site. This action will also: - Delete associated deploy keys - Delete
outgoing webhooks for the repo - Delete the site''s build hooks'
hints:
readOnly: false
destructive: false
idempotent: true
call: netlify.unlinksiterepo
with:
site_id: tools.site_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
outputParameters:
- type: object
mapping: $.
- name: getsitebuild
description: GET /builds/{build_id}
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.getsitebuild
with:
build_id: tools.build_id
inputParameters:
- name: build_id
type: string
description: build_id
required: true
outputParameters:
- type: object
mapping: $.
- name: updatesitebuildlog
description: POST /builds/{build_id}/log
hints:
readOnly: false
destructive: false
idempotent: false
call: netlify.updatesitebuildlog
with:
build_id: tools.build_id
inputParameters:
- name: build_id
type: string
description: build_id
required: true
outputParameters:
- type: object
mapping: $.
- name: notifybuildstart
description: POST /builds/{build_id}/start
hints:
readOnly: false
destructive: false
idempotent: false
call: netlify.notifybuildstart
with:
build_id: tools.build_id
buildbot_version: tools.buildbot_version
build_version: tools.build_version
inputParameters:
- name: build_id
type: string
description: build_id
required: true
- name: buildbot_version
type: string
description: buildbot_version
- name: build_version
type: string
description: build_version
outputParameters:
- type: object
mapping: $.
- name: getaccountbuildstatus
description: GET /{account_id}/builds/status
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.getaccountbuildstatus
with:
account_id: tools.account_id
inputParameters:
- name: account_id
type: string
description: account_id
required: true
outputParameters:
- type: object
mapping: $.
- name: getdnsforsite
description: GET /sites/{site_id}/dns
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.getdnsforsite
with:
site_id: tools.site_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
outputParameters:
- type: object
mapping: $.
- name: configurednsforsite
description: PUT /sites/{site_id}/dns
hints:
readOnly: false
destructive: false
idempotent: true
call: netlify.configurednsforsite
with:
site_id: tools.site_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
outputParameters:
- type: object
mapping: $.
- name: rollbacksitedeploy
description: PUT /sites/{site_id}/rollback
hints:
readOnly: false
destructive: false
idempotent: true
call: netlify.rollbacksitedeploy
with:
site_id: tools.site_id
inputParameters:
- name: site_id
type: string
description: site_id
required: true
outputParameters:
- type: object
mapping: $.
- name: getdeploy
description: GET /deploys/{deploy_id}
hints:
readOnly: true
destructive: false
idempotent: true
call: netlify.getdeploy
with:
deploy_id: tools.deploy_id
inputParameters:
- name: deploy_id
type: string
description: deploy_id
required: true
outputParameters:
- type: object
mapping: $.
- name: deletedeploy
description: DELETE /deploys/{deploy_id}
hints:
readOnly: false
destructive: true
idempotent: true
call: netlify.deletedeploy
with:
deploy_id: tools.deploy_id
inputParameters:
- name: deploy_id
type: string
description: deploy_id
required: true
outputParameters:
- type: object
mapping: $.
binds:
- namespace: env
keys:
NETLIFY_TOKEN: NETLIFY_TOKEN