Exports

List exports

Retrieve a list of all exports.

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

get/v1/exports

Request

Response

ExportsListResponse is the response for a list exports request.

created_atstring date-time required

The time at which the export was created.

descriptionstring required

A description of the export.

export_file_locationstring required

The location of the export file for download.

idinteger required

The ID of the export.

namestring required

The name of the export.

type'compliance_status_detailed' | 'compliance_status_summary' required

The type of the export.

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"
      ]
    },
    "type": "compliance_status_summary"
  }
]

Changes

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