Federations

A federation is the top-level grouping in Nucleus — one hub, N spokes, all sharing a federation mode and a customer.

Federations

Operations

GET/api/federationsGET/api/federations/{federationId}PATCH/api/federations/{federationId}

---

List federations visible to the caller

GET

/api/federations

Hub admins see only their own federations; operators see everything.

Authorizations

bearer

Type

HTTP (bearer)

Responses

GET

/api/federations

Playground

Server

Authorization

bearer

Samples

---

Get a federation by id

GET

/api/federations/{federationId}

Authorizations

bearer

Type

HTTP (bearer)

Parameters

Path Parameters

federationId*

Federation slug or id.

Type

string

Required

Responses

GET

/api/federations/{federationId}

Playground

Server

Authorization

bearer

Variables

Key

Value

federationId*

Samples

---

Update federation-wide config

PATCH

/api/federations/{federationId}

Mode changes ripple into every Moodle in the federation via the local_nucleuscommon_set_federation_mode WS function. Operator-only.

Authorizations

bearer

Type

HTTP (bearer)

Parameters

Path Parameters

federationId*

Federation slug or id.

Type

string

Required

Request Body

application/json

{

}

Responses

PATCH

/api/federations/{federationId}

Playground

Server

Authorization

bearer

Variables

Key

Value

federationId*

Body

Samples

---

Powered by VitePress OpenAPI