Saltar al contenido principal

kobana inbox secrets

Comandos de kobana inbox secrets. Toda opción global (Opciones globales) vale aquí.

ComandoHTTPDescripción
secrets listGET /v1/secretsListar secrets
secrets createPOST /v1/secretsCrear secret
secrets updatePUT /v1/secretsCrear o actualizar secret
secrets getGET /v1/secrets/{id}Obtener secret
secrets deleteDELETE /v1/secrets/{id}Eliminar secret

secrets list​

Listar secrets

kobana inbox secrets list [OPCIONES]

GET /v1/secrets

Paginación por keyset. Los filtros son query params tipados (campo=valor, campo[op]=valor). El valor de un secret nunca lo devuelve ningún endpoint: se guarda cifrado y solo lo lee el ejecutor de workflows. Para rotarlo, haga PATCH sobre la fila (o PUT por key) con un nuevo value.

Parámetros de consulta

NombreTipoObligatorioDescripción
limitintegerno
cursorstringnoCursor opaco devuelto en meta.next_cursor de la página anterior.
sort_bystringnoCampo por el que ordenar. Permitidos: created_at, updated_at, key. Sin él, el orden es created_at descendente. Valores: created_at, updated_at, key.
sort_orderstringnoasc (por defecto) o desc. Requiere sort_by. Valores: asc, desc.
keystringnoEquality. Also key[in]=a,b.
created_atstringnoIgualdad. También created_at[in]=a,b y created_at[gt|gte|lt|lte].
created_at[gte]stringno
created_at[lte]stringno
updated_atstringnoIgualdad. También updated_at[in]=a,b y updated_at[gt|gte|lt|lte].
updated_at[gte]stringno
updated_at[lte]stringno

Encabezados

NombreTipoObligatorioDescripción
x-origin-shared-secretstringnoSecreto compartido entre CloudFront y el origin. Obligatorio en producción; se ignora en desarrollo a menos que se configure CF_ORIGIN_SHARED_SECRET.

Respuestas

HTTPDescripción
200Página de resultados.
400El cuerpo no superó la validación de Zod. error.details contiene formErrors/fieldErrors.
404Recurso no encontrado o excluido por soft-delete.

secrets create​

Crear secret

kobana inbox secrets create [OPCIONES]

POST /v1/secrets

Guarda un secret que un workflow del agente puede referenciar como ${{secrets.KEY}}. Una key duplicada en el workspace se rechaza con 409 CONFLICT. El valor es de solo escritura: se guarda cifrado y nunca se devuelve.

Encabezados

NombreTipoObligatorioDescripción
x-origin-shared-secretstringnoSecreto compartido entre CloudFront y el origin. Obligatorio en producción; se ignora en desarrollo a menos que se configure CF_ORIGIN_SHARED_SECRET.

Cuerpo de la solicitud

NombreTipoObligatorioDescripción
keystringsí
valuestringsíSe guarda cifrado; nunca se devuelve.
notesstringno

Otros campos y objetos anidados: kobana schema inbox.secrets.create.

Respuestas

HTTPDescripción
201Éxito.
400El cuerpo no superó la validación de Zod. error.details contiene formErrors/fieldErrors.
404Recurso no encontrado o excluido por soft-delete.
409Se violó una restricción de unicidad (por ejemplo, external_id o el email del inbox ya en uso).
422Validación del cuerpo que requiere contexto del lado del servidor (por ejemplo, dominio del inbox no coincide).

secrets update​

Crear o actualizar secret

kobana inbox secrets update [OPCIONES]

PUT /v1/secrets

Upsert emparejado por key dentro del workspace de quien llama — el camino de la rotación, sin buscar el id. Crea con 201 cuando la clave es nueva, reemplaza el valor con 200 cuando ya existe. El valor es de solo escritura.

Encabezados

NombreTipoObligatorioDescripción
x-origin-shared-secretstringnoSecreto compartido entre CloudFront y el origin. Obligatorio en producción; se ignora en desarrollo a menos que se configure CF_ORIGIN_SHARED_SECRET.

Cuerpo de la solicitud

NombreTipoObligatorioDescripción
keystringsíClave de búsqueda del upsert.
valuestringsí
notesstringno

Otros campos y objetos anidados: kobana schema inbox.secrets.update.

Respuestas

HTTPDescripción
200Éxito.
201Éxito.
400El cuerpo no superó la validación de Zod. error.details contiene formErrors/fieldErrors.
404Recurso no encontrado o excluido por soft-delete.
409Se violó una restricción de unicidad (por ejemplo, external_id o el email del inbox ya en uso).
422Validación del cuerpo que requiere contexto del lado del servidor (por ejemplo, dominio del inbox no coincide).

secrets get​

Obtener secret

kobana inbox secrets get [ID] [OPCIONES]

GET /v1/secrets/{id}

Acepta el UUID interno o el external_id del recurso.

Argumentos de la ruta: id

Encabezados

NombreTipoObligatorioDescripción
x-origin-shared-secretstringnoSecreto compartido entre CloudFront y el origin. Obligatorio en producción; se ignora en desarrollo a menos que se configure CF_ORIGIN_SHARED_SECRET.

Respuestas

HTTPDescripción
200Éxito.
404Recurso no encontrado o excluido por soft-delete.

secrets delete​

Eliminar secret

kobana inbox secrets delete [ID] [OPCIONES]

DELETE /v1/secrets/{id}

Borrado lógico. Los pasos de workflow que referencian la clave empiezan a fallar con secret not defined desde la siguiente ejecución.

Argumentos de la ruta: id

Encabezados

NombreTipoObligatorioDescripción
x-origin-shared-secretstringnoSecreto compartido entre CloudFront y el origin. Obligatorio en producción; se ignora en desarrollo a menos que se configure CF_ORIGIN_SHARED_SECRET.

Respuestas

HTTPDescripción
200Eliminado (soft delete).
404Recurso no encontrado o excluido por soft-delete.