Retrieves a TransportAlerta resource.

v1.0.0

Input

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "The TransportAlerta resource is a collection of transports that carry dispatched alerts to the external Alerta service.",
  "required": [
    "alertaApiKey",
    "alertaEvent",
    "alertaHost",
    "alertaResource",
    "partition",
    "transportName"
  ],
  "properties": {
    "alertaApiKey": {
      "type": "string",
      "description": "The API key for the Alerta service."
    },
    "alertaCorrelate": {
      "type": "string",
      "description": "The comma-separated list of related event names for the Alerta service."
    },
    "alertaEnvironment": {
      "type": "string",
      "description": "The environment value for the Alerta service."
    },
    "alertaEvent": {
      "type": "string",
      "description": "The event value for the Alerta service."
    },
    "alertaGroup": {
      "type": "string",
      "description": "The group value for the Alerta service."
    },
    "alertaHost": {
      "type": "string",
      "format": "hostname",
      "description": "The host name for the Alerta service (omit the \"https://\" part)."
    },
    "alertaOrigin": {
      "type": "string",
      "description": "The origin value for the Alerta service."
    },
    "alertaResource": {
      "type": "string",
      "description": "The resource value for the Alerta service."
    },
    "alertaService": {
      "type": "string",
      "description": "The comma-separated list of affected services for the Alerta service."
    },
    "alertaSeverity": {
      "type": "string",
      "description": "The severity value for the Alerta service."
    },
    "alertaStatus": {
      "type": "string",
      "description": "The status value for the Alerta service."
    },
    "alertaTags": {
      "type": "string",
      "description": "The comma-separated list of tags for the Alerta service."
    },
    "alertaType": {
      "type": "string",
      "description": "The type value for the Alerta service."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the resource instance was created. This date-time is in the UTC timezone."
    },
    "dataSegmentCode": {
      "type": "string",
      "description": "User-provided string on which to segment and filter data. Max 50 characters."
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "The unique identifier of the resource instance."
    },
    "partition": {
      "type": "string",
      "format": "iri-reference",
      "description": "The partition that contains this resource instance. The resource cannot be moved to another partition."
    },
    "resourceOwner": {
      "type": "string",
      "description": "The name of the person who owns this resource."
    },
    "transportName": {
      "type": "string",
      "description": "The name of the transport."
    }
  }
}