Chilkat Online Tools

Objective-C / ForgeRock Identity Cloud Collection / Check Health

Back to Collection Items

#import <CkoHttp.h>
#import <CkoStringBuilder.h>

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://<tenant-name>.forgeblocks.com/monitoring/health" sbContent: sbResponseBody];
if (success == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%@%d",@"Response status code = ",[http.LastStatus intValue]);
NSLog(@"%@",[sbResponseBody GetAsString]);

Curl Command

curl -X GET
https://<tenant-name>.forgeblocks.com/monitoring/health

Postman Collection Item JSON

{
  "name": "Check Health",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "const JSONResponse = JSON.parse(responseBody);",
          "",
          "pm.test(\"Status code is 200.\", () => {",
          "  pm.expect(pm.response.code).to.eql(200);",
          "});",
          "",
          "pm.test(\"ID Cloud status is OK\", function () {",
          "    pm.expect(JSONResponse.status).to.eql(\"OK\");",
          "});"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{platformUrl}}/monitoring/health",
      "host": [
        "{{platformUrl}}"
      ],
      "path": [
        "monitoring",
        "health"
      ]
    },
    "description": "Is the Identity Cloud \"alive\"?"
  },
  "response": [
    {
      "name": "Prometheus metrics for all AM pods",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/metrics/prometheus/am",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "metrics",
            "prometheus",
            "am"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": "# HELP am_cts_task_queue_size number of operations waiting in a CTS queue\n# TYPE am_cts_task_queue_size gauge\nam_cts_task_queue_size{kubernetes_pod_name=\"am-568cc4fbb6-cjnpg\",} 0.0"
    }
  ]
}