Netlify's API documentation
v2.4.0

api.netlify.com

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. Visit our Community forum to join the conversation about understanding and using Netlify’s API.

Additionally, we have two API clients for your convenience:

ticket

post /oauth/tickets

Query Params

client_id string

Responses

201 - ok
Body
authorized boolean
client_id string
created_at string
id string
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /oauth/tickets' --header 'ContentType: application/json'
get /oauth/tickets/{ticket_id}

Responses

200 - ok
Body
authorized boolean
client_id string
created_at string
id string
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /oauth/tickets/{ticket_id}' --header 'ContentType: application/json'

accessToken

post /oauth/tickets/{ticket_id}/exchange

Responses

201 - ok
Body
access_token string
created_at string
id string
user_email string
user_id string
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /oauth/tickets/{ticket_id}/exchange' --header 'ContentType: application/json'

user

get /user

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /user' --header 'ContentType: application/json'

accountMembership

get /accounts

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /accounts' --header 'ContentType: application/json'
post /accounts

Responses

201 - Created
Body
billing_details string
billing_email string
billing_name string
billing_period string
capabilities object
created_at string
id string
name string
owner_ids array
payment_method_id string
roles_allowed array
slug string
type string
type_id string
type_name string
updated_at string
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /accounts' --header 'ContentType: application/json'
delete /accounts/{account_id}

Responses

204 - Not Content
Body
default - error
Body
code integer
message string
Request sample:
curl --request DELETE --url 'api.netlify.com /accounts/{account_id}' --header 'ContentType: application/json'
get /accounts/{account_id}

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /accounts/{account_id}' --header 'ContentType: application/json'
put /accounts/{account_id}

Responses

200 - OK
Body
billing_details string
billing_email string
billing_name string
billing_period string
capabilities object
created_at string
id string
name string
owner_ids array
payment_method_id string
roles_allowed array
slug string
type string
type_id string
type_name string
updated_at string
default - error
Body
code integer
message string
Request sample:
curl --request PUT --url 'api.netlify.com /accounts/{account_id}' --header 'ContentType: application/json'

member

get /{account_slug}/members

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /{account_slug}/members' --header 'ContentType: application/json'
post /{account_slug}/members

Query Params

role string
email string

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /{account_slug}/members' --header 'ContentType: application/json'

accountType

get /accounts/types

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /accounts/types' --header 'ContentType: application/json'

paymentMethod

get /billing/payment_methods

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /billing/payment_methods' --header 'ContentType: application/json'

auditLog

get /accounts/{account_id}/audit

Query Params

query string
log_type string
page integer
per_page integer

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /accounts/{account_id}/audit' --header 'ContentType: application/json'

site

get /sites

Query Params

name string
filter string
page integer
per_page integer

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /sites' --header 'ContentType: application/json'
post /sites

Query Params

configure_dns boolean

Responses

201 - Created
Body
account_name string
account_slug string
admin_url string
build_image string
build_settings object
capabilities object
created_at string
custom_domain string
default_hooks_data object
deploy_hook string
deploy_url string
domain_aliases array
force_ssl boolean
git_provider string
id string
id_domain string
managed_dns boolean
name string
notification_email string
password string
plan string
prerender string
processing_settings object
published_deploy object
screenshot_url string
session_id string
ssl boolean
ssl_url string
state string
updated_at string
url string
user_id string
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /sites' --header 'ContentType: application/json'
delete /sites/{site_id}

Responses

204 - Deleted
Body
default - error
Body
code integer
message string
Request sample:
curl --request DELETE --url 'api.netlify.com /sites/{site_id}' --header 'ContentType: application/json'
get /sites/{site_id}

Responses

200 - OK
Body
account_name string
account_slug string
admin_url string
build_image string
build_settings object
capabilities object
created_at string
custom_domain string
default_hooks_data object
deploy_hook string
deploy_url string
domain_aliases array
force_ssl boolean
git_provider string
id string
id_domain string
managed_dns boolean
name string
notification_email string
password string
plan string
prerender string
processing_settings object
published_deploy object
screenshot_url string
session_id string
ssl boolean
ssl_url string
state string
updated_at string
url string
user_id string
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /sites/{site_id}' --header 'ContentType: application/json'
patch /sites/{site_id}

Responses

200 - OK
Body
account_name string
account_slug string
admin_url string
build_image string
build_settings object
capabilities object
created_at string
custom_domain string
default_hooks_data object
deploy_hook string
deploy_url string
domain_aliases array
force_ssl boolean
git_provider string
id string
id_domain string
managed_dns boolean
name string
notification_email string
password string
plan string
prerender string
processing_settings object
published_deploy object
screenshot_url string
session_id string
ssl boolean
ssl_url string
state string
updated_at string
url string
user_id string
default - error
Body
code integer
message string
Request sample:
curl --request PATCH --url 'api.netlify.com /sites/{site_id}' --header 'ContentType: application/json'
put /sites/{site_id}/unlink_repo

[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

Responses

200 - OK
Body
account_name string
account_slug string
admin_url string
build_image string
build_settings object
capabilities object
created_at string
custom_domain string
default_hooks_data object
deploy_hook string
deploy_url string
domain_aliases array
force_ssl boolean
git_provider string
id string
id_domain string
managed_dns boolean
name string
notification_email string
password string
plan string
prerender string
processing_settings object
published_deploy object
screenshot_url string
session_id string
ssl boolean
ssl_url string
state string
updated_at string
url string
user_id string
404 - Site not found
Body
Request sample:
curl --request PUT --url 'api.netlify.com /sites/{site_id}/unlink_repo' --header 'ContentType: application/json'
get /{account_slug}/sites

Query Params

name string
page integer
per_page integer

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /{account_slug}/sites' --header 'ContentType: application/json'
post /{account_slug}/sites

Query Params

configure_dns boolean

Responses

201 - Created
Body
account_name string
account_slug string
admin_url string
build_image string
build_settings object
capabilities object
created_at string
custom_domain string
default_hooks_data object
deploy_hook string
deploy_url string
domain_aliases array
force_ssl boolean
git_provider string
id string
id_domain string
managed_dns boolean
name string
notification_email string
password string
plan string
prerender string
processing_settings object
published_deploy object
screenshot_url string
session_id string
ssl boolean
ssl_url string
state string
updated_at string
url string
user_id string
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /{account_slug}/sites' --header 'ContentType: application/json'

file

put /deploys/{deploy_id}/files/{path}

Query Params

size integer

Responses

200 - OK
Body
id string
mime_type string
path string
sha string
size integer
default - error
Body
code integer
message string
Request sample:
curl --request PUT --url 'api.netlify.com /deploys/{deploy_id}/files/{path}' --header 'ContentType: application/json'
get /sites/{site_id}/files

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /sites/{site_id}/files' --header 'ContentType: application/json'
get /sites/{site_id}/files/{file_path}

Responses

200 - OK
Body
id string
mime_type string
path string
sha string
size integer
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /sites/{site_id}/files/{file_path}' --header 'ContentType: application/json'

metadata

get /sites/{site_id}/metadata

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /sites/{site_id}/metadata' --header 'ContentType: application/json'
put /sites/{site_id}/metadata

Responses

204 - No content
Body
default - error
Body
code integer
message string
Request sample:
curl --request PUT --url 'api.netlify.com /sites/{site_id}/metadata' --header 'ContentType: application/json'

snippet

get /sites/{site_id}/snippets

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /sites/{site_id}/snippets' --header 'ContentType: application/json'
post /sites/{site_id}/snippets

Responses

201 - OK
Body
general string
general_position string
goal string
goal_position string
id integer
site_id string
title string
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /sites/{site_id}/snippets' --header 'ContentType: application/json'
delete /sites/{site_id}/snippets/{snippet_id}

Responses

204 - No content
Body
default - error
Body
code integer
message string
Request sample:
curl --request DELETE --url 'api.netlify.com /sites/{site_id}/snippets/{snippet_id}' --header 'ContentType: application/json'
get /sites/{site_id}/snippets/{snippet_id}

Responses

200 - OK
Body
general string
general_position string
goal string
goal_position string
id integer
site_id string
title string
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /sites/{site_id}/snippets/{snippet_id}' --header 'ContentType: application/json'
put /sites/{site_id}/snippets/{snippet_id}

Responses

204 - No content
Body
default - error
Body
code integer
message string
Request sample:
curl --request PUT --url 'api.netlify.com /sites/{site_id}/snippets/{snippet_id}' --header 'ContentType: application/json'

dnsZone

get /dns_zones

Query Params

account_slug string

Responses

200 - get all DNS zones the user has access to
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /dns_zones' --header 'ContentType: application/json'
post /dns_zones

Responses

201 - Created
Body
account_id string
account_name string
account_slug string
created_at string
dedicated boolean
dns_servers array
domain string
errors array
id string
ipv6_enabled boolean
name string
records array
site_id string
supported_record_types array
updated_at string
user_id string
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /dns_zones' --header 'ContentType: application/json'
delete /dns_zones/{zone_id}

Responses

204 - delete a single DNS zone
Body
default - error
Body
code integer
message string
Request sample:
curl --request DELETE --url 'api.netlify.com /dns_zones/{zone_id}' --header 'ContentType: application/json'
get /dns_zones/{zone_id}

Responses

200 - get a single DNS zone
Body
account_id string
account_name string
account_slug string
created_at string
dedicated boolean
dns_servers array
domain string
errors array
id string
ipv6_enabled boolean
name string
records array
site_id string
supported_record_types array
updated_at string
user_id string
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /dns_zones/{zone_id}' --header 'ContentType: application/json'
get /dns_zones/{zone_id}/dns_records

Responses

200 - get all DNS records for a single DNS zone
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /dns_zones/{zone_id}/dns_records' --header 'ContentType: application/json'
post /dns_zones/{zone_id}/dns_records

Responses

201 - Created
Body
dns_zone_id string
flag integer
hostname string
id string
managed boolean
priority integer
site_id string
tag string
ttl integer
type string
value string
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /dns_zones/{zone_id}/dns_records' --header 'ContentType: application/json'
delete /dns_zones/{zone_id}/dns_records/{dns_record_id}

Responses

204 - record deleted
Body
default - error
Body
code integer
message string
Request sample:
curl --request DELETE --url 'api.netlify.com /dns_zones/{zone_id}/dns_records/{dns_record_id}' --header 'ContentType: application/json'
get /dns_zones/{zone_id}/dns_records/{dns_record_id}

Responses

200 - get a single DNS record
Body
dns_zone_id string
flag integer
hostname string
id string
managed boolean
priority integer
site_id string
tag string
ttl integer
type string
value string
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /dns_zones/{zone_id}/dns_records/{dns_record_id}' --header 'ContentType: application/json'
put /dns_zones/{zone_id}/transfer

Query Params

account_id string
the account of the dns zone
transfer_account_id string
the account you want to transfer the dns zone to
transfer_user_id string
the user you want to transfer the dns zone to

Responses

200 - transfer a DNS zone to another account
Body
account_id string
account_name string
account_slug string
created_at string
dedicated boolean
dns_servers array
domain string
errors array
id string
ipv6_enabled boolean
name string
records array
site_id string
supported_record_types array
updated_at string
user_id string
default - error
Body
code integer
message string
Request sample:
curl --request PUT --url 'api.netlify.com /dns_zones/{zone_id}/transfer' --header 'ContentType: application/json'
get /sites/{site_id}/dns

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /sites/{site_id}/dns' --header 'ContentType: application/json'
put /sites/{site_id}/dns

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request PUT --url 'api.netlify.com /sites/{site_id}/dns' --header 'ContentType: application/json'

sniCertificate

get /sites/{site_id}/ssl

Responses

200 - OK
Body
created_at string
domains array
expires_at string
state string
updated_at string
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /sites/{site_id}/ssl' --header 'ContentType: application/json'
post /sites/{site_id}/ssl

Query Params

certificate string
key string
ca_certificates string

Responses

200 - OK
Body
created_at string
domains array
expires_at string
state string
updated_at string
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /sites/{site_id}/ssl' --header 'ContentType: application/json'

deploy

get /deploys/{deploy_id}

Responses

200 - OK
Body
admin_url string
branch string
build_id string
commit_ref string
commit_url string
context string
created_at string
deploy_ssl_url string
deploy_url string
draft boolean
error_message string
framework string
id string
locked boolean
name string
published_at string
required array
required_functions array
review_id number
review_url string
screenshot_url string
site_capabilities object
site_id string
skipped boolean
ssl_url string
state string
title string
updated_at string
url string
user_id string
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /deploys/{deploy_id}' --header 'ContentType: application/json'
post /deploys/{deploy_id}/cancel

Responses

201 - Cancelled
Body
admin_url string
branch string
build_id string
commit_ref string
commit_url string
context string
created_at string
deploy_ssl_url string
deploy_url string
draft boolean
error_message string
framework string
id string
locked boolean
name string
published_at string
required array
required_functions array
review_id number
review_url string
screenshot_url string
site_capabilities object
site_id string
skipped boolean
ssl_url string
state string
title string
updated_at string
url string
user_id string
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /deploys/{deploy_id}/cancel' --header 'ContentType: application/json'
post /deploys/{deploy_id}/lock

Responses

200 - OK
Body
admin_url string
branch string
build_id string
commit_ref string
commit_url string
context string
created_at string
deploy_ssl_url string
deploy_url string
draft boolean
error_message string
framework string
id string
locked boolean
name string
published_at string
required array
required_functions array
review_id number
review_url string
screenshot_url string
site_capabilities object
site_id string
skipped boolean
ssl_url string
state string
title string
updated_at string
url string
user_id string
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /deploys/{deploy_id}/lock' --header 'ContentType: application/json'
post /deploys/{deploy_id}/unlock

Responses

200 - OK
Body
admin_url string
branch string
build_id string
commit_ref string
commit_url string
context string
created_at string
deploy_ssl_url string
deploy_url string
draft boolean
error_message string
framework string
id string
locked boolean
name string
published_at string
required array
required_functions array
review_id number
review_url string
screenshot_url string
site_capabilities object
site_id string
skipped boolean
ssl_url string
state string
title string
updated_at string
url string
user_id string
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /deploys/{deploy_id}/unlock' --header 'ContentType: application/json'
get /sites/{site_id}/deploys

Query Params

page integer
per_page integer

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /sites/{site_id}/deploys' --header 'ContentType: application/json'
post /sites/{site_id}/deploys

Query Params

title string

Responses

200 - OK
Body
admin_url string
branch string
build_id string
commit_ref string
commit_url string
context string
created_at string
deploy_ssl_url string
deploy_url string
draft boolean
error_message string
framework string
id string
locked boolean
name string
published_at string
required array
required_functions array
review_id number
review_url string
screenshot_url string
site_capabilities object
site_id string
skipped boolean
ssl_url string
state string
title string
updated_at string
url string
user_id string
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /sites/{site_id}/deploys' --header 'ContentType: application/json'
get /sites/{site_id}/deploys/{deploy_id}

Responses

200 - OK
Body
admin_url string
branch string
build_id string
commit_ref string
commit_url string
context string
created_at string
deploy_ssl_url string
deploy_url string
draft boolean
error_message string
framework string
id string
locked boolean
name string
published_at string
required array
required_functions array
review_id number
review_url string
screenshot_url string
site_capabilities object
site_id string
skipped boolean
ssl_url string
state string
title string
updated_at string
url string
user_id string
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /sites/{site_id}/deploys/{deploy_id}' --header 'ContentType: application/json'
put /sites/{site_id}/deploys/{deploy_id}

Responses

200 - OK
Body
admin_url string
branch string
build_id string
commit_ref string
commit_url string
context string
created_at string
deploy_ssl_url string
deploy_url string
draft boolean
error_message string
framework string
id string
locked boolean
name string
published_at string
required array
required_functions array
review_id number
review_url string
screenshot_url string
site_capabilities object
site_id string
skipped boolean
ssl_url string
state string
title string
updated_at string
url string
user_id string
default - error
Body
code integer
message string
Request sample:
curl --request PUT --url 'api.netlify.com /sites/{site_id}/deploys/{deploy_id}' --header 'ContentType: application/json'
post /sites/{site_id}/deploys/{deploy_id}/restore

Responses

201 - Created
Body
admin_url string
branch string
build_id string
commit_ref string
commit_url string
context string
created_at string
deploy_ssl_url string
deploy_url string
draft boolean
error_message string
framework string
id string
locked boolean
name string
published_at string
required array
required_functions array
review_id number
review_url string
screenshot_url string
site_capabilities object
site_id string
skipped boolean
ssl_url string
state string
title string
updated_at string
url string
user_id string
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /sites/{site_id}/deploys/{deploy_id}/restore' --header 'ContentType: application/json'
post /sites/{site_id}/rollback

Responses

204 - No content
Body
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /sites/{site_id}/rollback' --header 'ContentType: application/json'

deployedBranch

get /sites/{site_id}/deployed-branches

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /sites/{site_id}/deployed-branches' --header 'ContentType: application/json'

deployKey

get /deploy_keys

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /deploy_keys' --header 'ContentType: application/json'
post /deploy_keys

Responses

201 - Created
Body
created_at string
id string
public_key string
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /deploy_keys' --header 'ContentType: application/json'
delete /deploy_keys/{key_id}

Responses

204 - Not Content
Body
default - error
Body
code integer
message string
Request sample:
curl --request DELETE --url 'api.netlify.com /deploy_keys/{key_id}' --header 'ContentType: application/json'
get /deploy_keys/{key_id}

Responses

200 - OK
Body
created_at string
id string
public_key string
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /deploy_keys/{key_id}' --header 'ContentType: application/json'

build

get /builds/{build_id}

Responses

200 - OK
Body
created_at string
deploy_id string
done boolean
error string
id string
sha string
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /builds/{build_id}' --header 'ContentType: application/json'
post /builds/{build_id}/start

Responses

204 - No content
Body
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /builds/{build_id}/start' --header 'ContentType: application/json'
get /sites/{site_id}/builds

Query Params

page integer
per_page integer

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /sites/{site_id}/builds' --header 'ContentType: application/json'
post /sites/{site_id}/builds

Responses

200 - OK
Body
created_at string
deploy_id string
done boolean
error string
id string
sha string
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /sites/{site_id}/builds' --header 'ContentType: application/json'
get /{account_id}/builds/status

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /{account_id}/builds/status' --header 'ContentType: application/json'

buildLogMsg

post /builds/{build_id}/log

Responses

204 - No content
Body
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /builds/{build_id}/log' --header 'ContentType: application/json'

hook

get /hooks

Query Params

site_id string

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /hooks' --header 'ContentType: application/json'
post /hooks

Query Params

site_id string

Responses

201 - OK
Body
created_at string
data object
disabled boolean
event string
id string
site_id string
type string
updated_at string
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /hooks' --header 'ContentType: application/json'
delete /hooks/{hook_id}

Responses

204 - No content
Body
Request sample:
curl --request DELETE --url 'api.netlify.com /hooks/{hook_id}' --header 'ContentType: application/json'
get /hooks/{hook_id}

Responses

200 - OK
Body
created_at string
data object
disabled boolean
event string
id string
site_id string
type string
updated_at string
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /hooks/{hook_id}' --header 'ContentType: application/json'
put /hooks/{hook_id}

Responses

200 - OK
Body
created_at string
data object
disabled boolean
event string
id string
site_id string
type string
updated_at string
default - error
Body
code integer
message string
Request sample:
curl --request PUT --url 'api.netlify.com /hooks/{hook_id}' --header 'ContentType: application/json'
post /hooks/{hook_id}/enable

Responses

200 - OK
Body
created_at string
data object
disabled boolean
event string
id string
site_id string
type string
updated_at string
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /hooks/{hook_id}/enable' --header 'ContentType: application/json'

hookType

get /hooks/types

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /hooks/types' --header 'ContentType: application/json'

buildHook

get /sites/{site_id}/build_hooks

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /sites/{site_id}/build_hooks' --header 'ContentType: application/json'
post /sites/{site_id}/build_hooks

Responses

201 - Created
Body
branch string
created_at string
id string
site_id string
title string
url string
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /sites/{site_id}/build_hooks' --header 'ContentType: application/json'
delete /sites/{site_id}/build_hooks/{id}

Responses

204 - No content
Body
default - error
Body
code integer
message string
Request sample:
curl --request DELETE --url 'api.netlify.com /sites/{site_id}/build_hooks/{id}' --header 'ContentType: application/json'
get /sites/{site_id}/build_hooks/{id}

Responses

200 - OK
Body
branch string
created_at string
id string
site_id string
title string
url string
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /sites/{site_id}/build_hooks/{id}' --header 'ContentType: application/json'
put /sites/{site_id}/build_hooks/{id}

Responses

204 - No content
Body
default - error
Body
code integer
message string
Request sample:
curl --request PUT --url 'api.netlify.com /sites/{site_id}/build_hooks/{id}' --header 'ContentType: application/json'

service

get /services/

Query Params

search string

Responses

200 - services
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /services/' --header 'ContentType: application/json'
get /services/{addonName}

Responses

200 - services
Body
created_at string
description string
environments array
events array
icon string
id string
long_description string
manifest_url string
name string
service_path string
slug string
tags array
updated_at string
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /services/{addonName}' --header 'ContentType: application/json'
get /services/{addonName}/manifest

Responses

201 - retrieving from provider
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /services/{addonName}/manifest' --header 'ContentType: application/json'

serviceInstance

get /sites/{site_id}/service-instances

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /sites/{site_id}/service-instances' --header 'ContentType: application/json'
post /sites/{site_id}/services/{addon}/instances

Responses

201 - Created
Body
auth_url string
config object
created_at string
env object
external_attributes object
id string
service_name string
service_path string
service_slug string
snippets array
updated_at string
url string
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /sites/{site_id}/services/{addon}/instances' --header 'ContentType: application/json'
delete /sites/{site_id}/services/{addon}/instances/{instance_id}

Responses

204 - Deleted
Body
default - error
Body
code integer
message string
Request sample:
curl --request DELETE --url 'api.netlify.com /sites/{site_id}/services/{addon}/instances/{instance_id}' --header 'ContentType: application/json'
get /sites/{site_id}/services/{addon}/instances/{instance_id}

Responses

200 - OK
Body
auth_url string
config object
created_at string
env object
external_attributes object
id string
service_name string
service_path string
service_slug string
snippets array
updated_at string
url string
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /sites/{site_id}/services/{addon}/instances/{instance_id}' --header 'ContentType: application/json'
put /sites/{site_id}/services/{addon}/instances/{instance_id}

Responses

204 - No Content
Body
default - error
Body
code integer
message string
Request sample:
curl --request PUT --url 'api.netlify.com /sites/{site_id}/services/{addon}/instances/{instance_id}' --header 'ContentType: application/json'

function

put /deploys/{deploy_id}/functions/{name}

Query Params

runtime string
size integer

Responses

200 - OK
Body
id string
name string
sha string
default - error
Body
code integer
message string
Request sample:
curl --request PUT --url 'api.netlify.com /deploys/{deploy_id}/functions/{name}' --header 'ContentType: application/json'

form

get /sites/{site_id}/forms

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /sites/{site_id}/forms' --header 'ContentType: application/json'
delete /sites/{site_id}/forms/{form_id}

Responses

204 - Deleted
Body
default - error
Body
code integer
message string
Request sample:
curl --request DELETE --url 'api.netlify.com /sites/{site_id}/forms/{form_id}' --header 'ContentType: application/json'

submission

get /forms/{form_id}/submissions

Query Params

page integer
per_page integer

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /forms/{form_id}/submissions' --header 'ContentType: application/json'
get /sites/{site_id}/submissions

Query Params

page integer
per_page integer

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /sites/{site_id}/submissions' --header 'ContentType: application/json'
delete /submissions/{submission_id}

Responses

204 - Deleted
Body
default - error
Body
code integer
message string
Request sample:
curl --request DELETE --url 'api.netlify.com /submissions/{submission_id}' --header 'ContentType: application/json'
get /submissions/{submission_id}

Query Params

query string
page integer
per_page integer

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /submissions/{submission_id}' --header 'ContentType: application/json'

splitTest

get /sites/{site_id}/traffic_splits

Responses

200 - split_tests
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /sites/{site_id}/traffic_splits' --header 'ContentType: application/json'
post /sites/{site_id}/traffic_splits

Responses

201 - Created
Body
active boolean
branches array
created_at string
id string
name string
path string
site_id string
unpublished_at string
updated_at string
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /sites/{site_id}/traffic_splits' --header 'ContentType: application/json'
get /sites/{site_id}/traffic_splits/{split_test_id}

Responses

200 - split_test
Body
active boolean
branches array
created_at string
id string
name string
path string
site_id string
unpublished_at string
updated_at string
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /sites/{site_id}/traffic_splits/{split_test_id}' --header 'ContentType: application/json'
put /sites/{site_id}/traffic_splits/{split_test_id}

Responses

201 - Created
Body
active boolean
branches array
created_at string
id string
name string
path string
site_id string
unpublished_at string
updated_at string
default - error
Body
code integer
message string
Request sample:
curl --request PUT --url 'api.netlify.com /sites/{site_id}/traffic_splits/{split_test_id}' --header 'ContentType: application/json'
post /sites/{site_id}/traffic_splits/{split_test_id}/publish

Responses

204 - enable
Body
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /sites/{site_id}/traffic_splits/{split_test_id}/publish' --header 'ContentType: application/json'
post /sites/{site_id}/traffic_splits/{split_test_id}/unpublish

Responses

204 - disabled
Body
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /sites/{site_id}/traffic_splits/{split_test_id}/unpublish' --header 'ContentType: application/json'

asset

get /sites/{site_id}/assets

Responses

200 - OK
Body
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /sites/{site_id}/assets' --header 'ContentType: application/json'
post /sites/{site_id}/assets

Query Params

name string
size integer
content_type string
visibility string

Responses

201 - Created
Body
asset object
form object
default - error
Body
code integer
message string
Request sample:
curl --request POST --url 'api.netlify.com /sites/{site_id}/assets' --header 'ContentType: application/json'
delete /sites/{site_id}/assets/{asset_id}

Responses

204 - Deleted
Body
default - error
Body
code integer
message string
Request sample:
curl --request DELETE --url 'api.netlify.com /sites/{site_id}/assets/{asset_id}' --header 'ContentType: application/json'
get /sites/{site_id}/assets/{asset_id}

Responses

200 - OK
Body
content_type string
created_at string
creator_id string
id string
key string
name string
site_id string
size integer
state string
updated_at string
url string
visibility string
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /sites/{site_id}/assets/{asset_id}' --header 'ContentType: application/json'
put /sites/{site_id}/assets/{asset_id}

Query Params

state string

Responses

200 - Updated
Body
content_type string
created_at string
creator_id string
id string
key string
name string
site_id string
size integer
state string
updated_at string
url string
visibility string
default - error
Body
code integer
message string
Request sample:
curl --request PUT --url 'api.netlify.com /sites/{site_id}/assets/{asset_id}' --header 'ContentType: application/json'

assetPublicSignature

get /sites/{site_id}/assets/{asset_id}/public_signature

Responses

200 - OK
Body
url string
default - error
Body
code integer
message string
Request sample:
curl --request GET --url 'api.netlify.com /sites/{site_id}/assets/{asset_id}/public_signature' --header 'ContentType: application/json'