Endpoints & certificates

An endpoint represents one sending facility — a hospital, clinic, or research site — paired with the HTTPS destination URL its DICOM is delivered to. A certificate represents one device identity within that facility (a scanner, PACS, workstation, or archive) that authenticates to the endpoint.

Endpoint basics

Create one endpoint per sending facility. Each endpoint response includes:

• id
• name
• destination_url
• status
• dicom_host
• dicom_port
• peer_ae_title
• certificate_count

Certificates

Certificates let you onboard and revoke senders independently.

1. Create the endpoint and first certificate with POST /v1/endpoints.
2. Add more senders with POST /v1/endpoints/{endpointId}/certificates.
3. Rotate expiring certificates with POST /v1/endpoints/{endpointId}/certificates/{certId}/rotate.
4. Revoke a single sender with DELETE /v1/endpoints/{endpointId}/certificates/{certId}.

One endpoint per facility

Each endpoint corresponds to one sending facility or site. Within a facility, issue one certificate per device. Use separate endpoints for separate facilities.

This keeps usage logs, billing, and audit trails clean per site — and matches the Terms of Service requirement (§5 Acceptable Use).

Common pattern: many devices, one facility

A PACS, a modality workstation, and a research archive at the same site can each hold their own certificate while posting to the same HTTPS destination.

Endpoint → https://your-app.io/dicom   (one facility)
  ├─ Certificate A → CT scanner
  ├─ Certificate B → PACS
  └─ Certificate C → Archive

Use the X-Dicomly-Cert-Id header to identify which device delivered each request. For a second facility, create a second endpoint.