API reference
Update federation peer
Contract and client context
Operation: update_federation_peer · HTTP: PUT /v1/federation/peers/self
Use an operator-supplied registry base URL. Request execution is disabled in this documentation explorer. Generated request snippets are templates, not signed or authorized submissions.
Exact operation definition
{
"operationId": "update_federation_peer",
"parameters": [
{
"description": "Required route-scoped idempotency key",
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FederationPeerUpdateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FederationPeer"
}
}
},
"description": "Principal-bound peer metadata"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Session missing or invalid"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Federation capability missing"
}
},
"security": [
{
"siwsSession": []
},
{
"siwsCookie": []
}
],
"tags": [
"federation"
]
}Resolve schema references against the complete OpenAPI document. Standalone schemas and hashes are generated from the same checked-in source.
PUT
/v1/federation/peers/selfAuthorizationBearer <token>
Opaque capability-bearing MARS session issued by an enabled authentication profile.
In: header
Header Parameters
Idempotency-Key*string
Required route-scoped idempotency key
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Peer-controlled request for registering or changing its endpoint metadata.
Response Body
application/json
application/json
application/json
curl -X PUT "https://example.com/v1/federation/peers/self" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "endpoint": "string" }'{ "agreementIds": [ "string" ], "endpoint": "string", "grpcEndpoint": "string", "lastSeen": "2019-08-24T14:15:22Z", "peerDid": "string"}