Skip to main content
POST
/
api
/
core
/
platform_settings
/
network-connectivity
/
{protocol}
Test network connectivity
curl --request POST \
  --url https://api.example.com/api/core/platform_settings/network-connectivity/{protocol} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "response_time_ms": 123,
  "message": "<string>",
  "details": {
    "timeout": 123,
    "host": "<string>",
    "port": 123,
    "url": "<string>",
    "status_code": 123,
    "error_type": "CONNECTION_ERROR",
    "response_headers": {},
    "response_body": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer token authentication. Format: 'Bearer '

Path Parameters

protocol
string
required

Response

Successful Response

success
boolean
required
response_time_ms
number
required
message
string
required
details
NetworkConnectivityTestDetailsSchema · object
required