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
{- "id": "string",
- "client_id": "string",
- "authorized": true,
- "created_at": "string"
}
{- "id": "string",
- "client_id": "string",
- "authorized": true,
- "created_at": "string"
}
ticket_id required | string |
ok
error
{- "id": "string",
- "access_token": "string",
- "user_id": "string",
- "user_email": "string",
- "created_at": "string"
}
[- {
- "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"
}
}
]
[- {
- "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"
}
]
name required | string |
type_id required | string |
payment_method_id | string |
period | string Enum: "monthly" "yearly" |
extra_seats_block | integer |
Created
error
{- "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",