Actualizar una API key

PATCH

/api-keys/{id}

curl --request PATCH \
  --url https://api.inspow.tech/api/v1/api-keys/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "status": "active", "scopes": [ "read_only" ], "allowedOrigins": [ "example" ], "allowedIPs": [ "example" ], "expiresAt": "example", "rateLimit": 1, "metadata": {} }'

• Producción
• Local

Actualiza los detalles de una API key existente

Authorizations

• bearer

Parameters

Path Parameters

id

required

string

Request Body ^required

Media type application/json

object

name

Nombre descriptivo para la API key

string

<= 100 characters

description

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

string

<= 500 characters

status

Estado de la API key

string

Allowed values: active inactive revoked expired

scopes

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 (ISO string)

string

rateLimit

Límite de requests por hora

number

>= 1 <= 10000

metadata

Metadatos adicionales en formato JSON

object

Responses

200

API key actualizada exitosamente

Media type application/json

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

Example

{
  "_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"
}

403

Sin permisos para actualizar esta API key