PUpuppet
Exports

Retrieve an export job

Retrieve an export job, including its current status and the location of the associated export, if one has been generated successfully.

To use this endpoint, you must have one of the following roles: comply-admin comply-operator comply-viewer

get/v1/export-job/{id}

Request

Path parameters

idinteger required

The ID of the export job.

Response

GetExportJobResponse is the response for a get export job request.

created_atstring date-time required

The time at which the export job was created.

descriptionstring required

A description of the export to be generated.

export_file_locationstring nullable

The location of the generated export file for download, if the export job has finished successfully.

idinteger required

The ID of the export job.

namestring required

The name of the export to be generated.

status'queued' | 'processing' | 'successful' | 'failed' required

The status of the export job.

type'compliance_status_detailed' | 'compliance_status_summary' required

The type of export to be generated.

Example response

{
  "created_at": "2023-09-25T13:57:16.743Z",
  "description": "Compliance summary for production Red Hat nodes.",
  "export_file_location": "/api/public/v1/export/456/file",
  "id": 123,
  "name": "compliance_summary_production_redhat",
  "node_filters": {
    "environments": [
      "production"
    ],
    "name": [
      "my-node-789.prod.example.com"
    ],
    "node_groups": [
      "auditable nodes"
    ],
    "operating_systems": [
      "redhat 7",
      "redhat 8"
    ]
  },
  "status": "successful",
  "type": "compliance_status_summary"
}

Changes

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