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

HandleResourceCallback

Handle incoming resource change callback from a downstream 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

  • groupIdStringRequired

    ID of the cluster group this callback belongs to

  • platformIdStringRequired

    ID of the platform sending the callback

Body Fields

  • payloadObjectRequired

    Raw resource change payload from the downstream platform

    Example: (nested object)

Responses

200 OK

On success, this API returns the following response structure.

  • acceptedBoolean

    Whether the callback payload was accepted for processing

    Example: true

  • resourcesProcessedInteger

    Number of resources processed from the callback payload

    Example: 5

Endpoint

POST/api/v1/federation/cluster-groups/{groupId}/callbacks/{platformId}

/api/v1/federation/cluster-groups/{groupId}/callbacks/{platformId}

Operation ID

HandleResourceCallback

Permalink

Request Example

curl -X POST '{host}/api/v1/federation/cluster-groups/{groupId}/callbacks/{platformId}' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"payload":"(nested object)"}'

Response Example

200
{
  "accepted": true,
  "resourcesProcessed": 5
}

Change History

This API has no change history records yet.

View all change history