v1

latestOpenAPI 3.0.02026-07-144224981.3 MB

TransportAlerta

Retrieves the collection of TransportAlerta resources.

get/api/transport-alerta

Query parameters

pageinteger

The collection page number

dataSegmentCodestring

dataSegmentCode[]string[]

partitionstring

partition[]string[]

properties[]string[]

Response

TransportAlerta collection

alertaApiKeystring nullable required

The API key for the Alerta service.

alertaCorrelatestring nullable

The comma-separated list of related event names for the Alerta service.

alertaEnvironmentstring nullable

The environment value for the Alerta service.

alertaEventstring nullable required

The event value for the Alerta service.

alertaGroupstring nullable

The group value for the Alerta service.

alertaHoststring hostname nullable required

The host name for the Alerta service (omit the "https://" part).

alertaOriginstring nullable

The origin value for the Alerta service.

alertaResourcestring nullable required

The resource value for the Alerta service.

alertaServicestring nullable

The comma-separated list of affected services for the Alerta service.

alertaSeveritystring nullable

The severity value for the Alerta service.

alertaStatusstring nullable

The status value for the Alerta service.

alertaTagsstring nullable

The comma-separated list of tags for the Alerta service.

alertaTypestring nullable

The type value for the Alerta service.

createdAtstring date-time

When the resource instance was created. This date-time is in the UTC timezone.

dataSegmentCodestring nullable

User-provided string on which to segment and filter data. Max 50 characters.

idstring uuid nullable

The unique identifier of the resource instance.

partitionstring iri-reference required

The partition that contains this resource instance. The resource cannot be moved to another partition.

resourceOwnerstring nullable

The name of the person who owns this resource.

transportNamestring nullable required

The name of the transport.