Desde la línea de comandos

Un comando por cada operación que una clave puede hacer, listo para copiar.

Versión del contrato 1.15.0 La referencia de abajo se lee del contrato OpenAPI, que está escrito en inglés. No se traduce a propósito: traducirlo significaría copiarlo, y una copia acaba divergiendo. Descarga el contrato público (OpenAPI, JSON)

No hay nada que instalar

No existe ningún programa de Postqron que descargar, y esta página es la razón por la que no te hace falta: la API habla HTTP a secas, así que un intérprete de comandos y curl llegan a toda ella. Aquí no hay nada que envuelva la API — es la API.

Los comandos de abajo se generan del mismo contrato que la referencia REST, y eso es lo que hace que merezca la pena copiarlos: cada uno nombra una ruta que existe, con el método que esa ruta pide de verdad.

Tu clave, y dónde guardarla

Crea una clave en el panel y dale solo los ámbitos que necesita el script. Luego guárdala en el entorno y no en el comando: una clave escrita en la línea es una clave guardada en el historial del intérprete, y los historiales se comparten.

Define POSTQRON_API_KEY y cada comando de esta página funciona tal cual. Para actuar dentro de un espacio de trabajo que no es el tuyo, añade la cabecera X-Postqron-Workspace con el identificador de quien lo posee.

List jobs (R8)jobs:read

curl \
  --header "Authorization: Bearer $POSTQRON_API_KEY" \
  'https://api.postqron.com/jobs'

Un comando por operación

Son las operaciones que una clave puede hacer. Lo que va entre llaves lo sustituyes tú; donde hace falta un cuerpo, el nombre del fichero es el esquema que el contrato espera, y es en el contrato donde se describen sus campos.

List jobs (R8)jobs:read

curl \
  --header "Authorization: Bearer $POSTQRON_API_KEY" \
  'https://api.postqron.com/jobs'

Create a job (R1, R8)jobs:write

curl \
  --request POST \
  --header "Authorization: Bearer $POSTQRON_API_KEY" \
  --header 'Content-Type: application/json' \
  --data @job-input.json \
  'https://api.postqron.com/jobs'

Read one jobjobs:read

curl \
  --header "Authorization: Bearer $POSTQRON_API_KEY" \
  'https://api.postqron.com/jobs/{id}'

Partially update a jobjobs:write

curl \
  --request PATCH \
  --header "Authorization: Bearer $POSTQRON_API_KEY" \
  --header 'Content-Type: application/json' \
  --data @job-input.json \
  'https://api.postqron.com/jobs/{id}'

Delete a jobjobs:write

curl \
  --request DELETE \
  --header "Authorization: Bearer $POSTQRON_API_KEY" \
  'https://api.postqron.com/jobs/{id}'

Execution log (R6)executions:read

curl \
  --header "Authorization: Bearer $POSTQRON_API_KEY" \
  'https://api.postqron.com/jobs/{id}/executions'

Run now (R8)executions:trigger

curl \
  --request POST \
  --header "Authorization: Bearer $POSTQRON_API_KEY" \
  --header 'Content-Type: application/json' \
  --data @trigger-input.json \
  'https://api.postqron.com/jobs/{id}/executions'

Execution log in real time (SPEC §4.2)executions:read

curl \
  --header "Authorization: Bearer $POSTQRON_API_KEY" \
  'https://api.postqron.com/jobs/{id}/executions/stream'

Download the execution log (R27)executions:read

curl \
  --header "Authorization: Bearer $POSTQRON_API_KEY" \
  'https://api.postqron.com/executions/export'

Duration, failure rate and trend (R28)executions:read

curl \
  --header "Authorization: Bearer $POSTQRON_API_KEY" \
  'https://api.postqron.com/executions/metrics'

List workspace secrets (R42)secrets:read

curl \
  --header "Authorization: Bearer $POSTQRON_API_KEY" \
  'https://api.postqron.com/secrets'