Get XID burst filter options

View as Markdown
Returns filter options available to the authenticated customer and persona. Optional time and inventory scope filters narrow the values; table column filters are not applied. This v1 response contains no counts and has no cross-filter impact-count behavior. Tenant callers receive public disruption values, XIDs, and tenant actions. Cloud-provider/NCP callers additionally receive platform-disruption values, categories, subcategories, and DC-admin actions. suggestedActions uses the shared action model; clients group it by persona and type. Category and action labels are resolved from the persona-appropriate catalogs. jobDisruption and jobDisruptionDueToPlatformIssue are always the full [true, false] domain. XID numbers, categories, subcategories, and suggestedActions reflect the distinct values actually present across the customer's finalized bursts (still unfiltered by the current table filters). Action codes are alias-normalized and de-duplicated after normalization, matching GET /v1/xid/bursts. Hostname filtering uses the free-text nameSearch parameter on GET /v1/xid/bursts rather than a distinct-hostname options list. Options are scoped by agentType and echoed in the response, so they always match what GET /v1/xid/bursts returns for that same value. Request them again when switching paths, and pass agentType=all when the table itself was fetched with agentType=all — single-path options would otherwise omit filters for rows already on screen.

Query parameters

startTimestringOptional
Optional RFC3339 start time
endTimestringOptional
Optional RFC3339 end time
timeModeenumOptional
Optional time mode
Allowed values:
windowstringOptional
Optional relative duration window
nodeGroupIdslist of stringsOptional
Node group IDs
computeZoneIdslist of stringsOptional
Compute zone IDs
excludeNodeGroupIdslist of stringsOptional
Excluded node group IDs
excludeComputeZoneIdslist of stringsOptional
Excluded compute zone IDs
agentTypeenumOptionalDefaults to inband
Observation path to compute options for, or all for both
Allowed values:

Response

OK
agentTypestringOptional

AgentType echoes the observation path the options were computed from, so a client that caches options per path can tell them apart. It may be “all”, and must be when the table it filters was fetched with agentType=all: options for one path never include values seen only on the other, so pairing a combined table with single-path options would hide filters for rows on screen.

categorieslist of stringsOptional
jobDisruptionlist of booleansOptional
jobDisruptionDueToPlatformIssuelist of booleansOptional
JobDisruptionDueToPlatformIssue is omitted for tenant callers.
subcategorieslist of stringsOptional
suggestedActionslist of objectsOptional

SuggestedActions is persona-shaped: tenants receive tenant actions, while cloud-provider/NCP callers receive both tenant and dc_admin actions. Clients group options by persona and type (immediate or investigatory).

xidNumberslist of integersOptional

Errors

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