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

ValidatePlatform

Validate platform connection parameters before creating a platform record.

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • nameStringRequired

    Human-readable name for the platform being validated

    Example: prod-zstack-01

  • productTypeStringRequired

    Product type identifier for validation

    Example: zstack

  • hostIpStringRequired

    IP address to validate connectivity against

    Example: 192.168.1.100

  • hostPortIntegerRequired

    Port number to validate connectivity against

    Example: 8080

  • usernameStringRequired

    Username credential for validation

    Example: admin

Responses

200 OK

On success, this API returns the following response structure.

  • messageString

    Validation result message describing what was checked

    Example: Platform configuration is valid

Endpoint

POST/api/v1/platforms/validate

/api/v1/platforms/validate

Operation ID

ValidatePlatform

Permalink

Request Example

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

Response Example

200
{
  "message": "Platform configuration is valid"
}

Change History

This API has no change history records yet.

View all change history