REST API
Справочник REST API n8n
Аутентификация
Заголовок раздела «Аутентификация»API Key
Заголовок раздела «API Key»# Создание ключа: Settings → API → Create API Key
curl -H "X-N8N-API-KEY: your-api-key" \ https://n8n.example.com/api/v1/workflowsX-N8N-API-KEY: your-api-keyWorkflows
Заголовок раздела «Workflows»Получить все workflows
Заголовок раздела «Получить все workflows»GET /api/v1/workflowsResponse:
{ "data": [ { "id": "123", "name": "My Workflow", "active": true, "createdAt": "2025-01-15T10:00:00.000Z", "updatedAt": "2025-01-15T12:00:00.000Z" } ]}Получить workflow по ID
Заголовок раздела «Получить workflow по ID»GET /api/v1/workflows/{id}Создать workflow
Заголовок раздела «Создать workflow»POST /api/v1/workflowsContent-Type: application/json
{ "name": "New Workflow", "nodes": [...], "connections": {...}, "settings": {...}}Обновить workflow
Заголовок раздела «Обновить workflow»PUT /api/v1/workflows/{id}Content-Type: application/json
{ "name": "Updated Workflow", "nodes": [...], "connections": {...}}Удалить workflow
Заголовок раздела «Удалить workflow»DELETE /api/v1/workflows/{id}Активировать/деактивировать
Заголовок раздела «Активировать/деактивировать»POST /api/v1/workflows/{id}/activatePOST /api/v1/workflows/{id}/deactivateExecutions
Заголовок раздела «Executions»Получить executions
Заголовок раздела «Получить executions»GET /api/v1/executions
# С фильтрамиGET /api/v1/executions?workflowId=123&status=success&limit=10Parameters:
| Параметр | Описание |
|---|---|
workflowId | ID workflow |
status | success, error, waiting |
limit | Количество (max 250) |
Получить execution по ID
Заголовок раздела «Получить execution по ID»GET /api/v1/executions/{id}Удалить execution
Заголовок раздела «Удалить execution»DELETE /api/v1/executions/{id}Запуск Workflow
Заголовок раздела «Запуск Workflow»Manual Execute
Заголовок раздела «Manual Execute»POST /api/v1/workflows/{id}/executeContent-Type: application/json
{ "workflowData": {...} // опционально}Response:
{ "data": { "executionId": "456" }}Execute с данными
Заголовок раздела «Execute с данными»POST /api/v1/workflows/{id}/executeContent-Type: application/json
{ "workflowData": { "nodes": [...], "connections": {...} }}Credentials
Заголовок раздела «Credentials»Получить credentials (без секретов)
Заголовок раздела «Получить credentials (без секретов)»GET /api/v1/credentialsСоздать credential
Заголовок раздела «Создать credential»POST /api/v1/credentialsContent-Type: application/json
{ "name": "My API Key", "type": "httpHeaderAuth", "data": { "name": "Authorization", "value": "Bearer token" }}Удалить credential
Заголовок раздела «Удалить credential»DELETE /api/v1/credentials/{id}Users (Enterprise)
Заголовок раздела «Users (Enterprise)»Получить пользователей
Заголовок раздела «Получить пользователей»GET /api/v1/usersСоздать пользователя
Заголовок раздела «Создать пользователя»POST /api/v1/usersContent-Type: application/json
{ "email": "user@example.com", "firstName": "John", "lastName": "Doe", "role": "member"}Получить теги
Заголовок раздела «Получить теги»GET /api/v1/tagsСоздать тег
Заголовок раздела «Создать тег»POST /api/v1/tagsContent-Type: application/json
{ "name": "production"}Variables
Заголовок раздела «Variables»Получить переменные
Заголовок раздела «Получить переменные»GET /api/v1/variablesСоздать переменную
Заголовок раздела «Создать переменную»POST /api/v1/variablesContent-Type: application/json
{ "key": "API_URL", "value": "https://api.example.com"}Примеры использования
Заголовок раздела «Примеры использования»import requests
API_KEY = "your-api-key"BASE_URL = "https://n8n.example.com/api/v1"
headers = { "X-N8N-API-KEY": API_KEY, "Content-Type": "application/json"}
# Получить workflowsresponse = requests.get(f"{BASE_URL}/workflows", headers=headers)workflows = response.json()["data"]
# Запустить workflowresponse = requests.post( f"{BASE_URL}/workflows/123/execute", headers=headers)execution_id = response.json()["data"]["executionId"]JavaScript
Заголовок раздела «JavaScript»const API_KEY = 'your-api-key';const BASE_URL = 'https://n8n.example.com/api/v1';
async function getWorkflows() { const response = await fetch(`${BASE_URL}/workflows`, { headers: { 'X-N8N-API-KEY': API_KEY } }); return response.json();}
async function executeWorkflow(id) { const response = await fetch(`${BASE_URL}/workflows/${id}/execute`, { method: 'POST', headers: { 'X-N8N-API-KEY': API_KEY, 'Content-Type': 'application/json' } }); return response.json();}# Получить workflowscurl -H "X-N8N-API-KEY: key" \ https://n8n.example.com/api/v1/workflows
# Запустить workflowcurl -X POST \ -H "X-N8N-API-KEY: key" \ -H "Content-Type: application/json" \ https://n8n.example.com/api/v1/workflows/123/execute
# Создать workflowcurl -X POST \ -H "X-N8N-API-KEY: key" \ -H "Content-Type: application/json" \ -d '{"name":"Test","nodes":[],"connections":{}}' \ https://n8n.example.com/api/v1/workflowsRate Limits
Заголовок раздела «Rate Limits»| Endpoint | Limit |
|---|---|
| Общий | 100 req/min |
| Execute | 20 req/min |
| Код | Описание |
|---|---|
| 400 | Bad Request |
| 401 | Unauthorized (неверный API key) |
| 404 | Not Found |
| 429 | Rate Limit Exceeded |
| 500 | Internal Server Error |
Следующие шаги
Заголовок раздела «Следующие шаги»- CLI команды — командная строка
- Глоссарий — термины
- Переменные окружения — конфигурация