Skip to main content
API Explorer|API Explorer
Platform Operations/Platforms
POSTPlatformSince 1.0SynchronousAuth Required

TestConnection

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

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    UUID of the platform whose connection should be tested

Responses

200 OK

On success, this API returns the following response structure.

  • messageString

    Human-readable message describing the connection test result

    Example: Connection successful

Endpoint

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

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

Operation ID

TestConnection

Permalink

Request Example

curl -X POST '{host}/api/v1/platforms/{uuid}/test' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"key": "value"}'

Response Example

200
{
  "message": "Connection successful"
}

Change History

This API has no change history records yet.

View all change history