Von der Kommandozeile aus

Ein Befehl für jede Operation, die ein Schlüssel ausführen darf, fertig zum Kopieren.

Vertragsversion 1.15.0 Die Referenz unten wird aus dem OpenAPI-Vertrag gelesen, der auf Englisch verfasst ist. Sie ist bewusst nicht übersetzt: eine Übersetzung wäre eine Kopie, und eine Kopie läuft irgendwann auseinander. Den öffentlichen Vertrag herunterladen (OpenAPI, JSON)

Es gibt nichts zu installieren

Es gibt kein Postqron-Programm zum Herunterladen, und diese Seite ist der Grund, warum Sie keines brauchen: die API spricht schlichtes HTTP, also erreichen eine Shell und curl sie vollständig. Hier ist nichts, was die API umhüllt — hier ist die API.

Die Befehle unten entstehen aus demselben Vertrag wie die REST-Referenz, und genau das macht sie kopierenswert: jeder nennt eine Route, die es gibt, mit der Methode, die diese Route wirklich verlangt.

Ihr Schlüssel, und wo er hingehört

Legen Sie im Dashboard einen Schlüssel an und geben Sie ihm nur die Geltungsbereiche, die das Skript braucht. Bewahren Sie ihn dann in der Umgebung auf und nicht im Befehl: ein direkt eingetippter Schlüssel ist ein Schlüssel im Verlauf der Shell, und Verlaufsdateien werden geteilt.

Setzen Sie POSTQRON_API_KEY, und jeder Befehl dieser Seite läuft unverändert. Um in einem fremden Arbeitsbereich zu handeln, ergänzen Sie den Kopf X-Postqron-Workspace mit der Kennung seiner Inhaberin oder seines Inhabers.

List jobs (R8)jobs:read

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

Ein Befehl je Operation

Das sind die Operationen, die ein Schlüssel ausführen darf. Was in geschweiften Klammern steht, ersetzen Sie; wo ein Rumpf erwartet wird, ist der Dateiname das Schema, das der Vertrag verlangt, und im Vertrag stehen auch dessen Felder.

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'