Exports

Start an asynchronous catalog export

Starts a job that renders the service catalog as jsonl, csv or md. Answers 202 with a Location header. Poll the Location URL until status is succeeded, then GET data.download_url. status moves queued, running, succeeded. Jobs and files are kept for 24 hours and are visible only to the OAuth client that created them. Honors Idempotency-Key. Limit: 10 per hour per OAuth client.

post/exports

Request

  • Base URL: https://codeatlas.com.br/api/v1
  • URL: https://codeatlas.com.br/api/v1/exports
  • Auth: OAuth 2 (client credentials, token URL https://codeatlas.com.br/oauth2/token, scopes: api:write)

Headers

Idempotency-Keystring

8 to 128 printable ASCII characters, for example a UUID. The same key with the same body replays the first response for 24 hours. The same key with a different body returns 422.

Request body

format'jsonl' | 'csv' | 'md' required

Response

The job was accepted.

Changes

No recorded changes to this operation across all 1 revision of this API.