netlifys-api-documentation — quality + safety report

---
name: netlifys-api-documentation
description: "Netlify's API documentation API skill. Use when working with Netlify's API documentation for sites, accounts, api. Covers 165 endpoints."
version: 1.0.0
generator: lapsh
---

# Netlify's API documentation
API version: 2.50.0

## Auth
OAuth2

## Base URL
https://api.netlify.com/api/v1

## Setup
1. Configure auth: OAuth2
2. GET /sites -- verify access
3. POST /sites -- create first sites

## Endpoints

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](#tag/environmentVariables/operation/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](#tag/environmentVariables/operation/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](#tag/environmentVariables/operation/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](#tag/environmentVariables/operation/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. |
| GET | /sites/{site_id}/ssl |  |
| GET | /sites/{site_id}/ssl/certificates |  |
| GET | /sites/{site_id}/functions |  |
| GET | /sites/{site_id}/forms |  |
| DELETE | /sites/{site_id}/forms/{form_id} |  |
| GET | /sites/{site_id}/submissions |  |
| GET | /sites/{site_id}/files |  |
| GET | /sites/{site_id}/assets |  |
| POST | /sites/{site_id}/assets |  |
| GET | /sites/{site_id}/assets/{asset_id} |  |
| PUT | /sites/{site_id}/assets/{asset_id} |  |
| DELETE | /sites/{site_id}/assets/{asset_id} |  |
| GET | /sites/{site_id}/assets/{asset_id}/public_signature |  |
| GET | /sites/{site_id}/files/{file_path} |  |
| GET | /sites/{site_id}/snippets |  |
| POST | /sites/{site_id}/snippets |  |
| GET | /sites/{site_id}/snippets/{snippet_id} |  |
| PUT | /sites/{site_id}/snippets/{snippet_id} |  |
| DELETE | /sites/{site_id}/snippets/{snippet_id} |  |
| GET | /sites/{site_id}/metadata |  |
| PUT | /sites/{site_id}/metadata |  |
| GET | /sites/{site_id}/build_hooks |  |
| POST | /sites/{site_id}/build_hooks |  |
| GET | /sites/{site_id}/build_hooks/{id} |  |
| PUT | /sites/{site_id}/build_hooks/{id} |  |
| DELETE | /sites/{site_id}/build_hooks/{id} |  |
| GET | /sites/{site_id}/deploys |  |
| POST | /sites/{site_id}/deploys |  |
| GET | /sites/{site_id}/deploys/{deploy_id} |  |
| PUT | /sites/{site_id}/deploys/{deploy_id} |  |
| DELETE | /sites/{site_id}/deploys/{deploy_id} |  |
| POST | /sites/{site_id}/deploys/{deploy_id}/restore |  |
| GET | /sites/{site_id}/builds |  |
| POST | /sites/{site_id}/builds | 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. |
| GET | /sites/{site_id}/dns |  |
| PUT | /sites/{site_id}/dns |  |
| PUT | /sites/{site_id}/rollback |  |
| PUT | /sites/{site_id}/plugins/{package} | This is an internal-only endpoint. |
| GET | /sites/{site_id}/plugin_runs/latest | This is an internal-only endpoint. |
| GET | /sites/{site_id}/service-instances |  |
| POST | /sites/{site_id}/services/{addon}/instances |  |
| GET | /sites/{site_id}/services/{addon}/instances/{instance_id} |  |
| PUT | /sites/{site_id}/services/{addon}/instances/{instance_id} |  |
| DELETE | /sites/{site_id}/services/{addon}/instances/{instance_id} |  |
| POST | /sites/{site_id}/traffic_splits |  |
| GET | /sites/{site_id}/traffic_splits |  |
| PUT | /sites/{site_id}/traffic_splits/{split_test_id} |  |
| GET | /sites/{site_id}/traffic_splits/{split_test_id} |  |
| POST | /sites/{site_id}/traffic_splits/{split_test_id}/publish |  |
| POST | /sites/{site_id}/traffic_splits/{split_test_id}/unpublish |  |
| GET | /sites/{site_id}/dev_servers |  |
| POST | /sites/{site_id}/dev_servers |  |
| DELETE | /sites/{site_id}/dev_servers |  |
| GET | /sites/{site_id}/dev_servers/{dev_server_id} |  |
| POST | /sites/{site_id}/dev_servers/{dev_server_id}/activity |  |
| POST | /sites/{site_id}/dev_servers/{dev_server_id}/state |  |
| GET | /sites/{site_id}/dev_server_hooks |  |
| POST | /sites/{site_id}/dev_server_hooks |  |
| GET | /sites/{site_id}/dev_server_hooks/{id} |  |
| PUT | /sites/{site_id}/dev_server_hooks/{id} |  |
| DELETE | /sites/{site_id}/dev_server_hooks/{id} |  |
| GET | /sites/{site_id}/ai-gateway/token | Returns an AI Gateway token for a specific site |
| POST | /sites/{site_id}/database | 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. |
| GET | /sites/{site_id}/database/snapshots | Returns all snapshots for the site's database. |
| DELETE | /sites/{site_id}/database/snapshot/{snapshot_id} | Deletes a database snapshot. |
| POST | /sites/{site_id}/database/snapshot/{snapshot_id}/restore | 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](#tag/environmentVariables/operation/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](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment variables. |
| GET | /{account_slug}/members |  |
| POST | /{account_slug}/members |  |
| GET | /{account_slug}/members/{member_id} |  |
| PUT | /{account_slug}/members/{member_id} |  |
| DELETE | /{account_slug}/members/{member_id} |  |

### billing
| Method | Path | Description |
|--------|------|-------------|
| GET | /billing/payment_methods |  |

### agent_runners
| Method | Path | Description |
|--------|------|-------------|
| GET | /agent_runners |  |
| POST | /agent_runners |  |
| POST | /agent_runners/upload_url |  |
| GET | /agent_runners/{agent_runner_id} |  |
| PATCH | /agent_runners/{agent_runner_id} |  |
| DELETE | /agent_runners/{agent_runner_id} |  |
| POST | /agent_runners/{agent_runner_id}/archive |  |
| POST | /agent_runners/{agent_runner_id}/pull_request |  |
| POST | /agent_runners/{agent_runner_id}/commit |  |
| GET | /agent_runners/{agent_runner_id}/sessions |  |
| POST | /agent_runners/{agent_runner_id}/sessions |  |
| GET | /agent_runners/{agent_runner_id}/sessions/{agent_runner_session_id} |  |
| PATCH | /agent_runners/{agent_runner_id}/sessi

… (truncated)