Create a Federation

Define a new Platform Federation on the Controller JPD. A federation specifies which Curation entities to synchronize and which Follower JPDs participate.

Prerequisites: All Follower JPDs referenced in target_jpd_ids must already be added via the Add a Follower JPD API (POST /pfed/api/v1/jpd).

The request body follows a fixed structure. Only the following fields are user-configurable:

  • name — A unique name for this federation.
  • description — A brief description of the use case.
  • connection_groups.source-jpd.target_jpd_ids — The list of Follower JPD IDs to include.

The connection_groups key ("source-jpd") and the entities list are fixed and must be provided exactly as shown in the example.

Fixed entity types (must all be included as-is):

  • catalog.customLabels — Catalog custom labels
  • xray.curationCondition — Curation conditions
  • xray.curationPkgType — Curation package types
  • xray.curationPolicy — Curation policies

Security: Requires admin privileges.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for creating a Platform Federation.

Only the following fields are user-configurable:

  • name — A unique name for this federation.
  • description — A brief description of the use case.
  • connection_groups.source-jpd.target_jpd_ids — The list of Follower JPD IDs.

The connection_groups key must be "source-jpd". The entities array is fixed and must be included exactly as shown — it cannot be modified or omitted.

string
required

A unique name for this federation within your subscription

string

A brief description of the use case or feature supported by the federation

connection_groups
object
required

Connection group configuration. Must contain a single key "source-jpd" mapping to a connection group with the target Follower JPD IDs.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json