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

ListPlatforms

List all registered federation platforms with pagination support.

Execution Availability

Try It Out

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

Query Parameters

Request Inputs

Query Parameters

  • limitInteger

    Maximum number of results to return Maximum number of results to return

    Example: 0

  • offsetInteger

    Number of results to skip for pagination Number of results to skip for pagination

    Example: 0

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    List of platform records

    Example: (nested array)

    • 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

  • totalInteger

    Total number of platforms matching the query

    Example: 42

  • limitInteger

    Maximum number of items returned per page

    Example: 20

  • offsetInteger

    Number of items skipped

    Example: 20

Endpoint

GET/api/v1/platforms

/api/v1/platforms

Operation ID

ListPlatforms

Permalink

Request Example

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

Response Example

200
{
  "items": [
    {}
  ],
  "total": 42,
  "limit": 20,
  "offset": 20
}

Change History

This API has no change history records yet.

View all change history