Skip to main content
POST
Create an async data export

Authorizations

Authorization
string
header
required

Body

application/json
export
object
required
fields
string

Comma-separated list of fields to include (e.g. "id,name,status"). Read from the top level of the request, not from inside export. Applies to JSON exports and to CSV exports of every resource type except Nexus::Asset, Nexus::Event and Nexus::DataPoint, whose CSV columns are fixed and ignore it. Where it applies, an unknown field fails the export, which GET /exports/{export_id} reports.

Response

Export queued for processing

id
string

The export's friendly ID (e.g. exp_aBcD1234eFgH5678).

status
enum<string>
Available options:
pending
status_url
string<uri>

URL of the export's status endpoint.

message
string