Fleet Intelligence — ReferenceAPI Explorerxid

List finalized XID bursts

View as Markdown
Returns the flat finalized-burst table for the authenticated customer. Results default to startTime descending (latest first), with burstId descending as the stable pagination tie-breaker. The selected time range applies to burst start time using [startTime, endTime) and is required, matching GET /v1/events. Relative mode requires timeMode=relative and a positive Go duration window; absolute mode (default) requires startTime and endTime. Do not combine window with startTime/endTime. Absolute endTime must be after startTime. Node-group and compute-zone filters use customer-scoped UUIDs, matching the node and alert APIs. Values are OR-combined within each dimension and AND-combined across dimensions. Exclusion filters select every assignment except the supplied IDs and cannot be combined with the inclusive filter for the same dimension. Filter option IDs and labels are available from GET /v1/nodes/options. Bursts on soft-deleted nodes are never returned. Multiple xidNumbers are OR-combined: a burst matches if it contains any of the requested XIDs (including bursts that contain only one of them, or both). String search parameters are case-insensitive substring filters. Categories, subcategories, and action-code array parameters (e.g. tenantActions) are exact-match checkbox-style filters, OR-combined within the same parameter; their values come from GET /v1/xid/bursts/options. All filters across different columns/parameters are AND-combined, including a *Search param and its exact-match sibling. Action filters and searches match catalog action codes (not Guidance Classes text) and expand public alias codes (e.g. CONTACT_SUPPORT) to the raw DB forms they replace (RETURN_TO_PROVIDER, PULL_FROM_SERVICE), so options-published codes match stored bursts. Response fields are shaped server-side from the caller's persona. Tenants receive jobDisruption, XID numbers with mnemonics, and tenant actions. Cloud-provider/NCP callers additionally receive category, subcategory, jobDisruptionDueToPlatformIssue, XID catalog descriptions, and DC-admin actions. Action text is resolved from the persona-appropriate Guidance Classes catalog. Each item includes nodeUuid, hostname, and the node's current nodeGroup/computeZone (display names and IDs), matching alert timeline Level 1 inventory enrichment.

Query parameters

startTimestringOptional

Start time in RFC3339 format (required for absolute mode, e.g. 2024-01-01T01:00:00Z).

endTimestringOptional

End time in RFC3339 format (required for absolute mode). Must be after startTime.

timeModeenumOptional
Time mode for range selection. Defaults to absolute.
Allowed values:
windowstringOptional

Relative duration window (required for relative mode). Uses Go duration units h, m, and s; use 168h for 7 days (‘d’ is not supported)

nodeUUIDstringOptional
Filter by node UUID
nodeGroupIdslist of stringsOptional

Filter to nodes in matching node groups by node group ID (OR within dimension)

computeZoneIdslist of stringsOptional

Filter to nodes in matching compute zones by compute zone ID (OR within dimension)

excludeNodeGroupIdslist of stringsOptional

Exclude nodes in matching node groups by node group ID (OR within dimension; cannot be combined with nodeGroupIds)

excludeComputeZoneIdslist of stringsOptional

Exclude nodes in matching compute zones by compute zone ID (OR within dimension; cannot be combined with computeZoneIds)

jobDisruptionbooleanOptional

Filter by the public fatal-XID job-disruption definition

jobDisruptionDueToPlatformIssuebooleanOptional

Filter by analyzer platform-attributed disruption (cloud-provider/NCP only)

xidNumberslist of integersOptional

Exact XID numbers; burst matches if it contains any of them (OR semantics)

hostnameSearchstringOptional

Case-insensitive hostname substring

categorySearchstringOptional

Case-insensitive category substring (cloud-provider/NCP only)

subcategorySearchstringOptional

Case-insensitive subcategory substring (cloud-provider/NCP only)

tenantActionSearchstringOptional

Case-insensitive tenant immediate-action code substring

tenantInvestigationSearchstringOptional

Case-insensitive tenant investigatory-action code substring

dcAdminActionSearchstringOptional

Case-insensitive DC-admin immediate-action code substring (cloud-provider/NCP only)

dcAdminInvestigationSearchstringOptional

Case-insensitive DC-admin investigatory-action code substring (cloud-provider/NCP only)

categorieslist of stringsOptional

Exact category values from GET /v1/xid/bursts/options; OR-combined (cloud-provider/NCP only)

subcategorieslist of stringsOptional

Exact subcategory values from GET /v1/xid/bursts/options; OR-combined (cloud-provider/NCP only)

tenantActionslist of stringsOptional

Exact tenant immediate-action codes from GET /v1/xid/bursts/options; OR-combined

tenantInvestigationslist of stringsOptional

Exact tenant investigatory-action codes from GET /v1/xid/bursts/options; OR-combined

dcAdminActionslist of stringsOptional

Exact DC-admin immediate-action codes from GET /v1/xid/bursts/options; OR-combined (cloud-provider/NCP only)

dcAdminInvestigationslist of stringsOptional

Exact DC-admin investigatory-action codes from GET /v1/xid/bursts/options; OR-combined (cloud-provider/NCP only)

sortByenumOptionalDefaults to startTime

Sortable table column (cloud-provider/NCP only for jobDisruptionDueToPlatformIssue, category, subcategory, dcAdminAction, dcAdminInvestigation)

sortOrderenumOptionalDefaults to desc
Sort direction
Allowed values:
pageintegerOptionalDefaults to 0

Page number (0-indexed)

pageSizeintegerOptional1-100Defaults to 20

Page size (1-100)

Response

OK
itemslist of objectsOptional
pageintegerOptional
pageSizeintegerOptional
totalintegerOptional
Total is the number of finalized bursts matching all supplied filters before pagination.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
499
Client Closed Request Error
500
Internal Server Error