Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: SignOps Status API
version: 1.0.0
description: 'Push notifications to Android, iOS and the web, login approval on a trusted phone, passkeys, authenticator codes and email OTP, on one API key and your own user ids. Errors are { error: { code, message } }. Test keys (sk_test_) send only to test devices and addresses and are not billed.'
contact:
email: hello@signops.dev
url: https://signops.dev/docs/
termsOfService: https://signops.dev/terms/
servers:
- url: https://api.signops.dev
security:
- secretKey: []
tags:
- name: Status
paths:
/v1/health:
get:
operationId: getHealth
summary: Health
description: '200 with ok: true when the database answers, the scheduler ran in the last five minutes and no send is stuck; 503 otherwise.'
tags:
- Status
security: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
description: Whether every check passed.
4XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Error:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: Machine-readable code, like invalid_request, rate_limited or expired.
message:
type: string
description: Written for a developer to read.
required:
- code
- message
required:
- error
securitySchemes:
secretKey:
type: http
scheme: bearer
description: sk_live_... or sk_test_..., on your server only.
publishableKey:
type: http
scheme: bearer
description: pk_live_... or pk_test_..., used by the SDKs in apps and browsers.
externalDocs:
description: Docs
url: https://signops.dev/docs/