Export component in the specified format

GET

/components/{componentId}/export/{type}

Downloads the component as CSV, XCCDF XML, InSpec profile, JSON archive, or disposition CSV. Supports mode selection (working_copy, vendor_submission, published_stig) via query param. The xccdf type is kind-routed by the component's document type: SRG components export their authored requirements through the published_srg mode (only Applicable requirements publish); STIG components use published_stig. disposition_csv is for DISA comment triage matrix export. Requires project membership.

Authorizations

tokenAuth

Personal access token authentication. Send via Authorization header: Authorization: Token vulcan_xxx. Tokens are SHA-256 hashed server-side (never stored in plaintext). Scopes: read (GET), write (mutations), admin (everything). Create tokens via Settings → API Tokens in the web UI.

Type

HTTP (token)

Parameters

Query Parameters

mode

Export mode controlling which fields are included. The xccdf type ignores this parameter — its mode is derived from the component's document type (published_srg for SRG kind, published_stig for STIG).

Type

string

Valid values

"working_copy""vendor_submission""published_stig"

Example"working_copy"

triage_status

Filter disposition CSV by triage status.

Type

string

Example"pending"

Responses

Binary file download

Content-Type

GET

/components/{componentId}/export/{type}

Playground

Server

Authorization

tokenAuth

Variables

Key

Value

mode

triage_status

Samples

Powered by VitePress OpenAPI