RunReveal

HealthCheckConfigList operation

GET
/health-checks/configs
curl -X GET "https://api.runreveal.com/health-checks/configs"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": [
    {
      "description": "string",
      "displayName": "string",
      "id": "string",
      "name": "string",
      "query": "string",
      "schedule": "string",
      "settings": [
        0
      ]
    }
  ],
  "success": true
}

HealthCheckConfigGet operation

GET
/health-checks/configs/get
curl -X GET "https://api.runreveal.com/health-checks/configs/get?id=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "description": "string",
    "displayName": "string",
    "id": "string",
    "name": "string",
    "query": "string",
    "schedule": "string",
    "settings": [
      0
    ]
  },
  "success": true
}

DestHealthCheckConfigList operation

GET
/health-checks/destinations/configs
curl -X GET "https://api.runreveal.com/health-checks/destinations/configs"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": [
    {
      "description": "string",
      "displayName": "string",
      "id": "string",
      "name": "string",
      "query": "string",
      "schedule": "string",
      "settings": [
        0
      ]
    }
  ],
  "success": true
}

DestHealthCheckConfigGet operation

GET
/health-checks/destinations/configs/get
curl -X GET "https://api.runreveal.com/health-checks/destinations/configs/get?id=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "description": "string",
    "displayName": "string",
    "id": "string",
    "name": "string",
    "query": "string",
    "schedule": "string",
    "settings": [
      0
    ]
  },
  "success": true
}

DestHealthCheckResultsList operation

GET
/health-checks/destinations/results

Query Parameters

frominteger

subscriptionIDstring

tointeger

curl -X GET "https://api.runreveal.com/health-checks/destinations/results?from=0&subscriptionID=string&to=0"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": [
    {
      "checkedAt": {},
      "destinationHealthCheckSubscriptionID": "string",
      "error": "string",
      "id": "string",
      "notified": true,
      "status": "string",
      "value": 0,
      "workspaceID": "string"
    }
  ],
  "success": true
}

DestHealthCheckSubscriptionList operation

GET
/health-checks/destinations/subscriptions

Query Parameters

destinationIDstring

enabledboolean

statusstring

curl -X GET "https://api.runreveal.com/health-checks/destinations/subscriptions?destinationID=string&enabled=true&status=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": [
    {
      "DestinationHealthCheckSubscription": {
        "consecutiveFailures": 0,
        "createdAt": {},
        "createdBy": "string",
        "destinationID": "string",
        "displayName": "string",
        "enabled": true,
        "failureThreshold": 0,
        "firstFailedAt": {},
        "id": "string",
        "lastNotified": {},
        "managedDetectionConfigID": "string",
        "name": "string",
        "nextRunTime": {},
        "notificationNames": [
          "string"
        ],
        "parameters": {
          "property1": "string",
          "property2": "string"
        },
        "previousRunTime": {},
        "schedule": "string",
        "silencedUntil": {},
        "status": "string",
        "throttle": 0,
        "updatedAt": {},
        "workerID": "string",
        "workspaceID": "string"
      },
      "configDescription": "string",
      "configDisplayName": "string",
      "query": "string",
      "settings": {
        "evaluation": {
          "operator": "string",
          "thresholdParam": "string",
          "valueColumn": "string"
        },
        "fields": [
          {
            "dataType": "string",
            "description": "string",
            "displayName": "string",
            "name": "string"
          }
        ]
      }
    }
  ],
  "success": true
}

DestHealthCheckSubscriptionCreate operation

POST
/health-checks/destinations/subscriptions/create

Request Body

application/jsonRequired

destinationIDstring

displayNamestring

enabledboolean

failureThresholdinteger

managedDetectionConfigIDstring

namestring

notificationNamesarray<string>

parametersobject

schedulestring

throttleinteger

curl -X POST "https://api.runreveal.com/health-checks/destinations/subscriptions/create" \
  -H "Content-Type: application/json" \
  -d '{
    "destinationID": "string",
    "displayName": "string",
    "enabled": true,
    "failureThreshold": 0,
    "managedDetectionConfigID": "string",
    "name": "string",
    "notificationNames": [
      "string"
    ],
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "schedule": "string",
    "throttle": 0
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "consecutiveFailures": 0,
    "createdAt": {},
    "createdBy": "string",
    "destinationID": "string",
    "displayName": "string",
    "enabled": true,
    "failureThreshold": 0,
    "firstFailedAt": {},
    "id": "string",
    "lastNotified": {},
    "managedDetectionConfigID": "string",
    "name": "string",
    "nextRunTime": {},
    "notificationNames": [
      "string"
    ],
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "previousRunTime": {},
    "schedule": "string",
    "silencedUntil": {},
    "status": "string",
    "throttle": 0,
    "updatedAt": {},
    "workerID": "string",
    "workspaceID": "string"
  },
  "success": true
}

DestHealthCheckSubscriptionDelete operation

DELETE
/health-checks/destinations/subscriptions/delete
curl -X DELETE "https://api.runreveal.com/health-checks/destinations/subscriptions/delete?id=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {},
  "success": true
}

DestHealthCheckSubscriptionDisable operation

POST
/health-checks/destinations/subscriptions/disable

Request Body

application/jsonRequired

idstring

curl -X POST "https://api.runreveal.com/health-checks/destinations/subscriptions/disable" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "consecutiveFailures": 0,
    "createdAt": {},
    "createdBy": "string",
    "destinationID": "string",
    "displayName": "string",
    "enabled": true,
    "failureThreshold": 0,
    "firstFailedAt": {},
    "id": "string",
    "lastNotified": {},
    "managedDetectionConfigID": "string",
    "name": "string",
    "nextRunTime": {},
    "notificationNames": [
      "string"
    ],
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "previousRunTime": {},
    "schedule": "string",
    "silencedUntil": {},
    "status": "string",
    "throttle": 0,
    "updatedAt": {},
    "workerID": "string",
    "workspaceID": "string"
  },
  "success": true
}

DestHealthCheckSubscriptionEnable operation

POST
/health-checks/destinations/subscriptions/enable

Request Body

application/jsonRequired

idstring

curl -X POST "https://api.runreveal.com/health-checks/destinations/subscriptions/enable" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "consecutiveFailures": 0,
    "createdAt": {},
    "createdBy": "string",
    "destinationID": "string",
    "displayName": "string",
    "enabled": true,
    "failureThreshold": 0,
    "firstFailedAt": {},
    "id": "string",
    "lastNotified": {},
    "managedDetectionConfigID": "string",
    "name": "string",
    "nextRunTime": {},
    "notificationNames": [
      "string"
    ],
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "previousRunTime": {},
    "schedule": "string",
    "silencedUntil": {},
    "status": "string",
    "throttle": 0,
    "updatedAt": {},
    "workerID": "string",
    "workspaceID": "string"
  },
  "success": true
}

DestHealthCheckSubscriptionGet operation

GET
/health-checks/destinations/subscriptions/get
curl -X GET "https://api.runreveal.com/health-checks/destinations/subscriptions/get?id=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "DestinationHealthCheckSubscription": {
      "consecutiveFailures": 0,
      "createdAt": {},
      "createdBy": "string",
      "destinationID": "string",
      "displayName": "string",
      "enabled": true,
      "failureThreshold": 0,
      "firstFailedAt": {},
      "id": "string",
      "lastNotified": {},
      "managedDetectionConfigID": "string",
      "name": "string",
      "nextRunTime": {},
      "notificationNames": [
        "string"
      ],
      "parameters": {
        "property1": "string",
        "property2": "string"
      },
      "previousRunTime": {},
      "schedule": "string",
      "silencedUntil": {},
      "status": "string",
      "throttle": 0,
      "updatedAt": {},
      "workerID": "string",
      "workspaceID": "string"
    },
    "configDescription": "string",
    "configDisplayName": "string",
    "query": "string",
    "settings": {
      "evaluation": {
        "operator": "string",
        "thresholdParam": "string",
        "valueColumn": "string"
      },
      "fields": [
        {
          "dataType": "string",
          "description": "string",
          "displayName": "string",
          "name": "string"
        }
      ]
    }
  },
  "success": true
}

DestHealthCheckSubscriptionSilence operation

POST
/health-checks/destinations/subscriptions/silence

Request Body

application/jsonRequired

idstring

silencedUntilobject

curl -X POST "https://api.runreveal.com/health-checks/destinations/subscriptions/silence" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "silencedUntil": {}
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "consecutiveFailures": 0,
    "createdAt": {},
    "createdBy": "string",
    "destinationID": "string",
    "displayName": "string",
    "enabled": true,
    "failureThreshold": 0,
    "firstFailedAt": {},
    "id": "string",
    "lastNotified": {},
    "managedDetectionConfigID": "string",
    "name": "string",
    "nextRunTime": {},
    "notificationNames": [
      "string"
    ],
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "previousRunTime": {},
    "schedule": "string",
    "silencedUntil": {},
    "status": "string",
    "throttle": 0,
    "updatedAt": {},
    "workerID": "string",
    "workspaceID": "string"
  },
  "success": true
}

DestHealthCheckSubscriptionUnsilence operation

POST
/health-checks/destinations/subscriptions/unsilence

Request Body

application/jsonRequired

idstring

curl -X POST "https://api.runreveal.com/health-checks/destinations/subscriptions/unsilence" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "consecutiveFailures": 0,
    "createdAt": {},
    "createdBy": "string",
    "destinationID": "string",
    "displayName": "string",
    "enabled": true,
    "failureThreshold": 0,
    "firstFailedAt": {},
    "id": "string",
    "lastNotified": {},
    "managedDetectionConfigID": "string",
    "name": "string",
    "nextRunTime": {},
    "notificationNames": [
      "string"
    ],
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "previousRunTime": {},
    "schedule": "string",
    "silencedUntil": {},
    "status": "string",
    "throttle": 0,
    "updatedAt": {},
    "workerID": "string",
    "workspaceID": "string"
  },
  "success": true
}

DestHealthCheckSubscriptionUpdate operation

PUT
/health-checks/destinations/subscriptions/update

Request Body

application/jsonRequired

displayNamestring

enabledboolean

failureThresholdinteger

idstring

namestring

notificationNamesarray<string>

parametersobject

schedulestring

silencedUntilobject

throttleinteger

curl -X PUT "https://api.runreveal.com/health-checks/destinations/subscriptions/update" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "string",
    "enabled": true,
    "failureThreshold": 0,
    "id": "string",
    "name": "string",
    "notificationNames": [
      "string"
    ],
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "schedule": "string",
    "silencedUntil": {},
    "throttle": 0
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "consecutiveFailures": 0,
    "createdAt": {},
    "createdBy": "string",
    "destinationID": "string",
    "displayName": "string",
    "enabled": true,
    "failureThreshold": 0,
    "firstFailedAt": {},
    "id": "string",
    "lastNotified": {},
    "managedDetectionConfigID": "string",
    "name": "string",
    "nextRunTime": {},
    "notificationNames": [
      "string"
    ],
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "previousRunTime": {},
    "schedule": "string",
    "silencedUntil": {},
    "status": "string",
    "throttle": 0,
    "updatedAt": {},
    "workerID": "string",
    "workspaceID": "string"
  },
  "success": true
}

HealthCheckSubscriptionList operation

GET
/health-checks/subscriptions

Query Parameters

enabledboolean

sourceIDstring

statusstring

curl -X GET "https://api.runreveal.com/health-checks/subscriptions?enabled=true&sourceID=string&status=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": [
    {
      "HealthCheckSubscription": {
        "consecutiveFailures": 0,
        "createdAt": {},
        "createdBy": "string",
        "displayName": "string",
        "enabled": true,
        "failureThreshold": 0,
        "firstFailedAt": {},
        "id": "string",
        "lastNotified": {},
        "managedDetectionConfigID": "string",
        "name": "string",
        "nextRunTime": {},
        "notificationNames": [
          "string"
        ],
        "parameters": {
          "property1": "string",
          "property2": "string"
        },
        "previousRunTime": {},
        "schedule": "string",
        "silencedUntil": {},
        "sourceID": "string",
        "status": "string",
        "throttle": 0,
        "updatedAt": {},
        "workerID": "string",
        "workspaceID": "string"
      },
      "configDescription": "string",
      "configDisplayName": "string",
      "query": "string",
      "settings": {
        "evaluation": {
          "operator": "string",
          "thresholdParam": "string",
          "valueColumn": "string"
        },
        "fields": [
          {
            "dataType": "string",
            "description": "string",
            "displayName": "string",
            "name": "string"
          }
        ]
      }
    }
  ],
  "success": true
}

HealthCheckSubscriptionCreate operation

POST
/health-checks/subscriptions/create

Request Body

application/jsonRequired

displayNamestring

enabledboolean

failureThresholdinteger

managedDetectionConfigIDstring

namestring

notificationNamesarray<string>

parametersobject

schedulestring

sourceIDstring

throttleinteger

curl -X POST "https://api.runreveal.com/health-checks/subscriptions/create" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "string",
    "enabled": true,
    "failureThreshold": 0,
    "managedDetectionConfigID": "string",
    "name": "string",
    "notificationNames": [
      "string"
    ],
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "schedule": "string",
    "sourceID": "string",
    "throttle": 0
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "consecutiveFailures": 0,
    "createdAt": {},
    "createdBy": "string",
    "displayName": "string",
    "enabled": true,
    "failureThreshold": 0,
    "firstFailedAt": {},
    "id": "string",
    "lastNotified": {},
    "managedDetectionConfigID": "string",
    "name": "string",
    "nextRunTime": {},
    "notificationNames": [
      "string"
    ],
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "previousRunTime": {},
    "schedule": "string",
    "silencedUntil": {},
    "sourceID": "string",
    "status": "string",
    "throttle": 0,
    "updatedAt": {},
    "workerID": "string",
    "workspaceID": "string"
  },
  "success": true
}

HealthCheckSubscriptionDelete operation

DELETE
/health-checks/subscriptions/delete
curl -X DELETE "https://api.runreveal.com/health-checks/subscriptions/delete?id=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {},
  "success": true
}

HealthCheckSubscriptionDisable operation

POST
/health-checks/subscriptions/disable

Request Body

application/jsonRequired

idstring

curl -X POST "https://api.runreveal.com/health-checks/subscriptions/disable" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "consecutiveFailures": 0,
    "createdAt": {},
    "createdBy": "string",
    "displayName": "string",
    "enabled": true,
    "failureThreshold": 0,
    "firstFailedAt": {},
    "id": "string",
    "lastNotified": {},
    "managedDetectionConfigID": "string",
    "name": "string",
    "nextRunTime": {},
    "notificationNames": [
      "string"
    ],
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "previousRunTime": {},
    "schedule": "string",
    "silencedUntil": {},
    "sourceID": "string",
    "status": "string",
    "throttle": 0,
    "updatedAt": {},
    "workerID": "string",
    "workspaceID": "string"
  },
  "success": true
}

HealthCheckSubscriptionEnable operation

POST
/health-checks/subscriptions/enable

Request Body

application/jsonRequired

idstring

curl -X POST "https://api.runreveal.com/health-checks/subscriptions/enable" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "consecutiveFailures": 0,
    "createdAt": {},
    "createdBy": "string",
    "displayName": "string",
    "enabled": true,
    "failureThreshold": 0,
    "firstFailedAt": {},
    "id": "string",
    "lastNotified": {},
    "managedDetectionConfigID": "string",
    "name": "string",
    "nextRunTime": {},
    "notificationNames": [
      "string"
    ],
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "previousRunTime": {},
    "schedule": "string",
    "silencedUntil": {},
    "sourceID": "string",
    "status": "string",
    "throttle": 0,
    "updatedAt": {},
    "workerID": "string",
    "workspaceID": "string"
  },
  "success": true
}

HealthCheckSubscriptionGet operation

GET
/health-checks/subscriptions/get
curl -X GET "https://api.runreveal.com/health-checks/subscriptions/get?id=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "HealthCheckSubscription": {
      "consecutiveFailures": 0,
      "createdAt": {},
      "createdBy": "string",
      "displayName": "string",
      "enabled": true,
      "failureThreshold": 0,
      "firstFailedAt": {},
      "id": "string",
      "lastNotified": {},
      "managedDetectionConfigID": "string",
      "name": "string",
      "nextRunTime": {},
      "notificationNames": [
        "string"
      ],
      "parameters": {
        "property1": "string",
        "property2": "string"
      },
      "previousRunTime": {},
      "schedule": "string",
      "silencedUntil": {},
      "sourceID": "string",
      "status": "string",
      "throttle": 0,
      "updatedAt": {},
      "workerID": "string",
      "workspaceID": "string"
    },
    "configDescription": "string",
    "configDisplayName": "string",
    "query": "string",
    "settings": {
      "evaluation": {
        "operator": "string",
        "thresholdParam": "string",
        "valueColumn": "string"
      },
      "fields": [
        {
          "dataType": "string",
          "description": "string",
          "displayName": "string",
          "name": "string"
        }
      ]
    }
  },
  "success": true
}

HealthCheckSubscriptionSilence operation

POST
/health-checks/subscriptions/silence

Request Body

application/jsonRequired

idstring

silencedUntilobject

curl -X POST "https://api.runreveal.com/health-checks/subscriptions/silence" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "silencedUntil": {}
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "consecutiveFailures": 0,
    "createdAt": {},
    "createdBy": "string",
    "displayName": "string",
    "enabled": true,
    "failureThreshold": 0,
    "firstFailedAt": {},
    "id": "string",
    "lastNotified": {},
    "managedDetectionConfigID": "string",
    "name": "string",
    "nextRunTime": {},
    "notificationNames": [
      "string"
    ],
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "previousRunTime": {},
    "schedule": "string",
    "silencedUntil": {},
    "sourceID": "string",
    "status": "string",
    "throttle": 0,
    "updatedAt": {},
    "workerID": "string",
    "workspaceID": "string"
  },
  "success": true
}

HealthCheckSubscriptionUnsilence operation

POST
/health-checks/subscriptions/unsilence

Request Body

application/jsonRequired

idstring

curl -X POST "https://api.runreveal.com/health-checks/subscriptions/unsilence" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "consecutiveFailures": 0,
    "createdAt": {},
    "createdBy": "string",
    "displayName": "string",
    "enabled": true,
    "failureThreshold": 0,
    "firstFailedAt": {},
    "id": "string",
    "lastNotified": {},
    "managedDetectionConfigID": "string",
    "name": "string",
    "nextRunTime": {},
    "notificationNames": [
      "string"
    ],
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "previousRunTime": {},
    "schedule": "string",
    "silencedUntil": {},
    "sourceID": "string",
    "status": "string",
    "throttle": 0,
    "updatedAt": {},
    "workerID": "string",
    "workspaceID": "string"
  },
  "success": true
}

HealthCheckSubscriptionUpdate operation

PUT
/health-checks/subscriptions/update

Request Body

application/jsonRequired

displayNamestring

enabledboolean

failureThresholdinteger

idstring

namestring

notificationNamesarray<string>

parametersobject

schedulestring

silencedUntilobject

throttleinteger

curl -X PUT "https://api.runreveal.com/health-checks/subscriptions/update" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "string",
    "enabled": true,
    "failureThreshold": 0,
    "id": "string",
    "name": "string",
    "notificationNames": [
      "string"
    ],
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "schedule": "string",
    "silencedUntil": {},
    "throttle": 0
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "consecutiveFailures": 0,
    "createdAt": {},
    "createdBy": "string",
    "displayName": "string",
    "enabled": true,
    "failureThreshold": 0,
    "firstFailedAt": {},
    "id": "string",
    "lastNotified": {},
    "managedDetectionConfigID": "string",
    "name": "string",
    "nextRunTime": {},
    "notificationNames": [
      "string"
    ],
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "previousRunTime": {},
    "schedule": "string",
    "silencedUntil": {},
    "sourceID": "string",
    "status": "string",
    "throttle": 0,
    "updatedAt": {},
    "workerID": "string",
    "workspaceID": "string"
  },
  "success": true
}