Переменные окружения

Управление переменными окружения проекта через REST API. Глобальные переменные экспортируются во все контейнеры проекта. Все методы требуют токен аутентификации.

POST /v1/project/:projectId/environment/variable

Создаёт новую переменную окружения в проекте. Обязательное имя name (до 255 символов) делает переменную глобальной, если заканчивается на !; тот же эффект даёт флаг global — глобальная переменная экспортируется во все контейнеры проекта. Необязательное значение value ограничено 1024 символами. Имя должно быть уникальным (ошибка конфликта при совпадении), а количество переменных в проекте ограничено (ошибка при превышении лимита).

Параметры:

Body:

Пример запроса:

{
    "name": "DATABASE_URL",
    "value": "postgresql://localhost:5432/mydb",
    "global": false
}

Ответ:

{
    "id": "660e8400-e29b-41d4-a716-446655440030",
    "name": "DATABASE_URL",
    "value": "postgresql://localhost:5432/mydb",
    "global": false,
    "createdAt": "2024-01-15T10:30:00+00:00",
    "updatedAt": "2024-01-15T10:30:00+00:00"
}

Ошибки:

• 404 Not Found — Проект не найден
• 409 Conflict — Переменная с таким именем уже существует
• 400 Bad Request — Превышен лимит на количество переменных или невалидные параметры

PUT /v1/environment/variable/:variableId

Обновляет существующую переменную окружения. Изменить можно значение value (до 1024 символов) и флаг global — он управляет экспортом переменной во все контейнеры проекта; параметров для переименования переменной метод не предоставляет. В ответе возвращается обновлённый объект с новой датой updatedAt.

Параметры:

Body:

Пример запроса:

{
    "value": "postgresql://localhost:5432/newdb",
    "global": true
}

Ответ:

{
    "id": "660e8400-e29b-41d4-a716-446655440030",
    "name": "DATABASE_URL",
    "value": "postgresql://localhost:5432/newdb",
    "global": true,
    "createdAt": "2024-01-15T10:30:00+00:00",
    "updatedAt": "2024-01-15T11:00:00+00:00"
}

Ошибки:

• 404 Not Found — Переменная не найдена
• 400 Bad Request — Невалидные параметры

GET /v1/environment/variable/:variableId

Возвращает переменную окружения по её UUID в виде объекта EnvironmentVariableResponse. Ответ содержит имя и значение переменной, флаг global, показывающий, экспортируется ли она во все контейнеры проекта, а также даты создания и обновления.

Параметры:

Ответ:

{
    "id": "660e8400-e29b-41d4-a716-446655440030",
    "name": "DATABASE_URL",
    "value": "postgresql://localhost:5432/mydb",
    "global": false,
    "createdAt": "2024-01-15T10:30:00+00:00",
    "updatedAt": "2024-01-15T10:30:00+00:00"
}

Ошибки:

• 404 Not Found — Переменная не найдена

GET /v1/project/:projectId/environment/variables

Возвращает все переменные окружения проекта — массив объектов EnvironmentVariableResponse. Каждый элемент содержит имя, значение, флаг global и даты создания и обновления переменной. В список попадают как обычные, так и глобальные переменные.

Параметры:

Ответ:

[
    {
        "id": "660e8400-e29b-41d4-a716-446655440030",
        "name": "DATABASE_URL",
        "value": "postgresql://localhost:5432/mydb",
        "global": false,
        "createdAt": "2024-01-15T10:30:00+00:00",
        "updatedAt": "2024-01-15T10:30:00+00:00"
    }
]

Ошибки:

• 404 Not Found — Проект не найден

DELETE /v1/environment/variable/:variableId

Удаляет переменную окружения по её UUID. Успешное удаление подтверждается пустым ответом без тела, объект переменной не возвращается. При обращении к несуществующей переменной возвращается ошибка «не найден».

Параметры:

Ответ: 204 No Content — пустой ответ при успешном удалении.

Ошибки:

• 404 Not Found — Переменная не найдена