Sign in

v1

latestOpenAPI 3.0.02026-08-0650184174.6 KB
TMS Checks

Returns a single transaction check.

get/tms/check/{cid}

Path parameters

cidinteger required

Specifies the id of the check to be fetched

Query parameters

extended_tagsboolean

Specifies whether to return an extended tags representation in the response (with type and count).

Response

Detailed description of specified check.

activeboolean

Check status - active or inactive

contact_idsinteger[]

Contacts to alert

created_atinteger

Timestamp when the check was created

modified_atinteger

Timestamp when the check was modified

last_downtime_startinteger

Timestamp when the last downtime started. This field is optional

last_downtime_endinteger

Timestamp when the last downtime ended. This field is optional

custom_messagestring

Custom message that is part of the email and webhook alerts

intervalinteger

TMS test intervals in minutes. Allowed intervals: 5,10,20,60,720,1440. The interval you're allowed to set may vary depending on your current plan.

namestring

Name of the check

regionstring

Name of the region where the check is executed. Supported regions: us-east, us-west, eu, au

send_notification_when_downinteger

Send notification when down X times

severity_levelstring

Check importance- how important are the alerts when the check fails. Allowed values: low, high

statusstring

Whether the check is passing or failing at the moment (successful, failing, unknown)

team_idsinteger[]

Teams to alert

integration_idsinteger[]

Integration identifiers.

tagsstring[]

List of tags for a check. The tag name may contain the characters 'A-Z', 'a-z', '0-9', '_' and '-'. The maximum length of a tag is 64 characters.

type'script' | 'recording'

Type of transaction check: "script" for regular TMS checks and "recording" for checks made using the Transaction Recorder

Example response

{
  "active": true,
  "contact_ids": [
    12345678,
    19876654
  ],
  "created_at": 1553070682,
  "modified_at": 1553070968,
  "last_downtime_start": 1553081100,
  "last_downtime_end": 1553089000,
  "custom_message": "My custom message",
  "interval": 10,
  "name": "My awesome check",
  "region": "us-west",
  "send_notification_when_down": 1,
  "severity_level": "low",
  "status": "successful",
  "steps": [
    {
      "args": {
        "url": "http://www.google.com"
      },
      "fn": "go_to"
    }
  ],
  "team_ids": [
    12345678,
    135790
  ],
  "integration_ids": [
    1234,
    1359
  ],
  "metadata": {
    "width": 1950,
    "height": 1080,
    "authentications": {
      "httpAuthentications": [
        {
          "credentials": {
            "password": "secret",
            "userName": "admin"
          },
          "host": "https://example.com/auth"
        }
      ]
    }
  },
  "tags": [
    "tag1",
    "tag2"
  ]
}