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

GetPlatform

Retrieve detailed information about a specific federation platform by UUID.

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 to retrieve

Responses

200 OK

On success, this API returns the following response structure.

  • uuidString

    Unique identifier of the platform

    Example: plat-abc123-def456

  • nameString

    Human-readable name of the platform

    Example: prod-zstack-01

  • productTypeString

    Product type identifier (e.g. zstack, vmware)

    Example: zstack

  • hostIpString

    IP address of the platform host

    Example: 192.168.1.100

  • hostPortInteger

    Port number of the platform API endpoint

    Example: 8080

  • accessKeyNameString

    Name of the access key credential used for authentication

    Example: admin-key

  • statusString

    Current operational status of the platform connection

    Example: connected

  • lastErrorString

    Last error message if the platform encountered a failure

    Example: connection timeout

  • featuresObject

    Feature flags enabled for this platform

    • syncResourceBoolean

      Whether resource synchronization is enabled for this platform

      Example: true

    • monitoringBoolean

      Whether monitoring data collection is enabled

      Example: true

    • logCollectionBoolean

      Whether log collection is enabled for this platform

      Example: false

    • credentialObject

      Encrypted admin credential (AES-256-GCM ciphertext) captured at CreatePlatform

      • usernameEncString

        AES-256-GCM ciphertext (base64) of the admin username

        Example: value

      • passwordEncString

        AES-256-GCM ciphertext (base64) of the admin password

        Example: value

  • versionString

    Version string of the platform software

    Example: 4.3.0

  • healthStatusString

    Overall health status of the platform (healthy, degraded, unhealthy)

    Example: healthy

  • lastSuccessAtString

    Last success at

    Example: 2026-01-15T08:00:00Z

  • lastErrorAtString

    Last error at

    Example: 2026-01-15T08:00:00Z

  • lastErrorDetailString

    Detailed description of the last error for diagnostics

    Example: dial tcp 192.168.1.100:8080: connect: connection refused

  • successCountInteger

    Cumulative count of successful operations

    Example: 1024

  • errorCountInteger

    Cumulative count of failed operations

    Example: 3

  • createDateString

    Create date

    Example: 2026-01-15T08:00:00Z

  • lastOpDateString

    Last op date

    Example: 2026-01-15T08:00:00Z

  • scopeString

    Connection scope: 'region' (resource-type) or 'global' (platform-level)

    Example: region

  • regionUuidString

    UUID of the Region this connection belongs to (empty for global scope)

    Example: region-abc123-def456

Endpoint

GET/api/v1/platforms/{uuid}

/api/v1/platforms/{uuid}

Operation ID

GetPlatform

Permalink

Request Example

curl -X GET '{host}/api/v1/platforms/{uuid}' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "uuid": "plat-abc123-def456",
  "name": "prod-zstack-01",
  "productType": "zstack",
  "hostIp": "192.168.1.100",
  "hostPort": 8080,
  "accessKeyName": "admin-key",
  "status": "connected",
  "lastError": "connection timeout"
}

Change History

This API has no change history records yet.

View all change history