Command Line Interface / List resources - Automation

Lists active checks or services and returns unique identifier for each resource (resource identifiers). Resource identifiers are required for most other tasks: pause, resume, delete. They can be used with dashes (for example ac94bd0f-7e15-4acb-8779-c80ab1c92ba5) or without them (for example ac94bd0f7e154acb8779c80ab1c92ba5).

Usage: list all services and get their resource identifiers

dotnet AppBeat.CLI.dll list services

Output example:


{
  "List": [
    {
      "Name": "My Monitored App",
      "IsPaused": false,
      "Id": "00257c9d-a86b-4427-9105-e683e8148e3f"
    }
  ],
  "Success": true,
  "Error": null
}

Usage: list all checks and get their resource identifiers

dotnet AppBeat.CLI.dll list checks

Output example:


{
  "List": [
    {
      "Name": "Check1",
      "IsPaused": false,
      "Id": "260e03bd-7211-419e-be3f-a1af972ff947"
    },
    {
      "Name": "My check 2",
      "IsPaused": false,
      "Id": "1724eab0-34a1-4e75-acec-c6fa50c19478"
    },
    {
      "Name": "test1",
      "IsPaused": false,
      "Id": "26914854-b888-4ae5-b53a-6968518df0cd"
    }
  ],
  "Success": true,
  "Error": null
}

Usage: list all checks for specific service (in our case identified by 00257c9d-a86b-4427-9105-e683e8148e3f) and get their resource identifiers

dotnet AppBeat.CLI.dll list checks 00257c9d-a86b-4427-9105-e683e8148e3f

Output example:


{
  "List": [
    {
      "Name": "Check1",
      "IsPaused": false,
      "Id": "260e03bd-7211-419e-be3f-a1af972ff947"
    },
    {
      "Name": "My check 2",
      "IsPaused": false,
      "Id": "1724eab0-34a1-4e75-acec-c6fa50c19478"
    },
    {
      "Name": "test1",
      "IsPaused": false,
      "Id": "26914854-b888-4ae5-b53a-6968518df0cd"
    }
  ],
  "Success": true,
  "Error": null
}

Questions and Feedback

If you have any questions or issues please let us know. You can contact us here.