Get a server's probes

QA Environment

https://qa-api.kiolinkapp.com

GET

/v1/mykio/probes/{console_id}/{domain}/{hub}/{robot}

MyKIO

Last modified:2026-10-05 23:38:42

Maintainer:Not configured

Required Permission(s):mykio-nimsoft-details

Returns the probes (monitoring agents) installed on one of the user's servers, from CA UIM (Nimsoft).

hub and robot must belong to one of the user's consoles; console_id itself is not checked against them, so any Nimsoft console can be queried when the hub and robot names match.

Works on the monitoring consoles assigned to the signed-in business user (business consoles of type nimsoft; business admins get every console of their business). KIO users get HTTP 500.

Errors of the external system are reported with HTTP 200 and an error body (e.g. Error retriving information.).

Requires a session token whose role has any of these permissions: mykio-nimsoft-details.

Request

Authorization

API Key

Add parameter in header

authorization

Example:

authorization: ********************

Path Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://qa-api.kiolinkapp.com/v1/mykio/probes/65f1c2a9e4b0a1b2c3d4ea10/KIO_DOMAIN/KIO-HUB-MEX1/srv-app-01' \
--header 'authorization: <api-key>'

Responses

🟢200Probes

application/json

Probes. Returned as a one-item array that contains the per-console responses.

Bodyapplication/json

Examples

SuccessExternal error

[
    [
        {
            "_id": "65f1c2a9e4b0a1b2c3d4ea01",
            "slug": "uim.kio.tech-443-/rest/hubs/KIO_DOMAIN/KIO-HUB-MEX1/srv-app-01",
            "data": {
                "probe": [
                    {
                        "name": "cdm",
                        "active": true
                    }
                ]
            },
            "created": "2026-10-05T18:00:00.000Z",
            "expireAt": "2026-10-05T19:00:00.000Z",
            "__v": 0
        }
    ]
]

🟠401The session token expired

🟠403Not authenticated (missing/invalid token, inactive user), or

🔴500Unexpected error

Modified at 2026-10-05 23:38:42

Get my monitored servers

Get a server's ping history