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

ListSyncs

List all active sync scheduler configurations across platforms.

Execution Availability

Try It Out

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

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    List of sync configurations

    Example: (nested array)

    • platformUuidString

      UUID of the platform this sync configuration belongs to

      Example: plat-abc123-def456

    • intervalString

      Sync interval expression (cron format)

      Example: */5 * * * *

    • resourcesLinkedHashMap

      Associated resource list

      Example: (nested object)

    • stateString

      Current sync configuration state: active, paused, or not_configured

      Example: active

    • pausedBoolean

      Whether the sync configuration is paused

      Example: false

  • totalInteger

    Total number of sync configurations

    Example: 5

  • limitInteger

    Maximum number of items per page

    Example: 20

  • offsetInteger

    Number of items skipped

    Example: 20

Endpoint

GET/api/v1/platforms/syncs

/api/v1/platforms/syncs

Operation ID

ListSyncs

Permalink

Request Example

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

Response Example

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

Change History

This API has no change history records yet.

View all change history