Signals

Remove a client certificate

  • Sandbox: available
  • On your own host? Choose https://{host} in the playground.
DELETE
/v1/signals/certs/{sha256}

Removes one of your current project's client certificates. From then on, calls presenting it are refused.

Scope: the caller's project (from the token).

Behaviour

  • :sha256 is the certificate's fingerprint as GET /v1/signals/certs lists it.
  • An unknown fingerprint answers 404 CERTIFICATE_NOT_FOUND.
  • While SIGNALS_MTLS_ENABLED is on, the project's last certificate cannot be removed: 409 LAST_CERTIFICATE_IN_USE. Every call into Signals would be refused without one. Register another certificate, or turn mutual TLS off, first.
  • The answer is 204 with no body.

Example

curl -X DELETE 'https://api.sandbox.ovok.com/v1/signals/certs/3f6c0d2a9b8e7f1c4d5a6b7c8d9e0f1a2b3c4d5e6f708192a3b4c5d6e7f80912' \  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'

Who can call it: a project admin. See roles.

Authorization

bearer
headerAuthorizationBearer <JWT>

Path Parameters

sha256*string
Match^[0-9a-fA-F]{64}$

Response Body

Removed. Calls presenting it are refused from now on.

Example Request
curl -X DELETE 'https://api.sandbox.ovok.com/v1/signals/certs/string'
Example Response
Empty

Issue a client certificate from a CSR POST

Issues a client certificate for your current project from a certificate signing request (CSR), and registers it. Calls into Signals may then present it, and must once `SIGNALS_MTLS_ENABLED` is on. **Auth:** A client credential cannot issue a certificate for itself. **Scope:** the caller's project (from the token). ## Behaviour - Make a key and a CSR on your side, and send the CSR as PEM in `csr`. The private key never leaves your client. - The key must be an EC key on P-256 or P-384 that names its curve, or an RSA key of at least 2048 bits, and the CSR's signature must verify. Otherwise 422 `CSR_NOT_ACCEPTED`, with the reason. - Ovok's CA signs a certificate for client authentication only, valid for six months, or until the CA itself expires if that comes first. Its `notAfter` is in the answer. Its subject is `CN=<tenant id>` and its subject alternative name `urn:ovok:signals-tenant:<tenant id>`. Nothing else in the CSR is taken over. - The certificate counts towards the project's two: a third answers 409 `CERTIFICATE_LIMIT_REACHED`. - An environment with no CA set up to issue answers 501 `FEATURE_NOT_CONFIGURED`. If its CA has expired, Ovok registers nothing and answers 500 `INTERNAL_ERROR`. - The answer is 201 with the registered certificate and its PEM in `certificate`, and `Location` names it. - At 00:00 UTC, 14 days before the certificate expires, Ovok notifies the project's admins in the Console and mails them and its parent project's admins. A certificate registered closer to its expiry is mailed about at once; a removed one is not. - To rotate: issue a new certificate, move your clients to it, then remove the old one. ## Example ```bash openssl req -new -newkey ec -pkeyopt ec_paramgen_curve:prime256v1 -pkeyopt ec_param_enc:named_curve -nodes \ -keyout client.key -out client.csr -subj "/CN=client" curl -X POST 'https://api.sandbox.ovok.com/v1/signals/certs/issue' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \ -H 'Content-Type: application/json' \ -d "{ \"csr\": $(jq -Rs . < client.csr) }" | jq -r .certificate > client.crt ``` **Who can call it:** a project admin. See [roles](/access-policies#who-can-call-a-route).

List alerts, or the episodes they were folded into GET

Lists alerts, one row per breach. With `episodes=true` it lists episodes instead: one row per clinical event, which opens on the first breaching reading and closes on recovery, on going stale or by hand. - **Alerts:** filter by `status` (`ACTIVE` or `RESOLVED`), `codes`, `since`, `until`, `acknowledged` and `ids` (patients). Sort with `sort=time-desc`, the default, or `time-asc`. Page with `page` and `limit`, or past 10,000 rows with `cursor`. - **Episodes:** `status` is `OPEN` or `CLOSED`, and `codes` defaults to the tenant's `feedCodes`. Sort by `openedAt`, the default, or `lastFiringAt`, and page with `cursor`. Signals records episodes only while the tenant has `episodicAlerts` on. - `until`, `page` and `ids` work on alerts only: sending one with `episodes=true` answers 422. - Walking pages sorted by `lastFiringAt` can miss an episode that fires mid-walk; `openedAt` never does. ### Through ovok - **Capabilities:** `signals_alerts:read`, held by Manager apps. See [app types](/signals/standalone#app-types). - ovok sets `project` to your project, so you can leave it out. - **Patient access:** name them with `patientId` or `ids`, each one you can read, at most 100. Signals then pages over just those patients, so pages and totals stay true. See [patient access](/signals/standalone#patient-access).