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:
[- {
- "id": "string",
- "uid": "string",
- "full_name": "string",
- "avatar_url": "string",
- "email": "string",
- "affiliate_id": "string",
- "site_count": 0,
- "created_at": "string",
- "last_login": "string",
- "login_providers": [
- "string"
], - "onboarding_progress": {
- "slides": "string"
}
}
]
name required | string |
type_id required | string |
payment_method_id | string |
period | string Enum: "monthly" "yearly" |
extra_seats_block | integer |
{- "name": "string",
- "type_id": "string",
- "payment_method_id": "string",
- "period": "monthly",
- "extra_seats_block": 0
}
{- "id": "string",
- "name": "string",
- "slug": "string",
- "type": "string",
- "capabilities": {
- "sites": {
- "included": 0,
- "used": 0
}, - "collaborators": {
- "included": 0,
- "used": 0
}
}, - "billing_name": "string",
- "billing_email": "string",
- "billing_details": "string",
- "billing_period": "string",
- "payment_method_id": "string",
- "type_name": "string",
- "type_id": "string",
- "owner_ids": [
- "string"
], - "roles_allowed": [
- "string"
], - "created_at": "string",
- "updated_at": "string"
}
[- {
- "id": "string",
- "name": "string",
- "slug": "string",
- "type": "string",
- "capabilities": {
- "sites": {
- "included": 0,
- "used": 0
}, - "collaborators": {
- "included": 0,
- "used": 0
}
}, - "billing_name": "string",
- "billing_email": "string",
- "billing_details": "string",
- "billing_period": "string",
- "payment_method_id": "string",
- "type_name": "string",
- "type_id": "string",
- "owner_ids": [
- "string"
], - "roles_allowed": [
- "string"
], - "created_at": "string",
- "updated_at": "string"
}
]
[- {
- "id": "string",
- "name": "string",
- "slug": "string",
- "type": "string",
- "capabilities": {
- "sites": {
- "included": 0,
- "used": 0
}, - "collaborators": {
- "included": 0,
- "used": 0
}
}, - "billing_name": "string",
- "billing_email": "string",
- "billing_details": "string",
- "billing_period": "string",
- "payment_method_id": "string",
- "type_name": "string",
- "type_id": "string",
- "owner_ids": [
- "string"
], - "roles_allowed": [
- "string"
], - "created_at": "string",
- "updated_at": "string"
}
]
account_id required | string |
name | string |
slug | string |
type_id | string |
extra_seats_block | integer |
billing_name | string |
billing_email | string |
billing_details | string |
{- "name": "string",
- "slug": "string",
- "type_id": "string",
- "extra_seats_block": 0,
- "billing_name": "string",
- "billing_email": "string",
- "billing_details": "string"
}
{- "id": "string",
- "name": "string",
- "slug": "string",
- "type": "string",
- "capabilities": {
- "sites": {
- "included": 0,
- "used": 0
}, - "collaborators": {
- "included": 0,
- "used": 0
}
}, - "billing_name": "string",
- "billing_email": "string",
- "billing_details": "string",
- "billing_period": "string",
- "payment_method_id": "string",
- "type_name": "string",
- "type_id": "string",
- "owner_ids": [
- "string"
], - "roles_allowed": [
- "string"
], - "created_at": "string",
- "updated_at": "string"
}
account_slug required | string |
role | string Enum: "Owner" "Developer" "Billing Admin" "Reviewer" |
string |
{- "role": "Owner",
- "email": "string"
}
[- {
- "id": "string",
- "full_name": "string",
- "email": "string",
- "avatar": "string",
- "role": "string"
}
]
account_slug required | string |
member_id required | string |
role | string Enum: "Owner" "Developer" "Billing Admin" "Reviewer" |
site_access | string Enum: "all" "none" "selected" |
site_ids | Array of strings |
{- "role": "Owner",
- "site_access": "all",
- "site_ids": [
- "string"
]
}
{- "id": "string",
- "full_name": "string",
- "email": "string",
- "avatar": "string",
- "role": "string"
}
[- {
- "id": "string",
- "name": "string",
- "description": "string",
- "capabilities": { },
- "monthly_dollar_price": 0,
- "yearly_dollar_price": 0,
- "monthly_seats_addon_dollar_price": 0,
- "yearly_seats_addon_dollar_price": 0
}
]
[- {
- "id": "string",
- "method_name": "string",
- "type": "string",
- "state": "string",
- "data": {
- "card_type": "string",
- "last4": "string",
- "email": "string"
}, - "created_at": "string",
- "updated_at": "string"
}
]
account_id required | string |
query | string |
log_type | string |
page | integer <int32> |
per_page | integer <int32> |
[- {
- "id": "string",
- "account_id": "string",
- "payload": {
- "actor_id": "string",
- "actor_name": "string",
- "actor_email": "string",
- "action": "string",
- "timestamp": "string",
- "log_type": "string",
- "property1": { },
- "property2": { }
}
}
]
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.
configure_dns | boolean |
id | string |
state | string |
plan | string |
name | string |
custom_domain | string |
domain_aliases | Array of strings |
branch_deploy_custom_domain | string |
deploy_preview_custom_domain | string |
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 |
object (deploy) | |
account_id | string |
account_name | string |
account_slug | string |
git_provider | string |
deploy_hook | string |
object | |
object | |
object (repoInfo) | |
id_domain | string |
object | |
build_image | string |
prerender | string |
functions_region | string |
object (repoInfo) |
{- "id": "string",
- "state": "string",
- "plan": "string",
- "name": "string",
- "custom_domain": "string",
- "domain_aliases": [
- "string"
], - "branch_deploy_custom_domain": "string",
- "deploy_preview_custom_domain": "string",
- "password": "string",
- "notification_email": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "screenshot_url": "string",
- "created_at": "string",
- "updated_at": "string",
- "user_id": "string",
- "session_id": "string",
- "ssl": true,
- "force_ssl": true,
- "managed_dns": true,
- "deploy_url": "string",
- "published_deploy": {
- "id": "string",
- "site_id": "string",
- "user_id": "string",
- "build_id": "string",
- "state": "string",
- "name": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "deploy_url": "string",
- "deploy_ssl_url": "string",
- "screenshot_url": "string",
- "review_id": 0,
- "draft": true,
- "required": [
- "string"
], - "required_functions": [
- "string"
], - "error_message": "string",
- "branch": "string",
- "commit_ref": "string",
- "commit_url": "string",
- "skipped": true,
- "created_at": "string",
- "updated_at": "string",
- "published_at": "string",
- "title": "string",
- "context": "string",
- "locked": true,
- "review_url": "string",
- "framework": "string",
- "function_schedules": [
- {
- "name": "string",
- "cron": "string"
}
]
}, - "account_id": "string",
- "account_name": "string",
- "account_slug": "string",
- "git_provider": "string",
- "deploy_hook": "string",
- "capabilities": {
- "property1": { },
- "property2": { }
}, - "processing_settings": {
- "html": {
- "pretty_urls": true
}
}, - "build_settings": {
- "id": 0,
- "provider": "string",
- "deploy_key_id": "string",
- "repo_path": "string",
- "repo_branch": "string",
- "dir": "string",
- "functions_dir": "string",
- "cmd": "string",
- "allowed_branches": [
- "string"
], - "public_repo": true,
- "private_logs": true,
- "repo_url": "string",
- "env": {
- "property1": "string",
- "property2": "string"
}, - "installation_id": 0,
- "stop_builds": true
}, - "id_domain": "string",
- "default_hooks_data": {
- "access_token": "string"
}, - "build_image": "string",
- "prerender": "string",
- "functions_region": "string",
- "repo": {
- "id": 0,
- "provider": "string",
- "deploy_key_id": "string",
- "repo_path": "string",
- "repo_branch": "string",
- "dir": "string",
- "functions_dir": "string",
- "cmd": "string",
- "allowed_branches": [
- "string"
], - "public_repo": true,
- "private_logs": true,
- "repo_url": "string",
- "env": {
- "property1": "string",
- "property2": "string"
}, - "installation_id": 0,
- "stop_builds": true
}
}
{- "id": "string",
- "state": "string",
- "plan": "string",
- "name": "string",
- "custom_domain": "string",
- "domain_aliases": [
- "string"
], - "branch_deploy_custom_domain": "string",
- "deploy_preview_custom_domain": "string",
- "password": "string",
- "notification_email": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "screenshot_url": "string",
- "created_at": "string",
- "updated_at": "string",
- "user_id": "string",
- "session_id": "string",
- "ssl": true,
- "force_ssl": true,
- "managed_dns": true,
- "deploy_url": "string",
- "published_deploy": {
- "id": "string",
- "site_id": "string",
- "user_id": "string",
- "build_id": "string",
- "state": "string",
- "name": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "deploy_url": "string",
- "deploy_ssl_url": "string",
- "screenshot_url": "string",
- "review_id": 0,
- "draft": true,
- "required": [
- "string"
], - "required_functions": [
- "string"
], - "error_message": "string",
- "branch": "string",
- "commit_ref": "string",
- "commit_url": "string",
- "skipped": true,
- "created_at": "string",
- "updated_at": "string",
- "published_at": "string",
- "title": "string",
- "context": "string",
- "locked": true,
- "review_url": "string",
- "framework": "string",
- "function_schedules": [
- {
- "name": "string",
- "cron": "string"
}
]
}, - "account_id": "string",
- "account_name": "string",
- "account_slug": "string",
- "git_provider": "string",
- "deploy_hook": "string",
- "capabilities": {
- "property1": { },
- "property2": { }
}, - "processing_settings": {
- "html": {
- "pretty_urls": true
}
}, - "build_settings": {
- "id": 0,
- "provider": "string",
- "deploy_key_id": "string",
- "repo_path": "string",
- "repo_branch": "string",
- "dir": "string",
- "functions_dir": "string",
- "cmd": "string",
- "allowed_branches": [
- "string"
], - "public_repo": true,
- "private_logs": true,
- "repo_url": "string",
- "env": {
- "property1": "string",
- "property2": "string"
}, - "installation_id": 0,
- "stop_builds": true
}, - "id_domain": "string",
- "default_hooks_data": {
- "access_token": "string"
}, - "build_image": "string",
- "prerender": "string",
- "functions_region": "string"
}
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.
account_slug required | string |
configure_dns | boolean |
id | string |
state | string |
plan | string |
name | string |
custom_domain | string |
domain_aliases | Array of strings |
branch_deploy_custom_domain | string |
deploy_preview_custom_domain | string |
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 |
object (deploy) | |
account_id | string |
account_name | string |
account_slug | string |
git_provider | string |
deploy_hook | string |
object | |
object | |
object (repoInfo) | |
id_domain | string |
object | |
build_image | string |
prerender | string |
functions_region | string |
object (repoInfo) |
{- "id": "string",
- "state": "string",
- "plan": "string",
- "name": "string",
- "custom_domain": "string",
- "domain_aliases": [
- "string"
], - "branch_deploy_custom_domain": "string",
- "deploy_preview_custom_domain": "string",
- "password": "string",
- "notification_email": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "screenshot_url": "string",
- "created_at": "string",
- "updated_at": "string",
- "user_id": "string",
- "session_id": "string",
- "ssl": true,
- "force_ssl": true,
- "managed_dns": true,
- "deploy_url": "string",
- "published_deploy": {
- "id": "string",
- "site_id": "string",
- "user_id": "string",
- "build_id": "string",
- "state": "string",
- "name": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "deploy_url": "string",
- "deploy_ssl_url": "string",
- "screenshot_url": "string",
- "review_id": 0,
- "draft": true,
- "required": [
- "string"
], - "required_functions": [
- "string"
], - "error_message": "string",
- "branch": "string",
- "commit_ref": "string",
- "commit_url": "string",
- "skipped": true,
- "created_at": "string",
- "updated_at": "string",
- "published_at": "string",
- "title": "string",
- "context": "string",
- "locked": true,
- "review_url": "string",
- "framework": "string",
- "function_schedules": [
- {
- "name": "string",
- "cron": "string"
}
]
}, - "account_id": "string",
- "account_name": "string",
- "account_slug": "string",
- "git_provider": "string",
- "deploy_hook": "string",
- "capabilities": {
- "property1": { },
- "property2": { }
}, - "processing_settings": {
- "html": {
- "pretty_urls": true
}
}, - "build_settings": {
- "id": 0,
- "provider": "string",
- "deploy_key_id": "string",
- "repo_path": "string",
- "repo_branch": "string",
- "dir": "string",
- "functions_dir": "string",
- "cmd": "string",
- "allowed_branches": [
- "string"
], - "public_repo": true,
- "private_logs": true,
- "repo_url": "string",
- "env": {
- "property1": "string",
- "property2": "string"
}, - "installation_id": 0,
- "stop_builds": true
}, - "id_domain": "string",
- "default_hooks_data": {
- "access_token": "string"
}, - "build_image": "string",
- "prerender": "string",
- "functions_region": "string",
- "repo": {
- "id": 0,
- "provider": "string",
- "deploy_key_id": "string",
- "repo_path": "string",
- "repo_branch": "string",
- "dir": "string",
- "functions_dir": "string",
- "cmd": "string",
- "allowed_branches": [
- "string"
], - "public_repo": true,
- "private_logs": true,
- "repo_url": "string",
- "env": {
- "property1": "string",
- "property2": "string"
}, - "installation_id": 0,
- "stop_builds": true
}
}
{- "id": "string",
- "state": "string",
- "plan": "string",
- "name": "string",
- "custom_domain": "string",
- "domain_aliases": [
- "string"
], - "branch_deploy_custom_domain": "string",
- "deploy_preview_custom_domain": "string",
- "password": "string",
- "notification_email": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "screenshot_url": "string",
- "created_at": "string",
- "updated_at": "string",
- "user_id": "string",
- "session_id": "string",
- "ssl": true,
- "force_ssl": true,
- "managed_dns": true,
- "deploy_url": "string",
- "published_deploy": {
- "id": "string",
- "site_id": "string",
- "user_id": "string",
- "build_id": "string",
- "state": "string",
- "name": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "deploy_url": "string",
- "deploy_ssl_url": "string",
- "screenshot_url": "string",
- "review_id": 0,
- "draft": true,
- "required": [
- "string"
], - "required_functions": [
- "string"
], - "error_message": "string",
- "branch": "string",
- "commit_ref": "string",
- "commit_url": "string",
- "skipped": true,
- "created_at": "string",
- "updated_at": "string",
- "published_at": "string",
- "title": "string",
- "context": "string",
- "locked": true,
- "review_url": "string",
- "framework": "string",
- "function_schedules": [
- {
- "name": "string",
- "cron": "string"
}
]
}, - "account_id": "string",
- "account_name": "string",
- "account_slug": "string",
- "git_provider": "string",
- "deploy_hook": "string",
- "capabilities": {
- "property1": { },
- "property2": { }
}, - "processing_settings": {
- "html": {
- "pretty_urls": true
}
}, - "build_settings": {
- "id": 0,
- "provider": "string",
- "deploy_key_id": "string",
- "repo_path": "string",
- "repo_branch": "string",
- "dir": "string",
- "functions_dir": "string",
- "cmd": "string",
- "allowed_branches": [
- "string"
], - "public_repo": true,
- "private_logs": true,
- "repo_url": "string",
- "env": {
- "property1": "string",
- "property2": "string"
}, - "installation_id": 0,
- "stop_builds": true
}, - "id_domain": "string",
- "default_hooks_data": {
- "access_token": "string"
}, - "build_image": "string",
- "prerender": "string",
- "functions_region": "string"
}
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.
site_id required | string |
{- "id": "string",
- "state": "string",
- "plan": "string",
- "name": "string",
- "custom_domain": "string",
- "domain_aliases": [
- "string"
], - "branch_deploy_custom_domain": "string",
- "deploy_preview_custom_domain": "string",
- "password": "string",
- "notification_email": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "screenshot_url": "string",
- "created_at": "string",
- "updated_at": "string",
- "user_id": "string",
- "session_id": "string",
- "ssl": true,
- "force_ssl": true,
- "managed_dns": true,
- "deploy_url": "string",
- "published_deploy": {
- "id": "string",
- "site_id": "string",
- "user_id": "string",
- "build_id": "string",
- "state": "string",
- "name": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "deploy_url": "string",
- "deploy_ssl_url": "string",
- "screenshot_url": "string",
- "review_id": 0,
- "draft": true,
- "required": [
- "string"
], - "required_functions": [
- "string"
], - "error_message": "string",
- "branch": "string",
- "commit_ref": "string",
- "commit_url": "string",
- "skipped": true,
- "created_at": "string",
- "updated_at": "string",
- "published_at": "string",
- "title": "string",
- "context": "string",
- "locked": true,
- "review_url": "string",
- "framework": "string",
- "function_schedules": [
- {
- "name": "string",
- "cron": "string"
}
]
}, - "account_id": "string",
- "account_name": "string",
- "account_slug": "string",
- "git_provider": "string",
- "deploy_hook": "string",
- "capabilities": {
- "property1": { },
- "property2": { }
}, - "processing_settings": {
- "html": {
- "pretty_urls": true
}
}, - "build_settings": {
- "id": 0,
- "provider": "string",
- "deploy_key_id": "string",
- "repo_path": "string",
- "repo_branch": "string",
- "dir": "string",
- "functions_dir": "string",
- "cmd": "string",
- "allowed_branches": [
- "string"
], - "public_repo": true,
- "private_logs": true,
- "repo_url": "string",
- "env": {
- "property1": "string",
- "property2": "string"
}, - "installation_id": 0,
- "stop_builds": true
}, - "id_domain": "string",
- "default_hooks_data": {
- "access_token": "string"
}, - "build_image": "string",
- "prerender": "string",
- "functions_region": "string"
}
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.
name | string |
filter | string Enum: "all" "owner" "guest" |
page | integer <int32> |
per_page | integer <int32> |
[- {
- "id": "string",
- "state": "string",
- "plan": "string",
- "name": "string",
- "custom_domain": "string",
- "domain_aliases": [
- "string"
], - "branch_deploy_custom_domain": "string",
- "deploy_preview_custom_domain": "string",
- "password": "string",
- "notification_email": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "screenshot_url": "string",
- "created_at": "string",
- "updated_at": "string",
- "user_id": "string",
- "session_id": "string",
- "ssl": true,
- "force_ssl": true,
- "managed_dns": true,
- "deploy_url": "string",
- "published_deploy": {
- "id": "string",
- "site_id": "string",
- "user_id": "string",
- "build_id": "string",
- "state": "string",
- "name": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "deploy_url": "string",
- "deploy_ssl_url": "string",
- "screenshot_url": "string",
- "review_id": 0,
- "draft": true,
- "required": [
- "string"
], - "required_functions": [
- "string"
], - "error_message": "string",
- "branch": "string",
- "commit_ref": "string",
- "commit_url": "string",
- "skipped": true,
- "created_at": "string",
- "updated_at": "string",
- "published_at": "string",
- "title": "string",
- "context": "string",
- "locked": true,
- "review_url": "string",
- "framework": "string",
- "function_schedules": [
- {
- "name": "string",
- "cron": "string"
}
]
}, - "account_id": "string",
- "account_name": "string",
- "account_slug": "string",
- "git_provider": "string",
- "deploy_hook": "string",
- "capabilities": {
- "property1": { },
- "property2": { }
}, - "processing_settings": {
- "html": {
- "pretty_urls": true
}
}, - "build_settings": {
- "id": 0,
- "provider": "string",
- "deploy_key_id": "string",
- "repo_path": "string",
- "repo_branch": "string",
- "dir": "string",
- "functions_dir": "string",
- "cmd": "string",
- "allowed_branches": [
- "string"
], - "public_repo": true,
- "private_logs": true,
- "repo_url": "string",
- "env": {
- "property1": "string",
- "property2": "string"
}, - "installation_id": 0,
- "stop_builds": true
}, - "id_domain": "string",
- "default_hooks_data": {
- "access_token": "string"
}, - "build_image": "string",
- "prerender": "string",
- "functions_region": "string"
}
]
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.
account_slug required | string |
name | string |
page | integer <int32> |
per_page | integer <int32> |
[- {
- "id": "string",
- "state": "string",
- "plan": "string",
- "name": "string",
- "custom_domain": "string",
- "domain_aliases": [
- "string"
], - "branch_deploy_custom_domain": "string",
- "deploy_preview_custom_domain": "string",
- "password": "string",
- "notification_email": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "screenshot_url": "string",
- "created_at": "string",
- "updated_at": "string",
- "user_id": "string",
- "session_id": "string",
- "ssl": true,
- "force_ssl": true,
- "managed_dns": true,
- "deploy_url": "string",
- "published_deploy": {
- "id": "string",
- "site_id": "string",
- "user_id": "string",
- "build_id": "string",
- "state": "string",
- "name": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "deploy_url": "string",
- "deploy_ssl_url": "string",
- "screenshot_url": "string",
- "review_id": 0,
- "draft": true,
- "required": [
- "string"
], - "required_functions": [
- "string"
], - "error_message": "string",
- "branch": "string",
- "commit_ref": "string",
- "commit_url": "string",
- "skipped": true,
- "created_at": "string",
- "updated_at": "string",
- "published_at": "string",
- "title": "string",
- "context": "string",
- "locked": true,
- "review_url": "string",
- "framework": "string",
- "function_schedules": [
- {
- "name": "string",
- "cron": "string"
}
]
}, - "account_id": "string",
- "account_name": "string",
- "account_slug": "string",
- "git_provider": "string",
- "deploy_hook": "string",
- "capabilities": {
- "property1": { },
- "property2": { }
}, - "processing_settings": {
- "html": {
- "pretty_urls": true
}
}, - "build_settings": {
- "id": 0,
- "provider": "string",
- "deploy_key_id": "string",
- "repo_path": "string",
- "repo_branch": "string",
- "dir": "string",
- "functions_dir": "string",
- "cmd": "string",
- "allowed_branches": [
- "string"
], - "public_repo": true,
- "private_logs": true,
- "repo_url": "string",
- "env": {
- "property1": "string",
- "property2": "string"
}, - "installation_id": 0,
- "stop_builds": true
}, - "id_domain": "string",
- "default_hooks_data": {
- "access_token": "string"
}, - "build_image": "string",
- "prerender": "string",
- "functions_region": "string"
}
]
[Beta] Unlinks the repo from the site.
This action will also:
site_id required | string |
{- "id": "string",
- "state": "string",
- "plan": "string",
- "name": "string",
- "custom_domain": "string",
- "domain_aliases": [
- "string"
], - "branch_deploy_custom_domain": "string",
- "deploy_preview_custom_domain": "string",
- "password": "string",
- "notification_email": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "screenshot_url": "string",
- "created_at": "string",
- "updated_at": "string",
- "user_id": "string",
- "session_id": "string",
- "ssl": true,
- "force_ssl": true,
- "managed_dns": true,
- "deploy_url": "string",
- "published_deploy": {
- "id": "string",
- "site_id": "string",
- "user_id": "string",
- "build_id": "string",
- "state": "string",
- "name": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "deploy_url": "string",
- "deploy_ssl_url": "string",
- "screenshot_url": "string",
- "review_id": 0,
- "draft": true,
- "required": [
- "string"
], - "required_functions": [
- "string"
], - "error_message": "string",
- "branch": "string",
- "commit_ref": "string",
- "commit_url": "string",
- "skipped": true,
- "created_at": "string",
- "updated_at": "string",
- "published_at": "string",
- "title": "string",
- "context": "string",
- "locked": true,
- "review_url": "string",
- "framework": "string",
- "function_schedules": [
- {
- "name": "string",
- "cron": "string"
}
]
}, - "account_id": "string",
- "account_name": "string",
- "account_slug": "string",
- "git_provider": "string",
- "deploy_hook": "string",
- "capabilities": {
- "property1": { },
- "property2": { }
}, - "processing_settings": {
- "html": {
- "pretty_urls": true
}
}, - "build_settings": {
- "id": 0,
- "provider": "string",
- "deploy_key_id": "string",
- "repo_path": "string",
- "repo_branch": "string",
- "dir": "string",
- "functions_dir": "string",
- "cmd": "string",
- "allowed_branches": [
- "string"
], - "public_repo": true,
- "private_logs": true,
- "repo_url": "string",
- "env": {
- "property1": "string",
- "property2": "string"
}, - "installation_id": 0,
- "stop_builds": true
}, - "id_domain": "string",
- "default_hooks_data": {
- "access_token": "string"
}, - "build_image": "string",
- "prerender": "string",
- "functions_region": "string"
}
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.
site_id required | string |
id | string |
state | string |
plan | string |
name | string |
custom_domain | string |
domain_aliases | Array of strings |
branch_deploy_custom_domain | string |
deploy_preview_custom_domain | string |
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 |
object (deploy) | |
account_id | string |
account_name | string |
account_slug | string |
git_provider | string |
deploy_hook | string |
object | |
object | |
object (repoInfo) | |
id_domain | string |
object | |
build_image | string |
prerender | string |
functions_region | string |
object (repoInfo) |
{- "id": "string",
- "state": "string",
- "plan": "string",
- "name": "string",
- "custom_domain": "string",
- "domain_aliases": [
- "string"
], - "branch_deploy_custom_domain": "string",
- "deploy_preview_custom_domain": "string",
- "password": "string",
- "notification_email": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "screenshot_url": "string",
- "created_at": "string",
- "updated_at": "string",
- "user_id": "string",
- "session_id": "string",
- "ssl": true,
- "force_ssl": true,
- "managed_dns": true,
- "deploy_url": "string",
- "published_deploy": {
- "id": "string",
- "site_id": "string",
- "user_id": "string",
- "build_id": "string",
- "state": "string",
- "name": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "deploy_url": "string",
- "deploy_ssl_url": "string",
- "screenshot_url": "string",
- "review_id": 0,
- "draft": true,
- "required": [
- "string"
], - "required_functions": [
- "string"
], - "error_message": "string",
- "branch": "string",
- "commit_ref": "string",
- "commit_url": "string",
- "skipped": true,
- "created_at": "string",
- "updated_at": "string",
- "published_at": "string",
- "title": "string",
- "context": "string",
- "locked": true,
- "review_url": "string",
- "framework": "string",
- "function_schedules": [
- {
- "name": "string",
- "cron": "string"
}
]
}, - "account_id": "string",
- "account_name": "string",
- "account_slug": "string",
- "git_provider": "string",
- "deploy_hook": "string",
- "capabilities": {
- "property1": { },
- "property2": { }
}, - "processing_settings": {
- "html": {
- "pretty_urls": true
}
}, - "build_settings": {
- "id": 0,
- "provider": "string",
- "deploy_key_id": "string",
- "repo_path": "string",
- "repo_branch": "string",
- "dir": "string",
- "functions_dir": "string",
- "cmd": "string",
- "allowed_branches": [
- "string"
], - "public_repo": true,
- "private_logs": true,
- "repo_url": "string",
- "env": {
- "property1": "string",
- "property2": "string"
}, - "installation_id": 0,
- "stop_builds": true
}, - "id_domain": "string",
- "default_hooks_data": {
- "access_token": "string"
}, - "build_image": "string",
- "prerender": "string",
- "functions_region": "string",
- "repo": {
- "id": 0,
- "provider": "string",
- "deploy_key_id": "string",
- "repo_path": "string",
- "repo_branch": "string",
- "dir": "string",
- "functions_dir": "string",
- "cmd": "string",
- "allowed_branches": [
- "string"
], - "public_repo": true,
- "private_logs": true,
- "repo_url": "string",
- "env": {
- "property1": "string",
- "property2": "string"
}, - "installation_id": 0,
- "stop_builds": true
}
}
{- "id": "string",
- "state": "string",
- "plan": "string",
- "name": "string",
- "custom_domain": "string",
- "domain_aliases": [
- "string"
], - "branch_deploy_custom_domain": "string",
- "deploy_preview_custom_domain": "string",
- "password": "string",
- "notification_email": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "screenshot_url": "string",
- "created_at": "string",
- "updated_at": "string",
- "user_id": "string",
- "session_id": "string",
- "ssl": true,
- "force_ssl": true,
- "managed_dns": true,
- "deploy_url": "string",
- "published_deploy": {
- "id": "string",
- "site_id": "string",
- "user_id": "string",
- "build_id": "string",
- "state": "string",
- "name": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "deploy_url": "string",
- "deploy_ssl_url": "string",
- "screenshot_url": "string",
- "review_id": 0,
- "draft": true,
- "required": [
- "string"
], - "required_functions": [
- "string"
], - "error_message": "string",
- "branch": "string",
- "commit_ref": "string",
- "commit_url": "string",
- "skipped": true,
- "created_at": "string",
- "updated_at": "string",
- "published_at": "string",
- "title": "string",
- "context": "string",
- "locked": true,
- "review_url": "string",
- "framework": "string",
- "function_schedules": [
- {
- "name": "string",
- "cron": "string"
}
]
}, - "account_id": "string",
- "account_name": "string",
- "account_slug": "string",
- "git_provider": "string",
- "deploy_hook": "string",
- "capabilities": {
- "property1": { },
- "property2": { }
}, - "processing_settings": {
- "html": {
- "pretty_urls": true
}
}, - "build_settings": {
- "id": 0,
- "provider": "string",
- "deploy_key_id": "string",
- "repo_path": "string",
- "repo_branch": "string",
- "dir": "string",
- "functions_dir": "string",
- "cmd": "string",
- "allowed_branches": [
- "string"
], - "public_repo": true,
- "private_logs": true,
- "repo_url": "string",
- "env": {
- "property1": "string",
- "property2": "string"
}, - "installation_id": 0,
- "stop_builds": true
}, - "id_domain": "string",
- "default_hooks_data": {
- "access_token": "string"
}, - "build_image": "string",
- "prerender": "string",
- "functions_region": "string"
}
Creates new environment variables. Granular scopes are available on Pro plans and above.
account_id required | string Scope response to account_id |
site_id | string If provided, create an environment variable on the site level, not the account level |
key | string The existing or new name of the key, if you wish to rename it (case-sensitive) |
scopes | Array of strings Items Enum: "builds" "functions" "runtime" "post-processing" The scopes that this environment variable is set to (Pro plans and above) |
Array of objects (envVarValue) | |
is_secret | boolean Secret values are only readable by code running on Netlify's systems. With secrets, only the local development context values are readable from the UI, API, and CLI. By default, environment variable values are not secret. |
[- {
- "key": "string",
- "scopes": [
- "builds"
], - "values": [
- {
- "id": "string",
- "value": "string",
- "context": "all",
- "context_parameter": "string"
}
], - "is_secret": true
}
]
[- {
- "key": "string",
- "scopes": [
- "builds"
], - "values": [
- {
- "id": "string",
- "value": "string",
- "context": "all",
- "context_parameter": "string"
}
], - "is_secret": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "updated_by": {
- "id": "string",
- "full_name": "string",
- "email": "string",
- "avatar_url": "string"
}
}
]
Deletes an environment variable
account_id required | string Scope response to account_id |
key required | string The environment variable key (case-sensitive) |
site_id | string If provided, delete the environment variable from this site |
{- "code": 0,
- "message": "string"
}
Deletes a specific environment variable value.
account_id required | string Scope response to account_id |
id required | string The environment variable value's ID |
key required | string The environment variable key name (case-sensitive) |
site_id | string If provided, delete the value from an environment variable on this site |
{- "code": 0,
- "message": "string"
}
Returns an individual environment variable.
account_id required | string Scope response to account_id |
key required | string The environment variable key (case-sensitive) |
site_id | string If provided, return the environment variable for a specific site (no merging is performed) |
{- "key": "string",
- "scopes": [
- "builds"
], - "values": [
- {
- "id": "string",
- "value": "string",
- "context": "all",
- "context_parameter": "string"
}
], - "is_secret": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "updated_by": {
- "id": "string",
- "full_name": "string",
- "email": "string",
- "avatar_url": "string"
}
}
Returns all environment variables for an account or site. An account corresponds to a team in the Netlify UI.
account_id required | string Scope response to account_id |
context_name | string Enum: "all" "dev" "branch-deploy" "deploy-preview" "production" Filter by deploy context |
scope | string Enum: "builds" "functions" "runtime" "post-processing" Filter by scope |
site_id | string If specified, only return environment variables set on this site |
[- {
- "key": "string",
- "scopes": [
- "builds"
], - "values": [
- {
- "id": "string",
- "value": "string",
- "context": "all",
- "context_parameter": "string"
}
], - "is_secret": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "updated_by": {
- "id": "string",
- "full_name": "string",
- "email": "string",
- "avatar_url": "string"
}
}
]
Returns all environment variables for a site. This convenience method behaves the same as getEnvVars
but doesn't require an account_id
as input.
site_id required | string Scope response to site_id |
context_name | string Enum: "all" "dev" "branch-deploy" "deploy-preview" "production" Filter by deploy context |
scope | string Enum: "builds" "functions" "runtime" "post_processing" Filter by scope |
[- {
- "key": "string",
- "scopes": [
- "builds"
], - "values": [
- {
- "id": "string",
- "value": "string",
- "context": "all",
- "context_parameter": "string"
}
], - "is_secret": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "updated_by": {
- "id": "string",
- "full_name": "string",
- "email": "string",
- "avatar_url": "string"
}
}
]
Updates or creates a new value for an existing environment variable.
account_id required | string Scope response to account_id |
key required | string The existing environment variable key name (case-sensitive) |
site_id | string If provided, update an environment variable set on this site |
context | string Enum: "all" "dev" "branch-deploy" "deploy-preview" "production" "branch" The deploy context in which this value will be used. |
context_parameter | string An additional parameter for custom branches. Currently, this is used for providing a branch name when |
value | string The environment variable's unencrypted value |
{- "context": "all",
- "context_parameter": "string",
- "value": "string"
}
{- "key": "string",
- "scopes": [
- "builds"
], - "values": [
- {
- "id": "string",
- "value": "string",
- "context": "all",
- "context_parameter": "string"
}
], - "is_secret": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "updated_by": {
- "id": "string",
- "full_name": "string",
- "email": "string",
- "avatar_url": "string"
}
}
Updates an existing environment variable and all of its values. Existing values will be replaced by values provided.
account_id required | string Scope response to account_id |
key required | string The existing environment variable key name (case-sensitive) |
site_id | string If provided, update an environment variable set on this site |
key | string The existing or new name of the key, if you wish to rename it (case-sensitive) |
scopes | Array of strings Items Enum: "builds" "functions" "runtime" "post-processing" The scopes that this environment variable is set to (Pro plans and above) |
Array of objects (envVarValue) | |
is_secret | boolean Secret values are only readable by code running on Netlify's systems. With secrets, only the local development context values are readable from the UI, API, and CLI. By default, environment variable values are not secret. |
{- "key": "string",
- "scopes": [
- "builds"
], - "values": [
- {
- "id": "string",
- "value": "string",
- "context": "all",
- "context_parameter": "string"
}
], - "is_secret": true
}
{- "key": "string",
- "scopes": [
- "builds"
], - "values": [
- {
- "id": "string",
- "value": "string",
- "context": "all",
- "context_parameter": "string"
}
], - "is_secret": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "updated_by": {
- "id": "string",
- "full_name": "string",
- "email": "string",
- "avatar_url": "string"
}
}
deploy_id required | string |
path required | string |
size | integer |
{- "id": "string",
- "path": "string",
- "sha": "string",
- "mime_type": "string",
- "size": 0
}
Purges cached content from Netlify's CDN. Supports purging by Cache-Tag.
site_id | string |
site_slug | string |
cache_tags | Array of strings |
{- "site_id": "string",
- "site_slug": "string",
- "cache_tags": [
- "string"
]
}
site_id required | string |
id | integer <int32> |
site_id | string |
title | string |
general | string |
general_position | string |
goal | string |
goal_position | string |
{- "id": 0,
- "site_id": "string",
- "title": "string",
- "general": "string",
- "general_position": "string",
- "goal": "string",
- "goal_position": "string"
}
{- "id": 0,
- "site_id": "string",
- "title": "string",
- "general": "string",
- "general_position": "string",
- "goal": "string",
- "goal_position": "string"
}
site_id required | string |
snippet_id required | string |
{- "id": 0,
- "site_id": "string",
- "title": "string",
- "general": "string",
- "general_position": "string",
- "goal": "string",
- "goal_position": "string"
}
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 |
{- "id": 0,
- "site_id": "string",
- "title": "string",
- "general": "string",
- "general_position": "string",
- "goal": "string",
- "goal_position": "string"
}
{- "code": 0,
- "message": "string"
}
[- {
- "id": "string",
- "name": "string",
- "errors": [
- "string"
], - "supported_record_types": [
- "string"
], - "user_id": "string",
- "created_at": "string",
- "updated_at": "string",
- "records": [
- {
- "id": "string",
- "hostname": "string",
- "type": "string",
- "value": "string",
- "ttl": 0,
- "priority": 0,
- "dns_zone_id": "string",
- "site_id": "string",
- "flag": 0,
- "tag": "string",
- "managed": true
}
], - "dns_servers": [
- "string"
], - "account_id": "string",
- "site_id": "string",
- "account_slug": "string",
- "account_name": "string",
- "domain": "string",
- "ipv6_enabled": true,
- "dedicated": true
}
]
zone_id required | string |
type | string |
hostname | string |
value | string |
ttl | integer <int64> |
priority | integer <int64> |
weight | integer <int64> |
port | integer <int64> |
flag | integer <int64> |
tag | string |
{- "type": "string",
- "hostname": "string",
- "value": "string",
- "ttl": 0,
- "priority": 0,
- "weight": 0,
- "port": 0,
- "flag": 0,
- "tag": "string"
}
{- "id": "string",
- "hostname": "string",
- "type": "string",
- "value": "string",
- "ttl": 0,
- "priority": 0,
- "dns_zone_id": "string",
- "site_id": "string",
- "flag": 0,
- "tag": "string",
- "managed": true
}
account_slug | string |
site_id | string |
name | string |
{- "account_slug": "string",
- "site_id": "string",
- "name": "string"
}
{- "id": "string",
- "name": "string",
- "errors": [
- "string"
], - "supported_record_types": [
- "string"
], - "user_id": "string",
- "created_at": "string",
- "updated_at": "string",
- "records": [
- {
- "id": "string",
- "hostname": "string",
- "type": "string",
- "value": "string",
- "ttl": 0,
- "priority": 0,
- "dns_zone_id": "string",
- "site_id": "string",
- "flag": 0,
- "tag": "string",
- "managed": true
}
], - "dns_servers": [
- "string"
], - "account_id": "string",
- "site_id": "string",
- "account_slug": "string",
- "account_name": "string",
- "domain": "string",
- "ipv6_enabled": true,
- "dedicated": true
}
[- {
- "id": "string",
- "name": "string",
- "errors": [
- "string"
], - "supported_record_types": [
- "string"
], - "user_id": "string",
- "created_at": "string",
- "updated_at": "string",
- "records": [
- {
- "id": "string",
- "hostname": "string",
- "type": "string",
- "value": "string",
- "ttl": 0,
- "priority": 0,
- "dns_zone_id": "string",
- "site_id": "string",
- "flag": 0,
- "tag": "string",
- "managed": true
}
], - "dns_servers": [
- "string"
], - "account_id": "string",
- "site_id": "string",
- "account_slug": "string",
- "account_name": "string",
- "domain": "string",
- "ipv6_enabled": true,
- "dedicated": true
}
]
[- {
- "id": "string",
- "hostname": "string",
- "type": "string",
- "value": "string",
- "ttl": 0,
- "priority": 0,
- "dns_zone_id": "string",
- "site_id": "string",
- "flag": 0,
- "tag": "string",
- "managed": true
}
]
{- "id": "string",
- "name": "string",
- "errors": [
- "string"
], - "supported_record_types": [
- "string"
], - "user_id": "string",
- "created_at": "string",
- "updated_at": "string",
- "records": [
- {
- "id": "string",
- "hostname": "string",
- "type": "string",
- "value": "string",
- "ttl": 0,
- "priority": 0,
- "dns_zone_id": "string",
- "site_id": "string",
- "flag": 0,
- "tag": "string",
- "managed": true
}
], - "dns_servers": [
- "string"
], - "account_id": "string",
- "site_id": "string",
- "account_slug": "string",
- "account_name": "string",
- "domain": "string",
- "ipv6_enabled": true,
- "dedicated": true
}
[- {
- "id": "string",
- "name": "string",
- "errors": [
- "string"
], - "supported_record_types": [
- "string"
], - "user_id": "string",
- "created_at": "string",
- "updated_at": "string",
- "records": [
- {
- "id": "string",
- "hostname": "string",
- "type": "string",
- "value": "string",
- "ttl": 0,
- "priority": 0,
- "dns_zone_id": "string",
- "site_id": "string",
- "flag": 0,
- "tag": "string",
- "managed": true
}
], - "dns_servers": [
- "string"
], - "account_id": "string",
- "site_id": "string",
- "account_slug": "string",
- "account_name": "string",
- "domain": "string",
- "ipv6_enabled": true,
- "dedicated": true
}
]
zone_id required | string |
dns_record_id required | string |
{- "id": "string",
- "hostname": "string",
- "type": "string",
- "value": "string",
- "ttl": 0,
- "priority": 0,
- "dns_zone_id": "string",
- "site_id": "string",
- "flag": 0,
- "tag": "string",
- "managed": true
}
zone_id required | string |
account_id required | string the account of the dns zone |
transfer_account_id required | string the account you want to transfer the dns zone to |
transfer_user_id required | string the user you want to transfer the dns zone to |
{- "id": "string",
- "name": "string",
- "errors": [
- "string"
], - "supported_record_types": [
- "string"
], - "user_id": "string",
- "created_at": "string",
- "updated_at": "string",
- "records": [
- {
- "id": "string",
- "hostname": "string",
- "type": "string",
- "value": "string",
- "ttl": 0,
- "priority": 0,
- "dns_zone_id": "string",
- "site_id": "string",
- "flag": 0,
- "tag": "string",
- "managed": true
}
], - "dns_servers": [
- "string"
], - "account_id": "string",
- "site_id": "string",
- "account_slug": "string",
- "account_name": "string",
- "domain": "string",
- "ipv6_enabled": true,
- "dedicated": true
}
site_id required | string |
certificate | string |
key | string |
ca_certificates | string |
{- "state": "string",
- "domains": [
- "string"
], - "created_at": "string",
- "updated_at": "string",
- "expires_at": "string"
}
{- "id": "string",
- "site_id": "string",
- "user_id": "string",
- "build_id": "string",
- "state": "string",
- "name": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "deploy_url": "string",
- "deploy_ssl_url": "string",
- "screenshot_url": "string",
- "review_id": 0,
- "draft": true,
- "required": [
- "string"
], - "required_functions": [
- "string"
], - "error_message": "string",
- "branch": "string",
- "commit_ref": "string",
- "commit_url": "string",
- "skipped": true,
- "created_at": "string",
- "updated_at": "string",
- "published_at": "string",
- "title": "string",
- "context": "string",
- "locked": true,
- "review_url": "string",
- "framework": "string",
- "function_schedules": [
- {
- "name": "string",
- "cron": "string"
}
]
}
site_id required | string |
deploy-previews | boolean |
production | boolean |
state | string Enum: "new" "pending_review" "accepted" "rejected" "enqueued" "building" "uploading" "uploaded" "preparing" "prepared" "processing" "processed" "ready" "error" "retrying" |
branch | string |
latest-published | boolean |
title | string |
files | object |
draft | boolean |
async | boolean |
functions | object |
Array of objects (functionSchedule) | |
object | |
branch | string |
framework | string |
framework_version | string |
{- "files": { },
- "draft": true,
- "async": true,
- "functions": { },
- "function_schedules": [
- {
- "name": "string",
- "cron": "string"
}
], - "functions_config": {
- "property1": {
- "display_name": "string",
- "generator": "string",
- "build_data": { },
- "routes": [
- {
- "pattern": "string",
- "literal": "string",
- "expression": "string",
- "methods": [
- "GET"
], - "prefer_static": true
}
], - "excluded_routes": [
- {
- "pattern": "string",
- "literal": "string",
- "expression": "string"
}
], - "priority": 0,
- "traffic_rules": {
- "action": {
- "type": "string",
- "config": {
- "to": "string",
- "rate_limit_config": {
- "algorithm": "sliding_window",
- "window_size": 0,
- "window_limit": 0
}, - "aggregate": {
- "keys": [
- {
- "type": "ip"
}
]
}
}
}
}
}, - "property2": {
- "display_name": "string",
- "generator": "string",
- "build_data": { },
- "routes": [
- {
- "pattern": "string",
- "literal": "string",
- "expression": "string",
- "methods": [
- "GET"
], - "prefer_static": true
}
], - "excluded_routes": [
- {
- "pattern": "string",
- "literal": "string",
- "expression": "string"
}
], - "priority": 0,
- "traffic_rules": {
- "action": {
- "type": "string",
- "config": {
- "to": "string",
- "rate_limit_config": {
- "algorithm": "sliding_window",
- "window_size": 0,
- "window_limit": 0
}, - "aggregate": {
- "keys": [
- {
- "type": "ip"
}
]
}
}
}
}
}
}, - "branch": "string",
- "framework": "string",
- "framework_version": "string"
}
{- "id": "string",
- "site_id": "string",
- "user_id": "string",
- "build_id": "string",
- "state": "string",
- "name": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "deploy_url": "string",
- "deploy_ssl_url": "string",
- "screenshot_url": "string",
- "review_id": 0,
- "draft": true,
- "required": [
- "string"
], - "required_functions": [
- "string"
], - "error_message": "string",
- "branch": "string",
- "commit_ref": "string",
- "commit_url": "string",
- "skipped": true,
- "created_at": "string",
- "updated_at": "string",
- "published_at": "string",
- "title": "string",
- "context": "string",
- "locked": true,
- "review_url": "string",
- "framework": "string",
- "function_schedules": [
- {
- "name": "string",
- "cron": "string"
}
]
}
{- "id": "string",
- "site_id": "string",
- "user_id": "string",
- "build_id": "string",
- "state": "string",
- "name": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "deploy_url": "string",
- "deploy_ssl_url": "string",
- "screenshot_url": "string",
- "review_id": 0,
- "draft": true,
- "required": [
- "string"
], - "required_functions": [
- "string"
], - "error_message": "string",
- "branch": "string",
- "commit_ref": "string",
- "commit_url": "string",
- "skipped": true,
- "created_at": "string",
- "updated_at": "string",
- "published_at": "string",
- "title": "string",
- "context": "string",
- "locked": true,
- "review_url": "string",
- "framework": "string",
- "function_schedules": [
- {
- "name": "string",
- "cron": "string"
}
]
}
site_id required | string |
deploy_id required | string |
{- "id": "string",
- "site_id": "string",
- "user_id": "string",
- "build_id": "string",
- "state": "string",
- "name": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "deploy_url": "string",
- "deploy_ssl_url": "string",
- "screenshot_url": "string",
- "review_id": 0,
- "draft": true,
- "required": [
- "string"
], - "required_functions": [
- "string"
], - "error_message": "string",
- "branch": "string",
- "commit_ref": "string",
- "commit_url": "string",
- "skipped": true,
- "created_at": "string",
- "updated_at": "string",
- "published_at": "string",
- "title": "string",
- "context": "string",
- "locked": true,
- "review_url": "string",
- "framework": "string",
- "function_schedules": [
- {
- "name": "string",
- "cron": "string"
}
]
}
site_id required | string |
deploy-previews | boolean |
production | boolean |
state | string Enum: "new" "pending_review" "accepted" "rejected" "enqueued" "building" "uploading" "uploaded" "preparing" "prepared" "processing" "processed" "ready" "error" "retrying" |
branch | string |
latest-published | boolean |
page | integer <int32> |
per_page | integer <int32> |
[- {
- "id": "string",
- "site_id": "string",
- "user_id": "string",
- "build_id": "string",
- "state": "string",
- "name": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "deploy_url": "string",
- "deploy_ssl_url": "string",
- "screenshot_url": "string",
- "review_id": 0,
- "draft": true,
- "required": [
- "string"
], - "required_functions": [
- "string"
], - "error_message": "string",
- "branch": "string",
- "commit_ref": "string",
- "commit_url": "string",
- "skipped": true,
- "created_at": "string",
- "updated_at": "string",
- "published_at": "string",
- "title": "string",
- "context": "string",
- "locked": true,
- "review_url": "string",
- "framework": "string",
- "function_schedules": [
- {
- "name": "string",
- "cron": "string"
}
]
}
]
{- "id": "string",
- "site_id": "string",
- "user_id": "string",
- "build_id": "string",
- "state": "string",
- "name": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "deploy_url": "string",
- "deploy_ssl_url": "string",
- "screenshot_url": "string",
- "review_id": 0,
- "draft": true,
- "required": [
- "string"
], - "required_functions": [
- "string"
], - "error_message": "string",
- "branch": "string",
- "commit_ref": "string",
- "commit_url": "string",
- "skipped": true,
- "created_at": "string",
- "updated_at": "string",
- "published_at": "string",
- "title": "string",
- "context": "string",
- "locked": true,
- "review_url": "string",
- "framework": "string",
- "function_schedules": [
- {
- "name": "string",
- "cron": "string"
}
]
}
site_id required | string |
deploy_id required | string |
{- "id": "string",
- "site_id": "string",
- "user_id": "string",
- "build_id": "string",
- "state": "string",
- "name": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "deploy_url": "string",
- "deploy_ssl_url": "string",
- "screenshot_url": "string",
- "review_id": 0,
- "draft": true,
- "required": [
- "string"
], - "required_functions": [
- "string"
], - "error_message": "string",
- "branch": "string",
- "commit_ref": "string",
- "commit_url": "string",
- "skipped": true,
- "created_at": "string",
- "updated_at": "string",
- "published_at": "string",
- "title": "string",
- "context": "string",
- "locked": true,
- "review_url": "string",
- "framework": "string",
- "function_schedules": [
- {
- "name": "string",
- "cron": "string"
}
]
}
{- "id": "string",
- "site_id": "string",
- "user_id": "string",
- "build_id": "string",
- "state": "string",
- "name": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "deploy_url": "string",
- "deploy_ssl_url": "string",
- "screenshot_url": "string",
- "review_id": 0,
- "draft": true,
- "required": [
- "string"
], - "required_functions": [
- "string"
], - "error_message": "string",
- "branch": "string",
- "commit_ref": "string",
- "commit_url": "string",
- "skipped": true,
- "created_at": "string",
- "updated_at": "string",
- "published_at": "string",
- "title": "string",
- "context": "string",
- "locked": true,
- "review_url": "string",
- "framework": "string",
- "function_schedules": [
- {
- "name": "string",
- "cron": "string"
}
]
}
site_id required | string |
deploy_id required | string |
files | object |
draft | boolean |
async | boolean |
functions | object |
Array of objects (functionSchedule) | |
object | |
branch | string |
framework | string |
framework_version | string |
{- "files": { },
- "draft": true,
- "async": true,
- "functions": { },
- "function_schedules": [
- {
- "name": "string",
- "cron": "string"
}
], - "functions_config": {
- "property1": {
- "display_name": "string",
- "generator": "string",
- "build_data": { },
- "routes": [
- {
- "pattern": "string",
- "literal": "string",
- "expression": "string",
- "methods": [
- "GET"
], - "prefer_static": true
}
], - "excluded_routes": [
- {
- "pattern": "string",
- "literal": "string",
- "expression": "string"
}
], - "priority": 0,
- "traffic_rules": {
- "action": {
- "type": "string",
- "config": {
- "to": "string",
- "rate_limit_config": {
- "algorithm": "sliding_window",
- "window_size": 0,
- "window_limit": 0
}, - "aggregate": {
- "keys": [
- {
- "type": "ip"
}
]
}
}
}
}
}, - "property2": {
- "display_name": "string",
- "generator": "string",
- "build_data": { },
- "routes": [
- {
- "pattern": "string",
- "literal": "string",
- "expression": "string",
- "methods": [
- "GET"
], - "prefer_static": true
}
], - "excluded_routes": [
- {
- "pattern": "string",
- "literal": "string",
- "expression": "string"
}
], - "priority": 0,
- "traffic_rules": {
- "action": {
- "type": "string",
- "config": {
- "to": "string",
- "rate_limit_config": {
- "algorithm": "sliding_window",
- "window_size": 0,
- "window_limit": 0
}, - "aggregate": {
- "keys": [
- {
- "type": "ip"
}
]
}
}
}
}
}
}, - "branch": "string",
- "framework": "string",
- "framework_version": "string"
}
{- "id": "string",
- "site_id": "string",
- "user_id": "string",
- "build_id": "string",
- "state": "string",
- "name": "string",
- "url": "string",
- "ssl_url": "string",
- "admin_url": "string",
- "deploy_url": "string",
- "deploy_ssl_url": "string",
- "screenshot_url": "string",
- "review_id": 0,
- "draft": true,
- "required": [
- "string"
], - "required_functions": [
- "string"
], - "error_message": "string",
- "branch": "string",
- "commit_ref": "string",
- "commit_url": "string",
- "skipped": true,
- "created_at": "string",
- "updated_at": "string",
- "published_at": "string",
- "title": "string",
- "context": "string",
- "locked": true,
- "review_url": "string",
- "framework": "string",
- "function_schedules": [
- {
- "name": "string",
- "cron": "string"
}
]
}
site_id required | string |
image | string |
clear_cache | boolean |
{- "image": "string",
- "clear_cache": true
}
{- "id": "string",
- "deploy_id": "string",
- "sha": "string",
- "done": true,
- "error": "string",
- "created_at": "string"
}
[- {
- "active": 0,
- "pending_concurrency": 0,
- "enqueued": 0,
- "build_count": 0,
- "minutes": {
- "current": 0,
- "current_average_sec": 0,
- "previous": 0,
- "period_start_date": "string",
- "period_end_date": "string",
- "last_updated_at": "string"