---
updatedAt: 2026-04-05T12:27:38.000Z
agentTools:
  siteIndex: https://docs.jfrog.com/llms.txt
  projectIndex: https://docs.jfrog.com/administration/llms.txt
---

# Get a Federation

Retrieve the full details of a specific federation by its ID, including connection groups and entity types.

**Security:** Requires admin privileges.


# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "JFrog Platform - Curation Federation API",
    "description": "Curation Federation APIs for synchronizing Curation entities across multiple JPDs in a Controller/Follower topology.\n\n**Authentication:** Access Tokens as bearer token in authorization header (Authorization: Bearer `<token>`)\n\n**Security:** All APIs require admin privileges.\n",
    "version": "1.0.0",
    "contact": {
      "name": "JFrog Support"
    }
  },
  "servers": [
    {
      "url": "https://{jfrog_url}",
      "description": "JFrog Platform Server"
    }
  ],
  "tags": [
    {
      "name": "Federations",
      "description": "APIs for creating, listing, retrieving, and deleting Platform Federations on the Controller JPD."
    }
  ],
  "security": [
    {
      "AdminBearerAuth": []
    }
  ],
  "paths": {
    "/pfed/api/v1/federations/{id}": {
      "get": {
        "tags": [
          "Federations"
        ],
        "summary": "Get a Federation",
        "description": "Retrieve the full details of a specific federation by its ID, including connection groups and entity types.\n\n**Security:** Requires admin privileges.\n",
        "operationId": "getFederation",
        "parameters": [
          {
            "$ref": "#/components/parameters/FederationId"
          }
        ],
        "responses": {
          "200": {
            "description": "Federation details returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FederationDetails"
                },
                "example": {
                  "id": "fed-abc123",
                  "name": "curation federation",
                  "description": "manage curation over multisite architecture",
                  "connection_groups": {
                    "source-jpd": {
                      "target_jpd_ids": [
                        "follower_1",
                        "follower_n"
                      ]
                    }
                  },
                  "entities": [
                    {
                      "type": "catalog.customLabels"
                    },
                    {
                      "type": "xray.curationCondition"
                    },
                    {
                      "type": "xray.curationPkgType"
                    },
                    {
                      "type": "xray.curationPolicy"
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized — missing or invalid admin token",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden — insufficient permissions",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Not Found — federation with specified ID does not exist",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "AdminBearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "Access Token with admin permissions as bearer token",
        "bearerFormat": "JWT"
      }
    },
    "parameters": {
      "FederationId": {
        "name": "id",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string"
        },
        "description": "The unique identifier of the federation",
        "example": "fed-abc123"
      }
    },
    "schemas": {
      "ConnectionGroup": {
        "type": "object",
        "description": "Defines a connection group within a federation. Specifies the target Follower JPDs\nthat a source JPD will synchronize entities to.\n",
        "required": [
          "target_jpd_ids"
        ],
        "properties": {
          "target_jpd_ids": {
            "type": "array",
            "description": "List of unique IDs of the Follower JPDs that participate in this connection group",
            "items": {
              "type": "string"
            },
            "example": [
              "follower_1",
              "follower_2"
            ]
          }
        }
      },
      "EntityConfig": {
        "type": "object",
        "description": "Configuration for an entity type to be synchronized.\nEntity type names follow the format `<service>.<entityType>`.\n",
        "required": [
          "type"
        ],
        "properties": {
          "type": {
            "type": "string",
            "description": "The entity type identifier in `<service>.<entityType>` format.\nSupported types:\n- `catalog.customLabels` — Catalog custom labels\n- `xray.curationCondition` — Curation conditions\n- `xray.curationPkgType` — Curation package types\n- `xray.curationPolicy` — Curation policies\n"
          }
        }
      },
      "FederationDetails": {
        "type": "object",
        "description": "Full details of a federation configuration including connection groups and entity types",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier of the federation (generated by the system)",
            "example": "fed-abc123"
          },
          "name": {
            "type": "string",
            "description": "The unique name of the federation",
            "example": "curation federation"
          },
          "description": {
            "type": "string",
            "description": "A brief description of the federation",
            "example": "manage curation over multisite architecture"
          },
          "connection_groups": {
            "type": "object",
            "description": "Mapping of source JPD IDs to their connection group configurations",
            "additionalProperties": {
              "$ref": "#/components/schemas/ConnectionGroup"
            }
          },
          "entities": {
            "type": "array",
            "description": "List of entity types synchronized by this federation",
            "items": {
              "$ref": "#/components/schemas/EntityConfig"
            }
          }
        }
      },
      "ErrorResponse": {
        "type": "object",
        "description": "Standard error response",
        "properties": {
          "message": {
            "type": "string",
            "description": "Human-readable error message",
            "example": "Invalid JSON format"
          },
          "code": {
            "type": "integer",
            "description": "HTTP status code",
            "example": 400
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": false
  }
}
```