Skip to main content
ZStack
Platform Operations/Platforms

TestConnection

Test the connectivity to a registered platform and return the result.

POST/api/v1/platforms/{uuid}/test

Operation ID

TestConnection

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Path Parameters

  • uuid
    StringRequired

    UUID of the platform whose connection should be tested

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • message
    String

    Human-readable message describing the connection test result

    Example: Connection successful