Download OpenAPI specification:Download
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:
client_id required | string |
ok
error
ticket_id required | string |
ok
error
name required | string |
type_id required | string |
payment_method_id | string |
period | string Enum: "monthly" "yearly" |
extra_seats_block | integer |
Created
error
account_id required | string |
name | string |
slug | string |
type_id | string |
extra_seats_block | integer |
billing_name | string |
billing_email | string |
billing_details | string |
OK
error
account_id required | string |
Not Content
error
account_slug required | string |
OK
error
account_slug required | string |
email required | string |
role | string Enum: "Owner" "Collaborator" "Controller" |
OK
error
account_id required | string |
query | string |
log_type | string |
OK
error
name | string |
filter | string Enum: "all" "owner" "guest" |
OK
error
configure_dns | boolean |
id | string |
state | string |
plan | string |
name | string |
custom_domain | string |
domain_aliases | Array of strings |
password | string |
notification_email | string |
url | string |
ssl_url | string |
admin_url | string |
screenshot_url | string |
created_at | string <dateTime> |
updated_at | string <dateTime> |
user_id | string |
session_id | string |
ssl | boolean |
force_ssl | boolean |
managed_dns | boolean |
deploy_url | string |
published_deploy | object (deploy) |
account_name | string |
account_slug | string |
git_provider | string |
deploy_hook | string |
capabilities | object |
processing_settings | object |
build_settings | object (repoInfo) |
id_domain | string |
default_hooks_data | object |
build_image | string |
repo | object (repoInfo) |
Created
error
site_id required | string |
id | string |
state | string |
plan | string |
name | string |
custom_domain | string |
domain_aliases | Array of strings |
password | string |
notification_email | string |
url | string |
ssl_url | string |
admin_url | string |
screenshot_url | string |
created_at | string <dateTime> |
updated_at | string <dateTime> |
user_id | string |
session_id | string |
ssl | boolean |
force_ssl | boolean |
managed_dns | boolean |
deploy_url | string |
published_deploy | object (deploy) |
account_name | string |
account_slug | string |
git_provider | string |
deploy_hook | string |
capabilities | object |
processing_settings | object |
build_settings | object (repoInfo) |
id_domain | string |
default_hooks_data | object |
build_image | string |
repo | object (repoInfo) |
OK
error
account_slug required | string |
configure_dns | boolean |
id | string |
state | string |
plan | string |
name | string |
custom_domain | string |
domain_aliases | Array of strings |
password | string |
notification_email | string |
url | string |
ssl_url | string |
admin_url | string |
screenshot_url | string |
created_at | string <dateTime> |
updated_at | string <dateTime> |
user_id | string |
session_id | string |
ssl | boolean |
force_ssl | boolean |
managed_dns | boolean |
deploy_url | string |
published_deploy | object (deploy) |
account_name | string |
account_slug | string |
git_provider | string |
deploy_hook | string |
capabilities | object |
processing_settings | object |
build_settings | object (repoInfo) |
id_domain | string |
default_hooks_data | object |
build_image | string |
repo | object (repoInfo) |
Created
error
account_slug required | string |
name | string |
OK
error
site_id required | string |
file_path required | string |
OK
error
deploy_id required | string |
path required | string |
size | integer |
OK
error
site_id required | string |
No content
error
site_id required | string |
OK
error
site_id required | string |
id | integer <int32> |
site_id | string |
title | string |
general | string |
general_position | string |
goal | string |
goal_position | string |
OK
error
site_id required | string |
snippet_id required | string |
OK
error
site_id required | string |
snippet_id required | string |
id | integer <int32> |
site_id | string |
title | string |
general | string |
general_position | string |
goal | string |
goal_position | string |
No content
error
site_id required | string |
snippet_id required | string |
No content
error
site_id required | string |
OK
error
site_id required | string |
certificate | string |
key | string |
ca_certificates | string |
OK
error
site_id required | string |
OK
error
site_id required | string |
OK
error
site_id required | string |
title | string |
files | object |
draft | boolean |
async | boolean |
functions | object |
OK
error
site_id required | string |
deploy_id required | string |
OK
error
site_id required | string |
deploy_id required | string |
files | object |
draft | boolean |
async | boolean |
functions | object |
OK
error
site_id required | string |
deploy_id required | string |
Created
error
deploy_id required | string |
OK
error
site_id required | string |
OK
error
key_id required | string |
Not Content
error
site_id required | string |
OK
error
site_id required | string |
OK
error
build_id required | string |
No content
error
build_id required | string |
No content
error
site_id required | string |
OK
error
site_id required | string |
id | string |
site_id | string |
type | string |
event | string |
data | object |
created_at | string <dateTime> |
updated_at | string <dateTime> |
disabled | boolean |
OK
error
hook_id required | string |
id | string |
site_id | string |
type | string |
event | string |
data | object |
created_at | string <dateTime> |
updated_at | string <dateTime> |
disabled | boolean |
OK
error
site_id required | string |
OK
error
site_id required | string |
id | string |
title | string |
branch | string |
url | string |
site_id | string |
created_at | string <dateTime> |
Created
error
site_id required | string |
id required | string |
OK
error
site_id required | string |
id required | string |
id | string |
title | string |
branch | string |
url | string |
site_id | string |
created_at | string <dateTime> |
No content
error
site_id required | string |
id required | string |
No content
error
addonName required | string |
services
error
addonName required | string |
retrieving from provider
error
site_id required | string |
addon required | string |
Created
error
site_id required | string |
addon required | string |
Created
error
site_id required | string |
addon required | string |
Created
error
site_id required | string |
addon required | string |
Deleted
error
deploy_id required | string |
name required | string |
runtime | string |
size | integer |
OK
error
site_id required | string |
OK
error
form_id required | string |
OK
error
submission_id required | string |
query | string |
OK
error
submission_id required | string |
Deleted
error
site_id required | string |
branch_tests | object |
Created
error
site_id required | string |
split_tests
error
site_id required | string |
split_test_id required | string |
branch_tests | object |
Created
error
site_id required | string |
split_test_id required | string |
split_test
error
site_id required | string |
split_test_id required | string |
enable
error
site_id required | string |
split_test_id required | string |
disabled
error
site_id required | string |
OK
error
site_id required | string |
name required | string |
size required | integer <int64> |
content_type required | string |
visibility | string |
Created
error
site_id required | string |
asset_id required | string |
OK
error
site_id required | string |
asset_id required | string |
state required | string |
Updated
error
site_id required | string |
asset_id required | string |
Deleted
error
site_id required | string |
asset_id required | string |
OK
error