Listar API keys

GET

/api-keys

curl --request GET \
  --url 'https://api.inspow.tech/api/v1/api-keys?limit=10&offset=0&sortBy=createdAt&sortOrder=asc&sort=%7B%22lastName%22%3A%20-1%2C%20%22email%22%3A%201%7D' \
  --header 'Authorization: Bearer <token>'

• Producción
• Local

Obtiene una lista paginada de API keys con filtros opcionales

Authorizations

• bearer

Parameters

Query Parameters

limit

number

Example

10

Elementos por página

offset

required

number

Example

0

Number of items to skip

sortBy

string

Example

createdAt

Field to sort the results (Deprecated, use sort instead)

sortOrder

string

Example

asc

Sort direction, either asc or desc (Deprecated, use sort instead)

searchQuery

string

Query search to filter items

query

string

Query to filter items in MongoDB query format

sort

string

Example

{"lastName": -1, "email": 1}

JSON string specifying sorting fields and order (e.g. { “lastName”: -1, “email”: 1 })

includeAll

boolean

Incluir API keys de todos los usuarios (solo ADMIN)

page

number

Número de página

search

Buscar por nombre o descripción

scope

Filtrar por alcance

status

Filtrar por estado

Responses

200

Lista de API keys obtenida exitosamente

Media type application/json

object

success

required

Indica si la operación fue exitosa

boolean

message

required

Mensaje de respuesta

string

data

required

Lista de API keys

Array<object>

object

_id

required

ID único de la API key

string

keyId

required

Identificador público de la API key

string

name

required

Nombre descriptivo de la API key

string

description

Descripción detallada del propósito de la API key

string

status

required

Estado actual de la API key

string

Allowed values: active inactive revoked expired

scopes

required

Permisos/alcances de la API key

Array<string>

Allowed values: read_only write_only read_write admin

allowedOrigins

Dominios permitidos para usar la API key

Array<string>

allowedIPs

IPs permitidas para usar la API key

Array<string>

expiresAt

Fecha de expiración de la API key

string format: date-time

lastUsedAt

Fecha de último uso de la API key

string format: date-time

usageCount

required

Contador de usos de la API key

number

rateLimit

required

Límite de requests por hora

number

createdBy

required

ID del usuario que creó la API key

string

updatedBy

ID del usuario que actualizó la API key por última vez

string

metadata

Metadatos adicionales

object

createdAt

required

Fecha de creación

string format: date-time

updatedAt

required

Fecha de última actualización

string format: date-time

pagination

required

Información de paginación

object

total

number

page

number

limit

number

totalPages

number

Example

{
  "success": true,
  "message": "API keys obtenidas exitosamente",
  "data": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "keyId": "ak_1234567890abcdef",
      "name": "Integración con Sistema de Pagos",
      "description": "API key para permitir al sistema de pagos consultar facturas y crear pagos",
      "status": "active",
      "scopes": [
        "read_write"
      ],
      "allowedOrigins": [
        "https://mi-sistema.com",
        "https://staging.mi-sistema.com"
      ],
      "allowedIPs": [
        "192.168.1.100",
        "10.0.0.50"
      ],
      "expiresAt": "2024-12-31T23:59:59.000Z",
      "lastUsedAt": "2024-12-20T15:30:00.000Z",
      "usageCount": 42,
      "rateLimit": 1000,
      "createdBy": "507f1f77bcf86cd799439012",
      "updatedBy": "507f1f77bcf86cd799439013",
      "metadata": {
        "environment": "production",
        "version": "1.0"
      },
      "createdAt": "2024-12-01T10:00:00.000Z",
      "updatedAt": "2024-12-20T14:30:00.000Z"
    }
  ],
  "pagination": {
    "total": 25,
    "page": 1,
    "limit": 10,
    "totalPages": 3
  }
}