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

GetSyncStatus

Get the current sync configuration and resource map for a platform.

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

Responses

200 OK

On success, this API returns the following response structure.

  • 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

Endpoint

GET/api/v1/platforms/sync/{uuid}

/api/v1/platforms/sync/{uuid}

Operation ID

GetSyncStatus

Permalink

Request Example

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

Response Example

200
{
  "platformUuid": "plat-abc123-def456",
  "interval": "*/5 * * * *",
  "resources": null
}

Change History

This API has no change history records yet.

View all change history