Skip to content

Get a single cloud-export-job by id

GET
/cloud-export-jobs/{id}
id
required
string

DocumentId

OK

object
data
object
job_id
required

RabbitMQ job correlation id (UUID) — links this record to the cloud.events message and worker logs.

string
status
required
string
Allowed values: pending running completed failed
organisation
One of:

DocumentId reference to api::organisation.organisation

string
created_by_user
One of:

DocumentId reference to plugin::users-permissions.user

string
resource_count

Number of records (instances + networks) successfully serialized into the generated .tf output.

integer
skipped_count

Number of records skipped because their provider has no v0 export mapping (e.g. digitalocean, vultr) — see UnsupportedProviderError in tf-exporter.ts.

integer
failed_count

Number of records that failed to serialize for reasons other than unsupported provider (malformed record, worker-side error).

integer
error_message

Set when status=‘failed’ at the job level (e.g. worker crash, no instance_ids resolved). Also set on a ‘completed’ job when skipped_count > 0, carrying the skipped record name/id/reason (F4.IAC.03 worker) so a partial export is never indistinguishable from a full one.

string
output

Generated .tf HCL text, stored directly on the record (MVP — no media/upload plugin, job records are short-lived and .tf output is typically well under a media-worthy size). TTL/retention cleanup of old jobs is a follow-up, out of v0 scope.

string
providers_included

Informative array of provider names (aws/gcp/azure/hetzner) that appeared in this export’s resource selection.

documentId
string
id
integer
createdAt
string format: date-time
updatedAt
string format: date-time
publishedAt
string format: date-time
nullable

Missing or invalid authentication

Not authorized (tenant scope or capability)

Not found