Status200
Ресурс

API Key

Manage API Keys for your project

Модель API Key

Свойства

  • Имя
    _id
    Тип
    Object ID
    Описание

    ID of this object

  • Имя
    createdAt
    Тип
    Date
    Описание

    Date and Time when the object was created.

  • Имя
    updatedAt
    Тип
    Date
    Описание

    Date and Time when the object was updated.

  • Имя
    project
    Тип
    Project
    Описание

    Relation to Project Resource in which this object belongs

  • Имя
    projectId
    Тип
    Object IDОбязательно
    Описание

    ID of your Project in which this object belongs

  • Имя
    name
    Тип
    TextОбязательно
    Описание

    Any friendly name of this object

  • Имя
    description
    Тип
    Long Text
    Описание

    Friendly description that will help you remember

  • Имя
    slug
    Тип
    SlugОбязательно
    Описание

    Friendly globally unique name for your object

  • Имя
    createdByUser
    Тип
    User
    Описание

    Relation to User who created this object (if this object was created by a User)

  • Имя
    createdByUserId
    Тип
    Object ID
    Описание

    User ID who created this object (if this object was created by a User)

  • Имя
    expiresAt
    Тип
    DateОбязательно
    Описание

    Date and Time when this API Key expires.

  • Имя
    apiKey
    Тип
    Object ID
    Описание

    Secret API Key

GETorPOST/api/api-key/get-list

Список

Этот метод возвращает постраничный список ваших объектов «API Key». По умолчанию на странице до десяти записей.

Необязательные query-параметры

  • limit
    число
    Сколько объектов вернуть. По умолчанию 10, максимум 100
  • skip
    число
    Сколько объектов пропустить (для пагинации)

Необязательное тело запроса

Запрос списка

POST
/api/api-key/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "expiresAt": true,
    "name": true,
    "projectId": true,
    "apiKey": true,
    "createdByUserId": true
  },
  "query": {
    "name": "Production API Key"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "376a3eb0-28fe-11f1-b591-3fdcef396aba",
      "expiresAt": "2025-12-31T23:59:59Z",
      "name": "Production API Key",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "apiKey": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    {
      "_id": "376a3eb1-28fe-11f1-b591-3fdcef396aba",
      "expiresAt": "2025-12-31T23:59:59Z",
      "name": "Production API Key",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "apiKey": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    {
      "_id": "376a3eb2-28fe-11f1-b591-3fdcef396aba",
      "expiresAt": "2025-12-31T23:59:59Z",
      "name": "Production API Key",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "apiKey": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ]
}
GETorPOST/api/api-key/:id/get-item

Получить по ID

Возвращает объект «API Key» по идентификатору.

  • id
    строка
    ID объекта

Необязательное тело запроса

  • select
    По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.

Запрос одного объекта

POST
/api/api-key/:id/get-item
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "expiresAt": true,
    "name": true,
    "projectId": true,
    "apiKey": true,
    "createdByUserId": true
  }
}

Ответ

{
  "_id": "376a3eb0-28fe-11f1-b591-3fdcef396aba",
  "expiresAt": "2025-12-31T23:59:59Z",
  "name": "Production API Key",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "apiKey": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
POST/api/api-key/count

Количество

Возвращает количество ваших объектов «API Key».

Необязательное тело запроса

Запрос количества

POST
/api/api-key/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "name": "Production API Key"
  }
}

Ответ

{
  "count": 107
}
POST/api/api-key

Создать API Key

Создаёт новый объект.

Запрос создания

POST
/api/api-key
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "expiresAt": "2025-12-31T23:59:59Z",
    "name": "Production API Key",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "description": "API key used for production environment monitoring and alerting integrations"
  }
}

Ответ

{
  "_id": "376a3eb0-28fe-11f1-b591-3fdcef396aba",
  "expiresAt": "2025-12-31T23:59:59Z",
  "name": "Production API Key",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "apiKey": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
PUT/api/api-key/:id

Обновить по ID

Обновляет объект по ID.

Альтернативные методы

Если клиент не поддерживает PUT, используйте POST или GET с теми же заголовками и телом:

POST/api/api-key/:id/update-item
GET/api/api-key/:id/update-item

Запрос обновления

PUT
/api/api-key/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "expiresAt": "2025-12-31T23:59:59Z",
    "name": "Production API Key",
    "description": "API key used for production environment monitoring and alerting integrations"
  }
}

Ответ

{}
DELETE/api/api-key/:id

Удалить по ID

Удаляет объект по ID.

Альтернативные методы

Если клиент не поддерживает DELETE, используйте POST или GET с теми же заголовками и телом:

POST/api/api-key/:id/delete-item
GET/api/api-key/:id/delete-item

Запрос удаления

DELETE
/api/api-key/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

Права доступа

Для операций с ресурсом у ключа API должны быть права. При их отсутствии вернётся ответ 4xx.

Права на чтение

Нужны для чтения API Key

  • Project Owner
  • Project Admin
  • Read API Key
  • Read All Project Resources

Права на создание

Нужны для создания API Key

  • Project Owner
  • Project Admin
  • Create API Key

Права на обновление

Нужны для обновления API Key

  • Project Owner
  • Project Admin
  • Edit API Key Permissions
  • Edit API Key

Права на удаление

Нужны для удаления API Key

  • Project Owner
  • Project Admin
  • Delete API Key