Netlifys API Documentation

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

accounts

api

purge

deploys

builds

{account_id}

forms

hooks

oauth

deploy_keys

{account_slug}

billing

agent_runners

submissions

services

user

dns_zones

ai-gateway

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all sites?" -> GET /sites
• "Create a site?" -> POST /sites
• "Get site details?" -> GET /sites/{site_id}
• "Partially update a site?" -> PATCH /sites/{site_id}
• "Delete a site?" -> DELETE /sites/{site_id}
• "Create a ssl?" -> POST /sites/{site_id}/ssl
• "List all ssl?" -> GET /sites/{site_id}/ssl
• "List all certificates?" -> GET /sites/{site_id}/ssl/certificates
• "List all env?" -> GET /accounts/{account_id}/env
• "Create a env?" -> POST /accounts/{account_id}/env
• "List all env?" -> GET /api/v1/sites/{site_id}/env
• "Get env details?" -> GET /accounts/{account_id}/env/{key}
• "Update a env?" -> PUT /accounts/{account_id}/env/{key}
• "Partially update a env?" -> PATCH /accounts/{account_id}/env/{key}
• "Delete a env?" -> DELETE /accounts/{account_id}/env/{key}
• "Delete a value?" -> DELETE /accounts/{account_id}/env/{key}/value/{id}
• "List all functions?" -> GET /sites/{site_id}/functions
• "List all forms?" -> GET /sites/{site_id}/forms
• "Delete a form?" -> DELETE /sites/{site_id}/forms/{form_id}
• "List all submissions?" -> GET /sites/{site_id}/submissions
• "List all files?" -> GET /sites/{site_id}/files
• "List all assets?" -> GET /sites/{site_id}/assets
• "Create a asset?" -> POST /sites/{site_id}/assets
• "Get asset details?" -> GET /sites/{site_id}/assets/{asset_id}
• "Update a asset?" -> PUT /sites/{site_id}/assets/{asset_id}
• "Delete a asset?" -> DELETE /sites/{site_id}/assets/{asset_id}
• "List all public_signature?" -> GET /sites/{site_id}/assets/{asset_id}/public_signature
• "Get file details?" -> GET /sites/{site_id}/files/{file_path}
• "Create a purge?" -> POST /purge
• "List all snippets?" -> GET /sites/{site_id}/snippets
• "Create a snippet?" -> POST /sites/{site_id}/snippets
• "Get snippet details?" -> GET /sites/{site_id}/snippets/{snippet_id}
• "Update a snippet?" -> PUT /sites/{site_id}/snippets/{snippet_id}
• "Delete a snippet?" -> DELETE /sites/{site_id}/snippets/{snippet_id}
• "List all metadata?" -> GET /sites/{site_id}/metadata
• "List all build_hooks?" -> GET /sites/{site_id}/build_hooks
• "Create a build_hook?" -> POST /sites/{site_id}/build_hooks
• "Get build_hook details?" -> GET /sites/{site_id}/build_hooks/{id}
• "Update a build_hook?" -> PUT /sites/{site_id}/build_hooks/{id}
• "Delete a build_hook?" -> DELETE /sites/{site_id}/build_hooks/{id}
• "List all deploys?" -> GET /sites/{site_id}/deploys
• "Create a deploy?" -> POST /sites/{site_id}/deploys
• "Get deploy details?" -> GET /sites/{site_id}/deploys/{deploy_id}
• "Update a deploy?" -> PUT /sites/{site_id}/deploys/{deploy_id}
• "Delete a deploy?" -> DELETE /sites/{site_id}/deploys/{deploy_id}
• "Create a cancel?" -> POST /deploys/{deploy_id}/cancel
• "Create a restore?" -> POST /sites/{site_id}/deploys/{deploy_id}/restore
• "List all builds?" -> GET /sites/{site_id}/builds
• "Create a build?" -> POST /sites/{site_id}/builds
• "List all deployed-branches?" -> GET /sites/{site_id}/deployed-branches
• "Get build details?" -> GET /builds/{build_id}
• "Create a log?" -> POST /builds/{build_id}/log
• "Create a start?" -> POST /builds/{build_id}/start
• "List all status?" -> GET /{account_id}/builds/status
• "List all dns?" -> GET /sites/{site_id}/dns
• "Get deploy details?" -> GET /deploys/{deploy_id}
• "Delete a deploy?" -> DELETE /deploys/{deploy_id}
• "Create a lock?" -> POST /deploys/{deploy_id}/lock
• "Create a unlock?" -> POST /deploys/{deploy_id}/unlock
• "Update a file?" -> PUT /deploys/{deploy_id}/files/{path}
• "Update a function?" -> PUT /deploys/{deploy_id}/functions/{name}
• "Update a plugin?" -> PUT /sites/{site_id}/plugins/{package}
• "List all latest?" -> GET /sites/{site_id}/plugin_runs/latest
• "Create a plugin_run?" -> POST /deploys/{deploy_id}/plugin_runs
• "List all submissions?" -> GET /forms/{form_id}/submissions
• "List all hooks?" -> GET /hooks
• "Create a hook?" -> POST /hooks
• "Get hook details?" -> GET /hooks/{hook_id}
• "Update a hook?" -> PUT /hooks/{hook_id}
• "Delete a hook?" -> DELETE /hooks/{hook_id}
• "Create a enable?" -> POST /hooks/{hook_id}/enable
• "List all types?" -> GET /hooks/types
• "Create a ticket?" -> POST /oauth/tickets
• "Get ticket details?" -> GET /oauth/tickets/{ticket_id}
• "Create a exchange?" -> POST /oauth/tickets/{ticket_id}/exchange
• "List all deploy_keys?" -> GET /deploy_keys
• "Create a deploy_key?" -> POST /deploy_keys
• "Get deploy_key details?" -> GET /deploy_keys/{key_id}
• "Delete a deploy_key?" -> DELETE /deploy_keys/{key_id}
• "Create a site?" -> POST /{account_slug}/sites
• "List all sites?" -> GET /{account_slug}/sites
• "List all members?" -> GET /{account_slug}/members
• "Create a member?" -> POST /{account_slug}/members
• "Get member details?" -> GET /{account_slug}/members/{member_id}
• "Update a member?" -> PUT /{account_slug}/members/{member_id}
• "Delete a member?" -> DELETE /{account_slug}/members/{member_id}
• "List all payment_methods?" -> GET /billing/payment_methods
• "List all types?" -> GET /accounts/types
• "List all accounts?" -> GET /accounts
• "Create a account?" -> POST /accounts
• "Get account details?" -> GET /accounts/{account_id}
• "Update a account?" -> PUT /accounts/{account_id}
• "Delete a account?" -> DELETE /accounts/{account_id}
• "Search audit?" -> GET /accounts/{account_id}/audit
• "List all agent_runners?" -> GET /agent_runners
• "Create a agent_runner?" -> POST /agent_runners
• "Create a upload_url?" -> POST /agent_runners/upload_url
• "Get agent_runner details?" -> GET /agent_runners/{agent_runner_id}
• "Partially update a agent_runner?" -> PATCH /agent_runners/{agent_runner_id}
• "Delete a agent_runner?" -> DELETE /agent_runners/{agent_runner_id}
• "Create a archive?" -> POST /agent_runners/{agent_runner_id}/archive
• "Create a pull_request?" -> POST /agent_runners/{agent_runner_id}/pull_request
• "Create a commit?" -> POST /agent_runners/{agent_runner_id}/commit
• "List all sessions?" -> GET /agent_runners/{agent_runner_id}/sessions
• "Create a session?" -> POST /agent_runners/{agent_runner_id}/sessions
• "Get session details?" -> GET /agent_runners/{agent_runner_id}/sessions/{agent_runner_session_id}
• "Partially update a session?" -> PATCH /agent_runners/{agent_runner_id}/sessions/{agent_runner_session_id}
• "Delete a session?" -> DELETE /agent_runners/{agent_runner_id}/sessions/{agent_runner_session_id}
• "Search submissions?" -> GET /submissions/{submission_id}
• "Delete a submission?" -> DELETE /submissions/{submission_id}
• "List all service-instances?" -> GET /sites/{site_id}/service-instances
• "Create a instance?" -> POST /sites/{site_id}/services/{addon}/instances
• "Get instance details?" -> GET /sites/{site_id}/services/{addon}/instances/{instance_id}
• "Update a instance?" -> PUT /sites/{site_id}/services/{addon}/instances/{instance_id}
• "Delete a instance?" -> DELETE /sites/{site_id}/services/{addon}/instances/{instance_id}
• "List all services?" -> GET /services/
• "Get service details?" -> GET /services/{addonName}
• "List all manifest?" -> GET /services/{addonName}/manifest
• "List all user?" -> GET /user
• "Create a traffic_split?" -> POST /sites/{site_id}/traffic_splits
• "List all traffic_splits?" -> GET /sites/{site_id}/traffic_splits
• "Update a traffic_split?" -> PUT /sites/{site_id}/traffic_splits/{split_test_id}
• "Get traffic_split details?" -> GET /sites/{site_id}/traffic_splits/{split_test_id}
• "Create a publish?" -> POST /sites/{site_id}/traffic_splits/{split_test_id}/publish
• "Create a unpublish?" -> POST /sites/{site_id}/traffic_splits/{split_test_id}/unpublish
• "Create a dns_zone?" -> POST /dns_zones
• "List all dns_zones?" -> GET /dns_zones
• "Get dns_zone details?" -> GET /dns_zones/{zone_id}
• "Delete a dns_zone?" -> DELETE /dns_zones/{zone_id}
• "List all dns_records?" -> GET /dns_zones/{zone_id}/dns_records
• "Create a dns_record?" -> POST /dns_zones/{zone_id}/dns_records
• "Get dns_record details?" -> GET /dns_zones/{zone_id}/dns_records/{dns_record_id}
• "Delete a dns_record?" -> DELETE /dns_zones/{zone_id}/dns_records/{dns_record_id}
• "List all dev_servers?" -> GET /sites/{site_id}/dev_servers
• "Create a dev_server?" -> POST /sites/{site_id}/dev_servers
• "Get dev_server details?" -> GET /sites/{site_id}/dev_servers/{dev_server_id}
• "Create a activity?" -> POST /sites/{site_id}/dev_servers/{dev_server_id}/activity
• "Create a state?" -> POST /sites/{site_id}/dev_servers/{dev_server_id}/state
• "List all dev_server_hooks?" -> GET /sites/{site_id}/dev_server_hooks
• "Create a dev_server_hook?" -> POST /sites/{site_id}/dev_server_hooks
• "Get dev_server_hook details?" -> GET /sites/{site_id}/dev_server_hooks/{id}
• "Update a dev_server_hook?" -> PUT /sites/{site_id}/dev_server_hooks/{id}
• "Delete a dev_server_hook?" -> DELETE /sites/{site_id}/dev_server_hooks/{id}
• "List all providers?" -> GET /ai-gateway/providers
• "List all token?" -> GET /sites/{site_id}/ai-gateway/token
• "List all token?" -> GET /accounts/{account_id}/ai-gateway/token
• "Create a database?" -> POST /sites/{site_id}/database
• "List all database?" -> GET /sites/{site_id}/database
• "Create a branch?" -> POST /sites/{site_id}/database/branch
• "Get branch details?" -> GET /sites/{site_id}/database/branch/{deploy_id}
• "Delete a branch?" -> DELETE /sites/{site_id}/database/branch/{deploy_id}
• "Create a snapshot?" -> POST /sites/{site_id}/database/snapshot
• "List all snapshots?" -> GET /sites/{site_id}/database/snapshots
• "Delete a snapshot?" -> DELETE /sites/{site_id}/database/snapshot/{snapshot_id}
• "Create a restore?" -> POST /sites/{site_id}/database/snapshot/{snapshot_id}/restore
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP