llms.txt
Compare with other sites' llms.txt files →# SolidPing
> SolidPing is an open-source uptime monitoring and alerting platform: 44 check types (HTTP, TCP, DNS, SSL, databases, message queues, gRPC, Kubernetes and more), distributed workers, status pages, on-call and 16 notification channels. Free to self-host (AGPL-3.0), or hosted at solidping.io.
This file contains links to documentation sections following the llmstxt.org standard.
## Table of Contents
- [Accept an invitation](https://docs.solidping.io/docs/api/accept-invite.md): Optionally authenticated. An invitation for an email that has no
- [Acknowledge an incident](https://docs.solidping.io/docs/api/acknowledge-incident.md): Acknowledge an incident
- [Bind a single channel to a check](https://docs.solidping.io/docs/api/add-check-channel.md): Bind a single channel to a check
- [Add a comment to an incident](https://docs.solidping.io/docs/api/add-incident-comment.md): Appends a free-text comment to the incident's timeline as an append-only `incident.comment` event authored by the calling user (`source: 'web'`). C...
- [Pre-provision an unverified paging contact for a member](https://docs.solidping.io/docs/api/add-member-contact.md): Lets an admin add a phone or WhatsApp contact for another member, in UNVERIFIED state. The contact becomes pageable only after its owner completes ...
- [Add member to organization](https://docs.solidping.io/docs/api/add-member.md): Add member to organization
- [Add a notification contact (and its route) for the caller](https://docs.solidping.io/docs/api/add-my-notification-contact.md): Add a notification contact (and its route) for the caller
- [Turn a prompt into a contract for an AI-authored js check](https://docs.solidping.io/docs/api/ai-check-contract.md): First step of the 'Describe it' flow (spec 2026-10-03-07): the LLM turns the user's description into an ordered list of human-readable assertions, ...
- [Write and test a js check script from a confirmed contract](https://docs.solidping.io/docs/api/ai-check-generate.md): Runs SolidPing's agent loop: the LLM explores the target (fetch_page, browser_snapshot) and tests its script (run_script) until a run returns up or...
- [Approve a proposed version](https://docs.solidping.io/docs/api/approve-check-version.md): Applies a proposed version. The proposal becomes the applied version and the caller is recorded as the decider. 409 when the version is not a pendi...
- [Approve a membership request](https://docs.solidping.io/docs/api/approve-membership-request.md): Approve a membership request
- [Authentication](https://docs.solidping.io/docs/api/authentication.md): Authentication
- [Badges](https://docs.solidping.io/docs/api/badges.md): Badges
- [Start registering a passkey](https://docs.solidping.io/docs/api/begin-passkey-registration.md): Returns the WebAuthn creation options and a sealed `session` to send back to `/api/v1/auth/passkeys/register/finish`. Adding a sign-in factor needs...
- [Update several checks at once](https://docs.solidping.io/docs/api/bulk-update-checks.md): Applies one set of `changes`, shaped like a single-check PATCH body, to every check of `checkUids`, with exactly the semantics of that PATCH (spec ...
- [Cancel the run in progress of a multi-step check](https://docs.solidping.io/docs/api/cancel-check-run.md): Drops the run in progress: its saved progress is deleted and the check is scheduled for its next regular run. No result is written for the canceled...
- [Cancel a discovery scan](https://docs.solidping.io/docs/api/cancel-discovery-scan.md): Admin only. Cancels the scan and drops every pending fan-out child chunk. Children already running finish naturally.
- [Cancel a pending job](https://docs.solidping.io/docs/api/cancel-job.md): Cancel a pending job
- [Cancel one of the caller's membership requests](https://docs.solidping.io/docs/api/cancel-membership-request.md): Cancel one of the caller's membership requests
- [Capture a screenshot now](https://docs.solidping.io/docs/api/capture-check-screenshot.md): 'Capture now': runs a browser or js check once, on demand, with the screenshot forced whatever the verdict (and whether or not the check's own `scr...
- [Change (or set) the authenticated user's password](https://docs.solidping.io/docs/api/change-password.md): Rotates the caller's password without an emailed reset token. `currentPassword` is required when the account already has a password; for an SSO-onl...
- [Channels](https://docs.solidping.io/docs/api/channels.md): Channels
- [Check Groups](https://docs.solidping.io/docs/api/check-groups.md): Check Groups
- [Check Types](https://docs.solidping.io/docs/api/check-types.md): Check Types
- [Checks](https://docs.solidping.io/docs/api/checks.md): Checks
- [Clone an existing check](https://docs.solidping.io/docs/api/clone-check.md): Creates a near-identical copy of an existing check. Runtime state (status, results, incidents, scheduler row) is not copied; labels and channel bin...
- [Confirm and enable TOTP two-factor authentication](https://docs.solidping.io/docs/api/confirm-2-fa.md): Checks a code from the authenticator against the pending secret and enables two-factor authentication. Returns the recovery codes, once. `setupToke...
- [Confirm a phone contact with its verification code](https://docs.solidping.io/docs/api/confirm-my-notification-contact.md): Constant-time compares the submitted code; after 5 failed attempts the code is invalidated and a new one must be requested. Success stamps the cont...
- [Confirm a pending registration with an emailed token](https://docs.solidping.io/docs/api/confirm-registration.md): Confirm a pending registration with an emailed token
- [Create a notification channel](https://docs.solidping.io/docs/api/create-channel.md): Create a notification channel
- [Add a dependency edge to a check](https://docs.solidping.io/docs/api/create-check-dependency.md): Add a dependency edge to a check
- [Create a check group](https://docs.solidping.io/docs/api/create-check-group.md): Create a check group
- [Create monitoring check](https://docs.solidping.io/docs/api/create-check.md): Create monitoring check
- [Create an escalation policy](https://docs.solidping.io/docs/api/create-escalation-policy.md): Create an escalation policy
- [Create an invitation](https://docs.solidping.io/docs/api/create-invitation.md): Create an invitation
- [Create a job (org admin, allowlisted types only)](https://docs.solidping.io/docs/api/create-job.md): Enqueues a background job. **Requires org admin** — a member with the
- [Create a maintenance window](https://docs.solidping.io/docs/api/create-maintenance-window.md): Create a maintenance window
- [Request to join an organization](https://docs.solidping.io/docs/api/create-membership-request.md): Request to join an organization
- [Start linking a Discord account to the caller](https://docs.solidping.io/docs/api/create-my-discord-link.md): Mints a single-use link token (TTL 15 minutes) and returns the Discord
- [Mint a single-use Telegram connect link for the caller](https://docs.solidping.io/docs/api/create-my-telegram-link.md): Returns a `https://t.me/<botUsername>?start=<token>` deep link carrying
- [Create an override on an on-call schedule](https://docs.solidping.io/docs/api/create-oncall-override.md): Create an override on an on-call schedule
- [Create an on-call schedule](https://docs.solidping.io/docs/api/create-oncall-schedule.md): Create an on-call schedule
- [Create a new organization](https://docs.solidping.io/docs/api/create-org.md): Creates a new organization, makes the caller its OWNER, and returns a session scoped to the new org. Any authenticated user may create an organizat...
- [Create a scheduled uptime report](https://docs.solidping.io/docs/api/create-report-schedule.md): Create a scheduled uptime report
- [Create a severity](https://docs.solidping.io/docs/api/create-severity.md): Create a severity
- [Create a service-level objective](https://docs.solidping.io/docs/api/create-slo.md): Create a service-level objective
- [Register a webhook or Slack delivery for a status page](https://docs.solidping.io/docs/api/create-status-page-endpoint-subscriber.md): AUTHENTICATED, operator-side. Creates a subscription that delivers to a URL rather than a mailbox, already confirmed — the operator registering the...
- [Append a narrative update to a published incident](https://docs.solidping.io/docs/api/create-status-page-incident-update.md): Append a narrative update to a published incident
- [Publish a hand-written incident on a status page](https://docs.solidping.io/docs/api/create-status-page-incident.md): Publish a hand-written incident on a status page
- [Add a check as a resource to a section](https://docs.solidping.io/docs/api/create-status-page-resource.md): Add a check as a resource to a section
- [Create a section](https://docs.solidping.io/docs/api/create-status-page-section.md): Create a section
- [Create a status page](https://docs.solidping.io/docs/api/create-status-page.md): Create a status page
- [Create a status update](https://docs.solidping.io/docs/api/create-status-update.md): Create a status update
- [Reply to a support thread](https://docs.solidping.io/docs/api/create-support-message.md): Sends the reply through the channel the thread arrived on AND records it. Returns 409 when the reply cannot be sent right now — a lapsed WhatsApp 2...
- [Create Personal Access Token for organization](https://docs.solidping.io/docs/api/create-token.md): Create Personal Access Token for organization
- [Edge-TLS custom-domain check (public)](https://docs.solidping.io/docs/api/custom-domain-allowed.md): Returns 204 when the queried domain currently resolves to a verified, enabled, public status page, and 404 otherwise. No body. This is the contract...
- [Delete a notification channel](https://docs.solidping.io/docs/api/delete-channel.md): Delete a notification channel
- [Remove a dependency edge](https://docs.solidping.io/docs/api/delete-check-dependency.md): Remove a dependency edge
- [Delete a check group](https://docs.solidping.io/docs/api/delete-check-group.md): Delete a check group
- [Soft delete check](https://docs.solidping.io/docs/api/delete-check.md): Soft delete check
- [Remove an email suppression (re-subscribe)](https://docs.solidping.io/docs/api/delete-email-suppression.md): Remove an email suppression (re-subscribe)
- [Delete an escalation policy](https://docs.solidping.io/docs/api/delete-escalation-policy.md): Delete an escalation policy
- [Delete a file](https://docs.solidping.io/docs/api/delete-file.md): Delete a file
- [Clear a member's identity on an integration](https://docs.solidping.io/docs/api/delete-integration-identity.md): Clear a member's identity on an integration
- [Revoke a pending invitation](https://docs.solidping.io/docs/api/delete-invitation.md): Revoke a pending invitation
- [Delete a maintenance window](https://docs.solidping.io/docs/api/delete-maintenance-window.md): Delete a maintenance window
- [Delete an override](https://docs.solidping.io/docs/api/delete-oncall-override.md): Delete an override
- [Delete an on-call schedule](https://docs.solidping.io/docs/api/delete-oncall-schedule.md): Delete an on-call schedule
- [Clear the organization logo](https://docs.solidping.io/docs/api/delete-org-logo.md): Removes the organization's logo. **Owner only.** An uploaded image is retired at the same time, so its public URL stops resolving.
- [Delete an organization parameter](https://docs.solidping.io/docs/api/delete-org-parameter.md): Removes the parameter. Every check whose config references it will fail with `unresolved secret reference` at its next execution, so a missing key ...
- [Delete an organization](https://docs.solidping.io/docs/api/delete-org.md): Permanently deletes the organization. **Owner only** — an admin is refused with 403 FORBIDDEN. The request body must repeat the organization slug a...
- [Delete a scheduled uptime report](https://docs.solidping.io/docs/api/delete-report-schedule.md): Delete a scheduled uptime report
- [Delete a severity](https://docs.solidping.io/docs/api/delete-severity.md): Delete a severity
- [Delete a service-level objective](https://docs.solidping.io/docs/api/delete-slo.md): Delete a service-level objective
- [Remove a resource from a section](https://docs.solidping.io/docs/api/delete-status-page-resource.md): Remove a resource from a section
- [Delete a section](https://docs.solidping.io/docs/api/delete-status-page-section.md): Delete a section
- [Delete a status page](https://docs.solidping.io/docs/api/delete-status-page.md): Delete a status page
- [Delete a status update](https://docs.solidping.io/docs/api/delete-status-update.md): Delete a status update
- [Delete a system parameter](https://docs.solidping.io/docs/api/delete-system-parameter.md): Soft-deletes a system parameter.
- [Diff a version against another one](https://docs.solidping.io/docs/api/diff-check-version.md): The fields that differ between this version and `against` (default: the applied version before it). Config and labels diff per key (`config.url`, `...
- [Disable the iCal feed for an on-call schedule](https://docs.solidping.io/docs/api/disable-oncall-ical-feed.md): Disable the iCal feed for an on-call schedule
- [Discovery](https://docs.solidping.io/docs/api/discovery.md): Discovery
- [Dismiss a single discovered check](https://docs.solidping.io/docs/api/dismiss-discovered-check.md): Dismiss a single discovered check
- [Dismiss a whole group of discovered checks](https://docs.solidping.io/docs/api/dismiss-discovered-group.md): Admin only. Soft-deletes every check in the given group (optionally scoped to one scan).
- [Download file content](https://docs.solidping.io/docs/api/download-file.md): Download file content
- [Email Suppressions](https://docs.solidping.io/docs/api/email-suppressions.md): Email Suppressions
- [Enable the iCal feed for an on-call schedule](https://docs.solidping.io/docs/api/enable-oncall-ical-feed.md): Enable the iCal feed for an on-call schedule
- [Entitlements](https://docs.solidping.io/docs/api/entitlements.md): Entitlements
- [Escalation Policies](https://docs.solidping.io/docs/api/escalation-policies.md): Escalation Policies
- [Events](https://docs.solidping.io/docs/api/events.md): Events
- [Redeem a federated-login handoff code](https://docs.solidping.io/docs/api/exchange-handoff-code.md): A federated login (Google, GitHub, GitLab, Microsoft, Discord, Slack,
- [Files](https://docs.solidping.io/docs/api/files.md): Files
- [Mint or regenerate a status page's kiosk (TV mode) token](https://docs.solidping.io/docs/api/generate-status-page-kiosk-token.md): Mints the page's single kiosk token — a long-lived, revocable, per-page secret a wallboard presents as a `kiosk` query parameter so an office TV ca...
- [Organization activation funnel](https://docs.solidping.io/docs/api/get-activation-funnel.md): Returns one row per organization with the timestamps for each activation milestone (signup, first check, first result, first notification, first in...
- [Get one organization's entitlements and audit trail (super admin)](https://docs.solidping.io/docs/api/get-admin-entitlements.md): Get one organization's entitlements and audit trail (super admin)
- [Get a job's retry chain (admin)](https://docs.solidping.io/docs/api/get-admin-job-chain.md): Ordered chain of jobs linked via previousJobUid, earliest ancestor to latest descendant.
- [Get a background job (admin)](https://docs.solidping.io/docs/api/get-admin-job.md): Get a background job (admin)
- [Get one user of the global directory (super admin)](https://docs.solidping.io/docs/api/get-admin-user.md): Get one user of the global directory (super admin)
- [Get status badge for a check](https://docs.solidping.io/docs/api/get-badge.md): Returns an SVG badge showing the check's current status. No authentication required.
- [Get a notification channel](https://docs.solidping.io/docs/api/get-channel.md): Get a notification channel
- [Bucketed availability over an arbitrary window for a single check](https://docs.solidping.io/docs/api/get-check-availability-buckets.md): Cuts [from, to) into uniform, hour-aligned availability cells — the data behind the check-detail chart's availability strip. Deliberately a separat...
- [Per-period availability statistics for a single check](https://docs.solidping.io/docs/api/get-check-availability.md): Returns real, server-measured availability for each requested period (replacing the old client-side estimate). availabilityPct and downtimeSeconds ...
- [Get a check type's config JSON Schema](https://docs.solidping.io/docs/api/get-check-config-schema.md): The generated JSON Schema (draft 2020-12) of one check type's `config`
- [Get a check group](https://docs.solidping.io/docs/api/get-check-group.md): Get a check group
- [Get a check-schedule job (admin)](https://docs.solidping.io/docs/api/get-check-job.md): Get a check-schedule job (admin)
- [Get the run in progress of a multi-step check](https://docs.solidping.io/docs/api/get-check-run.md): A multi-step check (the website crawl) runs as a series of short slices, each saving its progress. This returns the run in progress: its uid, start...
- [Aggregate check counters for an organization](https://docs.solidping.io/docs/api/get-check-stats.md): Org-wide check counters computed server-side with a single SQL aggregation, so they are unaffected by the list endpoint's 100-row page clamp. Scope...
- [Get one version of a check](https://docs.solidping.io/docs/api/get-check-version.md): One version with its snapshot. The snapshot is redacted like an export: secret and export-redacted config keys are never present.
- [Get check details](https://docs.solidping.io/docs/api/get-check.md): Get check details
- [Scheduler cost/delay distribution](https://docs.solidping.io/docs/api/get-cost-distribution.md): Returns an aggregate, low-cardinality distribution of the scheduler's per-job cost_ewma_ms and delay_ewma_ms across all check_jobs, plus fast/slow ...
- [Get current user info](https://docs.solidping.io/docs/api/get-current-user.md): Get current user info
- [Look up a pending device authorization request by user code](https://docs.solidping.io/docs/api/get-device-consent.md): Look up a pending device authorization request by user code
- [Discord application setup values](https://docs.solidping.io/docs/api/get-discord-setup.md): Returns the redirect URIs and Interactions Endpoint URL to register in the Discord developer portal, derived from the server base URL. Super-admin ...
- [Get a discovery scan with progress](https://docs.solidping.io/docs/api/get-discovery-scan.md): Returns the scan job plus a uniform progress block for every scan type (chunked scans roll up their children; non-chunked scans report totalChunks=1).
- [Get the email-inbox (JMAP) configuration](https://docs.solidping.io/docs/api/get-email-inbox-config.md): Returns the saved JMAP inbox configuration with the password elided. Super-admin only.
- [Get the email-inbox connection status](https://docs.solidping.io/docs/api/get-email-inbox-status.md): Reports whether the email inbox is enabled and connected, the mode, the last sync time, the last error and the address domain. Super-admin only.
- [Embeddable live status widget script](https://docs.solidping.io/docs/api/get-embed-widget-v-1.md): Self-contained JavaScript (IIFE) that renders a live status pill on a third-party site. It is loaded by an async script tag carrying data-page='org...
- [Get resolved entitlements for an organization](https://docs.solidping.io/docs/api/get-entitlements.md): Get resolved entitlements for an organization
- [Get an escalation policy](https://docs.solidping.io/docs/api/get-escalation-policy.md): Get an escalation policy
- [Get file metadata](https://docs.solidping.io/docs/api/get-file.md): Get file metadata
- [System health check](https://docs.solidping.io/docs/api/get-health.md): System health check
- [Get an incident notification delivery by UID](https://docs.s