Skribble Monitoring API
Endpoints for monitoring system health.
Endpoints for monitoring system health.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/skribble:skribble-monitoring-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Skribble Monitoring API
contact:
name: Skribble Engineering
url: https://skribble.com
email: support@skribble.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
termsOfService: https://www.skribble.com/en-eu/terms-of-use/
version: '1.0'
description: 'Operations tagged Monitoring across 3 of this provider''s published API definitions: skribble-sign-v3-openapi.yml, skribble-sign-v2-openapi.yml, skribble-sign-v3-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.skribble.com/v3
description: Production - Switzerland
- url: https://api.skribble.de/v3
description: Production - Germany
- url: https://api.skribble.com/v2
description: Production - Switzerland
- url: https://api.skribble.de/v2
description: Production - Germany
security: []
tags:
- name: Monitoring
description: Endpoints for monitoring system health.
paths:
/management/health:
get:
tags:
- Monitoring
summary: System Health
description: 'Returns the current health status of the Skribble API. Use this endpoint
to monitor system availability and responsiveness.
`status:UP` indicates that the system is operational.'
operationId: getSystemHealth
security:
- {}
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SystemHealthResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/ServerError'
'503':
$ref: '#/components/responses/ServiceUnavailable'
servers:
- url: https://api.skribble.com/v3
description: Production - Switzerland
- url: https://api.skribble.de/v3
description: Production - Germany
components:
schemas:
ProblemResponse:
title: Problem
type: object
description: 'Error response envelope returned for all 4xx and 5xx responses with a JSON body.
Follows a Problem+JSON-style shape. The `key` field is optional and only present
for errors that carry a machine-readable code.'
required:
- type
- method
- path
- status
- message
properties:
type:
type: string
format: uri
description: 'URI identifying the problem category. The host of this URI depends on
the environment the request was made against (e.g. `api.skribble.com`
and `api.skribble.de` for the production regions; other environments
use their respective hosts). Match on the path segment after `/problem/`
rather than the full URI. Known values:
- `https://api.skribble.com/problem/problem-with-message` — generic error with a message
- `https://api.skribble.com/problem/entity-not-found` — requested resource does not exist
- `https://api.skribble.com/problem/feature-not-enabled` — a required feature is not enabled for the business
- `https://api.skribble.com/problem/constraint-violation` — request violates a domain constraint
- `https://api.skribble.com/problem/parameterized` — parameterized error with details
- `https://api.skribble.com/problem/limit-exceeded` — a usage limit was exceeded'
example: https://api.skribble.com/problem/problem-with-message
method:
type: string
description: HTTP method of the failing request.
example: POST
path:
type: string
description: Request URI of the failing request.
example: /v2/signature-requests
status:
type: integer
description: HTTP status code, mirroring the response status line.
example: 400
key:
type: string
description: 'Optional machine-readable error key. Present for a subset of errors that carry
a stable code. Prefer matching on this field over parsing `message`, which is
not part of the stable contract.
Known keys, grouped by category:
Authentication (`403`):
- `error.auth.token_expired`: the access token has expired
- `error.auth.token_invalid`: the access token is malformed or otherwise invalid
- `error.auth.credentials_invalid`: the supplied credentials were rejected
Rate limiting (`429`):
- `error.rate_limit.exceeded`: a generic rate limit was exceeded
- `error.rate_limit.reminder`: the per-signature-request reminder limit was exceeded
File upload / attachment (`400`):
- `file.attachment.unsupported`: the uploaded attachment type is not supported
- `file.malware.detected`: malware was detected in the uploaded file
PDF processing (`400`):
- `file.pdf.general_error`: the PDF could not be loaded (corrupt or unreadable)
- `file.pdf.encryption.unknown_password`: the PDF is encrypted with an unknown password
- `file.pdf.encryption.no_changes_allowed`: the PDF''s signature permissions (DocMDP) do not allow the required changes
- `file.pdf.encryption.unknown_permissions`: the PDF is encrypted with an unknown permissions type
- `file.pdf.signature_verification.failed`: verification of an existing PDF signature failed
Signature request (`400`):
- `error.sr.last_document_cannot_be_removed`: the request would remove the only remaining document from the signature request; an SR must keep at least one document'
example: file.attachment.unsupported
message:
type: string
description: Human-readable error message.
example: Validation failed for JSON object
SystemHealthResponse:
title: System Health Response
type: object
description: System Health.
properties:
status:
type: string
example: UP
groups:
type: array
items:
type: string
example:
- liveness readyness
responses:
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemResponse'
example:
type: https://api.skribble.com/problem/problem-with-message
method: GET
path: /v2/signature-requests
status: 401
message: Unauthorized
TooManyRequests:
description: Too many requests
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemResponse'
example:
type: https://api.skribble.com/problem/problem-with-message
method: POST
path: /v2/signature-requests
status: 429
message: Too many requests
ServerError:
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemResponse'
example:
type: https://api.skribble.com/problem/problem-with-message
method: POST
path: /v2/signature-requests
status: 500
message: Internal server error
ServiceUnavailable:
description: Service unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemResponse'
example:
type: https://api.skribble.com/problem/problem-with-message
method: POST
path: /v2/signature-requests
status: 503
message: Service unavailable
BadRequest:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemResponse'
example:
type: https://api.skribble.com/problem/problem-with-message
method: POST
path: /v2/signature-requests
status: 400
message: Validation failed for JSON object
NotFound:
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemResponse'
example:
type: https://api.skribble.com/problem/entity-not-found
method: GET
path: /v2/signature-requests/00000000-0000-0000-0000-000000000000
status: 404
message: SignatureRequest not found
securitySchemes:
bearer:
type: http
scheme: bearer
bearerFormat: JWT
x-refined-from:
- skribble-sign-v3-openapi.yml
- skribble-sign-v2-openapi.yml
- skribble-sign-v3-openapi.yml