Получить информацию о секрете организации

GET /orgs/{org}/actions/secrets/{secretname}

Описание

Этот метод позволяет получить метаданные секрета (без значения) в организации.

Токен

Требуется токен с правами на Чтение для Организации.

Заголовки

ПараметрОбязательныйОписание
acceptНетТип содержимого ответа. Рекомендуется установить значение application/vnd.gitverse.object+json;version=latest

Параметры пути

ПараметрОбязательныйОписание
orgДаНазвание организации
secretnameДаНазвание секрета

Тело запроса

Данный метод не требует тела запроса.

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

curl -X GET "https://api.gitverse.ru/orgs/myorg/actions/secrets/MY_SECRET" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/vnd.gitverse.object+json;version=1"

Ответ (200 OK)

Ответ содержит информацию о секрете организации.

{
  "name": "SECRET_NAME",
  "created_at": "2023-01-01T00:00:00Z"
}

Формат ответа: application/vnd.gitverse.object+json;version=1

Коды ответов

КодСтатусОписание
200OkЗапрос выполнен успешно, информация о секрете получена
400Bad RequestНекорректный запрос
401UnauthorizedНеобходима авторизация
403ForbiddenНедостаточно прав на выполнение
404Not FoundСекрет не найден
429Too Many RequestsПревышен лимит запросов
500Internal Server ErrorВнутренняя ошибка сервера

Пример тела ошибки

При ответе 400 тело ответа имеет следующий вид:

{
  "error": {
    "code": "BAD_REQUEST",
    "documentation_url": "https://gitverse.ru/docs/developers/public-api/",
    "message": "The request format is invalid",
    "status": 400
  }
}

Примечания

  • убедитесь, что токен API указан корректно и обладает необходимыми правами для доступа к организации;
  • секрет должен существовать в рамках указанной организации.