Networking

Update Orthanc peer

Define a new Orthanc peer, or update an existing one. This change is permanent iff. OrthancPeersInDatabase is true, otherwise it is lost at the next restart of Orthanc.

put/peers/{id}

Request

Base URL
https://orthanc.uclouvain.be/demo
Auth
none declared
TypeScript
https://skmtc.dev/uclouvain/apis/orthanc-api/docs/peers/:id/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Identifier of the new/updated Orthanc peer

Request body

CertificateFilestring

SSL certificate for the HTTPS connections

CertificateKeyFilestring

Key file for the SSL certificate for the HTTPS connections

CertificateKeyPasswordstring

Key password for the SSL certificate for the HTTPS connections

HttpHeadersobject

HTTP headers to be used for the connections to the remote peer

Passwordstring

Password for the credentials

URLstring

URL of the root of the REST API of the remote Orthanc peer, for instance http://localhost:8042/

Usernamestring

Username for the credentials

Changes

No recorded changes to this operation across all 3 revisions of this API.