Skip to main content
ZStack
Platform Operations/Platforms

ValidatePlatform

Validate platform connection parameters before creating a platform record.

POST/api/v1/platforms/validate

Operation ID

ValidatePlatform

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

application/json

Body Fields

  • name
    StringRequired

    Human-readable name for the platform being validated

    Example: prod-zstack-01

  • productType
    StringRequired

    Product type identifier for validation

    Example: zstack

  • hostIp
    StringRequired

    IP address to validate connectivity against

    Example: 192.168.1.100

  • hostPort
    IntegerRequired

    Port number to validate connectivity against

    Example: 8080

  • username
    StringRequired

    Username credential for validation

    Example: admin

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • message
    String

    Validation result message describing what was checked

    Example: Platform configuration is valid