Appearance
Export project data in the specified format
GET
/projects/{projectId}/export/{type}
Exports selected components from the project as CSV, XCCDF XML, InSpec profile, or JSON archive. Supports mode selection (working copy, vendor submission, published STIG) and optional SRG/membership inclusion. Returns a binary file download. Requires project membership.
Authorizations
cookieAuth
Type
API Key (cookie: _vulcan_session)
or
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
component_ids*
Comma-separated IDs of components to include in the export.
Type
Requiredstring
Example
"29,30"mode
Export mode controlling which fields and rules are included.
Type
string
Valid values
"working_copy""vendor_submission""published_stig"Example
"working_copy"include_srg
Include the source SRG in the export package.
Type
string
Valid values
"true"include_memberships
Include project membership data in the export.
Type
string
Valid values
"true""false"exclude_satisfied_by
Exclude rules that are satisfied by another rule.
Type
string
Valid values
"true"Responses
Binary file download (CSV, XML, ZIP, or JSON)