165 endpoints across 19 groups. See references/api-spec.lap for full details.
sites
Method
Path
Description
GET
/sites
Note: Environment variable keys and values have moved from build_settings.env and repo.env to a new endpoint. Please use getEnvVars to retrieve site environment variables.
POST
/sites
Note: Environment variable keys and values have moved from build_settings.env and repo.env to a new endpoint. Please use createEnvVars to create environment variables for a site.
GET
/sites/{site_id}
Note: Environment variable keys and values have moved from build_settings.env and repo.env to a new endpoint. Please use getEnvVars to retrieve site environment variables.
PATCH
/sites/{site_id}
Note: Environment variable keys and values have moved from build_settings.env and repo.env to a new endpoint. Please use updateEnvVar to update a site's environment variables.
DELETE
/sites/{site_id}
POST
/sites/{site_id}/ssl
Provisions or updates a TLS certificate for the site.
Runs a build for a site. The build will be scheduled to run at the first opportunity, but it might not start immediately if insufficient account build capacity is available.
GET
/sites/{site_id}/deployed-branches
PUT
/sites/{site_id}/unlink_repo
[Beta] Unlinks the repo from the site.
PUT
/sites/{site_id}/enable
Re-enables a site that was previously disabled by the user. Sites that were disabled for usage exceeded or marked as spam cannot be re-enabled via this endpoint.
PUT
/sites/{site_id}/disable
Disables a site, preventing it from serving content. The site can be re-enabled later using the enable endpoint.
Creates a new database for the specified site. If a database already exists, returns the existing connection string. The database region defaults to the site's functions region if not specified.
GET
/sites/{site_id}/database
Returns the database connection string for the specified site.
DELETE
/sites/{site_id}/database
Deletes the database and all associated branches and snapshots for the specified site.
POST
/sites/{site_id}/database/branch
Creates a new database branch for a deploy. If a branch already exists for the specified deploy ID, returns the existing connection string.
GET
/sites/{site_id}/database/branch/{deploy_id}
Returns the database branch connection string for a specific deploy.
DELETE
/sites/{site_id}/database/branch/{deploy_id}
Deletes a database branch associated with a deploy.
POST
/sites/{site_id}/database/snapshot
Creates a point-in-time snapshot of a database branch. Defaults to the production branch if no branch name is specified.
Restores a snapshot to a database branch. Defaults to the production branch if no branch_name is specified.
accounts
Method
Path
Description
GET
/accounts/{account_id}/env
Returns all environment variables for an account or site. An account corresponds to a team in the Netlify UI.
POST
/accounts/{account_id}/env
Creates new environment variables. Granular scopes are available on Pro plans and above.
GET
/accounts/{account_id}/env/{key}
Returns an individual environment variable.
PUT
/accounts/{account_id}/env/{key}
Updates an existing environment variable and all of its values. Existing values will be replaced by values provided.
PATCH
/accounts/{account_id}/env/{key}
Updates or creates a new value for an existing environment variable.
DELETE
/accounts/{account_id}/env/{key}
Deletes an environment variable
DELETE
/accounts/{account_id}/env/{key}/value/{id}
Deletes a specific environment variable value.
GET
/accounts/types
GET
/accounts
POST
/accounts
GET
/accounts/{account_id}
PUT
/accounts/{account_id}
DELETE
/accounts/{account_id}
GET
/accounts/{account_id}/audit
GET
/accounts/{account_id}/ai-gateway/token
Returns an AI Gateway token scoped to an account
api
Method
Path
Description
GET
/api/v1/sites/{site_id}/env
Returns all environment variables for a site. This convenience method behaves the same as getEnvVars but doesn't require an account_id as input.
purge
Method
Path
Description
POST
/purge
Purges cached content from Netlify's CDN. Supports purging by Cache-Tag.
deploys
Method
Path
Description
POST
/deploys/{deploy_id}/cancel
GET
/deploys/{deploy_id}
DELETE
/deploys/{deploy_id}
PATCH
/deploys/{deploy_id}/validations_report
Updates the deploy validations report for a deploy.
POST
/deploys/{deploy_id}/lock
POST
/deploys/{deploy_id}/unlock
PUT
/deploys/{deploy_id}/files/{path}
PUT
/deploys/{deploy_id}/functions/{name}
POST
/deploys/{deploy_id}/plugin_runs
This is an internal-only endpoint.
builds
Method
Path
Description
GET
/builds/{build_id}
POST
/builds/{build_id}/log
POST
/builds/{build_id}/start
{account_id}
Method
Path
Description
GET
/{account_id}/builds/status
forms
Method
Path
Description
GET
/forms/{form_id}/submissions
hooks
Method
Path
Description
GET
/hooks
POST
/hooks
GET
/hooks/{hook_id}
PUT
/hooks/{hook_id}
DELETE
/hooks/{hook_id}
POST
/hooks/{hook_id}/enable
GET
/hooks/types
oauth
Method
Path
Description
POST
/oauth/tickets
GET
/oauth/tickets/{ticket_id}
POST
/oauth/tickets/{ticket_id}/exchange
deploy_keys
Method
Path
Description
GET
/deploy_keys
POST
/deploy_keys
GET
/deploy_keys/{key_id}
DELETE
/deploy_keys/{key_id}
{account_slug}
Method
Path
Description
POST
/{account_slug}/sites
Note: Environment variable keys and values have moved from build_settings.env and repo.env to a new endpoint. Please use createEnvVars to create environment variables for a site.
GET
/{account_slug}/sites
Note: Environment variable keys and values have moved from build_settings.env and repo.env to a new endpoint. Please use getEnvVars to retrieve site environment variables.
