Signals
List the project's client certificates
- Sandbox: available
- On your own host? Choose https://{host} in the playground.
GET
Lists the client certificates registered for your current project. With SIGNALS_MTLS_ENABLED on, every call into Signals through /v1/signals/api/* must present one of them.
Auth: A client credential cannot read or change them. Scope: the caller's project (from the token).
Behaviour
- Each certificate is known by
sha256, its SHA-256 fingerprint in lowercase hex. Ovok never holds a private key. - A project holds at most two: the one in use and one to rotate to.
- A certificate past
notAfterstays listed until it is removed, but calls presenting it are refused. environmentsays what this Ovok environment can do:issues(a CA to issue from a CSR),registers(a CA it trusts for registration) andforwardsCertificates(an edge that passes client certificates on, whichSIGNALS_MTLS_ENABLEDneeds). Check it before offering an action that would answer 501 or 409.environment.caCertificateis the CA Ovok issues from, PEM, or null where it issues none.- With
SIGNALS_MTLS_ENABLEDon, Signals presents its own client certificate on every webhook delivery to your https endpoints. The certificate chains to that CA and carries the subject alternative nameurn:ovok:signals:<environment>. - To accept only Signals, verify the client certificate against
caCertificateand pin that name. Your project's own client certificates chain to the same CA, so the CA alone is not enough. - Keep verifying the
webhook-signaturetoo. With the setting off, deliveries carry no client certificate. - A project without a Signals tenant of its own answers 409
SIGNALS_TENANT_NOT_OWN.
Example
curl 'https://api.sandbox.ovok.com/v1/signals/certs' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'Who can call it: a project admin. See roles.
bearerheader
AuthorizationBearer <JWT>The registered certificates, at most two, and what this environment can do for them. Never a private key.
application/json- response
certificates*array<>environment*curl -X GET 'https://api.sandbox.ovok.com/v1/signals/certs'Example Response
{ "certificates": [ { "sha256": "string", "serialNumber": "string", "subject": "string", "notAfter": "string", "registeredAt": "string" } ], "environment": { "issues": true, "registers": true, "forwardsCertificates": true, "caCertificate": "string" }}