Skip to content

operations.add_server

POST
/servers

Add a server to the federation.

Parameters

Query Parameters

register
boolean

Re-register all known servers/services

Request Body

object
server
required

A federated CanDIG instance in the network

object
id
required

Unique id for the server

string
url
required

Base URL of the CanDIG instance

string
https://candig.uhnresearch.ca
location
required
object
name
string
UHN
province
string
Ontario
province-code
string
ca-on
testing

If True, this is only registered as a test server in Federation, not in CanDIG overall

boolean
authentication
required
One of:
object
issuer
required

Issuer associated with the OIDC token.

string
token
required

OIDC access token issued to a user from the issuer. Can be expired, as long as it’s verifiable with the current public key.

string

Responses

201

Server registered successfully

204

Server already registered

403

Authorization Error

500

Internal Error