Depuis la ligne de commande

Une commande par opération qu’une clé peut effectuer, prête à copier.

Version du contrat 1.15.0 La référence ci-dessous est lue dans le contrat OpenAPI, rédigé en anglais. Elle n’est pas traduite à dessein: la traduire reviendrait à la recopier, et une copie finit par diverger. Télécharger le contrat public (OpenAPI, JSON)

Il n’y a rien à installer

Il n’existe aucun programme Postqron à télécharger, et cette page est la raison pour laquelle il ne vous en faut pas: l’API parle du HTTP tout simple, donc un interpréteur de commandes et curl l’atteignent en entier. Rien ici n’enveloppe l’API — c’est l’API.

Les commandes ci-dessous sont engendrées par le même contrat que la référence REST, et c’est ce qui les rend dignes d’être copiées: chacune nomme une route qui existe, avec la méthode que cette route réclame vraiment.

Votre clé, et où la garder

Créez une clé dans le tableau de bord et ne lui donnez que les portées dont le script a besoin. Gardez-la ensuite dans l’environnement plutôt que dans la commande: une clé saisie en clair est une clé enregistrée dans l’historique de l’interpréteur, et les historiques se partagent.

Définissez POSTQRON_API_KEY et chaque commande de cette page fonctionne telle quelle. Pour agir dans un espace de travail qui n’est pas le vôtre, ajoutez l’en-tête X-Postqron-Workspace avec l’identifiant de la personne qui le possède.

List jobs (R8)jobs:read

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

Une commande par opération

Ce sont les opérations qu’une clé peut effectuer. Ce qui est entre accolades est à remplacer; là où un corps est attendu, le nom du fichier est le schéma que le contrat réclame, et c’est dans le contrat que ses champs sont décrits.

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'