Dalla riga di comando

Un comando per ogni operazione che una chiave può fare, pronto da copiare.

Versione del contratto 1.15.0 Il riferimento qui sotto è letto dal contratto OpenAPI, che è scritto in inglese. Non è tradotto di proposito: tradurlo vorrebbe dire ricopiarlo, e una copia prima o poi diverge. Scarica il contratto pubblico (OpenAPI, JSON)

Non c’è niente da installare

Non esiste un programma Postqron da scaricare, e questa pagina è la ragione per cui non ti serve: l’API parla HTTP e basta, quindi una shell e curl la raggiungono tutta. Qui non c’è niente che avvolga l’API — è l’API.

I comandi qui sotto sono generati dallo stesso contratto del riferimento REST, ed è ciò che li rende degni di essere copiati: ciascuno nomina una rotta che esiste, con il metodo che quella rotta vuole davvero.

La chiave, e dove tenerla

Crea una chiave nella dashboard e dalle solo gli ambiti che servono allo script. Poi tienila nell’ambiente e non nel comando: una chiave scritta in linea è una chiave salvata nella cronologia della shell, e le cronologie si condividono.

Imposta POSTQRON_API_KEY e ogni comando di questa pagina funziona così com’è. Per agire dentro un workspace che non è il tuo, aggiungi l’intestazione X-Postqron-Workspace con l’identificativo di chi lo possiede.

List jobs (R8)jobs:read

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

Un comando per operazione

Sono le operazioni che una chiave può fare. Ciò che sta fra parentesi graffe lo sostituisci tu; dove serve un corpo, il nome del file è lo schema che il contratto si aspetta, ed è nel contratto che i suoi campi sono descritti.

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'