CrawlCheck

CrawlCheck Incident API

The Incident API from CrawlCheck — 5 operation(s) for incident.

GitHub OpenAPI

Operations 7

GET /api/v1/incident Is an owner-declared incident active on this domain? #
POST /api/v1/incident The domain claim holder declares or clears an incident ({domain, state: on|off… #
GET /api/v1/incident/subscribe Read your incident-webhook subscription (id + header x-subscription-token)… #
POST /api/v1/incident/subscribe Incident webhook: POST {webhook, domains?} (https, public host; leave domains… #
POST /api/v1/incident/subscribe/test Send a signed incident.test event to your webhook now ({id} +… #
POST /api/v1/incident/unsubscribe Remove an incident-webhook subscription ({id} + x-subscription-token) #
GET /api/v1/incident/selftest The daily self-test of the incident switch on selftest.crawlcheck.io: flip… #

Documentation

📖
Documentation
https://crawlcheck.io/docs/api

Specifications

⚙
OpenAPI
https://artifacts.apis.io/crawlcheck-io/openapi/crawlcheck-io-incident-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/crawlcheck-io/json-schema/crawlcheck-io-resolve-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/crawlcheck-io:crawlcheck-io-incident-api"
All apis 
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.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

crawlcheck-io-incident-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Crawlcheck Io Incident API
  version: '1'
  contact:
    name: CrawlCheck
    url: https://crawlcheck.io/policy
    email: hello@crawlcheck.io
  license:
    name: Terms
    url: https://crawlcheck.io/policy
  x-core-contract:
    promise: 'These operations are the core contract. They stay at /api/v1 and keep answering for at least 180 days after any /api/v2 is announced; their stable fields change only in a new major version, and their provisional fields only after 30 days'' notice, per /docs/api/compatibility. Verifying what they return needs none of these calls: crawlcheck-verify.mjs checks a document on your machine against the published keys (/.well-known/http-message-signatures-directory) and the rotation record, read once with --online or saved for --keys. Everything else documented here is useful but secondary, and may change with the notice its fields'' tags promise.'
    operations:
    - method: GET
      path: /api/v1/resolve
      operationId: resolveDomainV1
    - method: POST
      path: /api/v1/resolve
      operationId: resolveBatchV1
    - method: POST
      path: /api/v1/preflight
      operationId: preflightV1
    - method: GET
      path: /api/v1/decisions/{sha256}
      operationId: decisionCheckV1
    - method: GET
      path: /api/v1/revocations
      operationId: revocations
    - method: GET
      path: /api/v1/visitor
      operationId: visitorResolveV1
    - method: POST
      path: /api/v1/visitor
      operationId: visitorResolveBatchV1
    - method: GET
      path: /api/v1/mcp/scan
      operationId: mcpScanUrl
    - method: POST
      path: /api/v1/mcp/lock/check
      operationId: mcpLockCheck
    list: https://crawlcheck.io/api/v1/core
  description: 'Operations tagged Incident across 2 of this provider''s published API definitions: crawlcheck-io-openapi.json, crawlcheck-io-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://crawlcheck.io
tags:
- name: Incident
paths:
  /api/v1/incident:
    get:
      operationId: incidentState
      summary: Is an owner-declared incident active on this domain?
      parameters:
      - name: domain
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: state
          content:
            application/json:
              examples:
                worked:
                  value:
                    domain: shop.example.com
                    state: incident
                    incident:
                      state: incident
                      since: '2026-10-07T11:58:12.000Z'
                      blocks:
                      - connect
                      - transact
              schema:
                type:
                - object
                - 'null'
                properties:
                  domain:
                    type:
                    - string
                    - 'null'
                  state:
                    type:
                    - string
                    - 'null'
                  incident:
                    type:
                    - object
                    - 'null'
                    properties:
                      state:
                        type:
                        - string
                        - 'null'
                      since:
                        type:
                        - string
                        - 'null'
                      blocks:
                        type:
                        - array
                        - 'null'
                        items:
                          type:
                          - string
                          - 'null'
                    additionalProperties: true
                additionalProperties: true
                x-schema-source: worked-example
      x-codeSamples:
      - lang: Shell
        label: curl
        source: curl -s 'https://crawlcheck.io/api/v1/incident?domain=shop.example.com'
      security: []
      x-auth: public; no credential read
      tags:
      - Incident
    post:
      operationId: incidentSwitch
      summary: 'The domain claim holder declares or clears an incident ({domain, state: on|off…'
      parameters:
      - name: x-crawlcheck-key
        in: header
        required: false
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            examples:
              worked:
                summary: The request behind the worked response
                value:
                  domain: shop.example.com
                  state: 'on'
                  reason: payment page tampered
      responses:
        '200':
          description: crawlcheck-incident
          content:
            application/json:
              examples:
                worked:
                  value:
                    kind: crawlcheck-incident
                    v: 1
                    domain: shop.example.com
                    state: incident
                    at: '2026-10-07T11:58:12.000Z'
                    seq: 4
                    blocks:
                    - connect
                    - transact
                    method: key
                    reading: …
                    revocations: https://crawlcheck.io/api/v1/revocations
                    sha256: …
                    signature: …
              schema:
                type:
                - object
                - 'null'
                properties:
                  kind:
                    type:
                    - string
                    - 'null'
                  v:
                    type:
                    - number
                    - 'null'
                  domain:
                    type:
                    - string
                    - 'null'
                  state:
                    type:
                    - string
                    - 'null'
                  at:
                    type:
                    - string
                    - 'null'
                  seq:
                    type:
                    - number
                    - 'null'
                  blocks:
                    type:
                    - array
                    - 'null'
                    items:
                      type:
                      - string
                      - 'null'
                  method:
                    type:
                    - string
                    - 'null'
                  reading: {}
                  revocations:
                    type:
                    - string
                    - 'null'
                  sha256: {}
                  signature: {}
                additionalProperties: true
                x-schema-source: worked-example
        '403':
          description: not the claim holder
      x-codeSamples:
      - lang: Shell
        label: curl
        source: 'curl -s -X POST ''https://crawlcheck.io/api/v1/incident'' -H ''x-crawlcheck-key: cc_…'' -H ''content-type: application/json'' -d ''{"domain":"shop.example.com","state":"on"}'''
      security: []
      x-auth: public; no credential read
      x-crawlcheck-budget:
        request_body_max: 1048576
        rate_limit: 'shared: 30 calls per address per UTC hour across the MCP checks, anchors, origin, incidents and high-risk confirm (429)'
      tags:
      - Incident
    servers:
    - url: https://crawlcheck.io
  /api/v1/incident/subscribe:
    get:
      operationId: incidentSubscription
      summary: Read your incident-webhook subscription (id + header x-subscription-token)…
      parameters:
      - name: id
        in: query
        required: true
        schema:
          type: string
      - name: x-subscription-token
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: subscription
          content:
            application/json:
              examples:
                worked:
                  summary: Shape.
                  value:
                    ok: true
                    id: iwh_3f9a…
                    webhook_host: hooks.example.com
                    domains:
                    - example-shop.com
                    delivered: 3
                    consecutive_failures: 0
                    last_delivery:
                      at: '2026-10-09T04:40:01Z'
                      status: 200
                      ok: true
                      event: incident.declared
              schema:
                type:
                - object
                - 'null'
                properties:
                  ok:
                    type:
                    - boolean
                    - 'null'
                  id: {}
                  webhook_host:
                    type:
                    - string
                    - 'null'
                  domains:
                    type:
                    - array
                    - 'null'
                    items:
                      type:
                      - string
                      - 'null'
                  delivered:
                    type:
                    - number
                    - 'null'
                  consecutive_failures:
                    type:
                    - number
                    - 'null'
                  last_delivery:
                    type:
                    - object
                    - 'null'
                    properties:
                      at:
                        type:
                        - string
                        - 'null'
                      status:
                        type:
                        - number
                        - 'null'
                      ok:
                        type:
                        - boolean
                        - 'null'
                      event:
                        type:
                        - string
                        - 'null'
                    additionalProperties: true
                additionalProperties: true
                x-schema-source: worked-example
      x-codeSamples:
      - lang: Shell
        label: curl
        source: 'curl -s ''https://crawlcheck.io/api/v1/incident/subscribe?id=iwh_3f9a…'' -H ''x-subscription-token: …'''
      security: []
      x-auth: public; no credential read
      tags:
      - Incident
    post:
      operationId: incidentSubscribe
      summary: 'Incident webhook: POST {webhook, domains?} (https, public host; leave domains…'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - webhook
              properties:
                webhook:
                  type: string
                domains:
                  type: array
                  items:
                    type: string
      responses:
        '201':
          description: subscribed
          content:
            application/json:
              examples:
                worked:
                  summary: Shape. The event your webhook then receives looks like the value of the test call.
                  value:
                    ok: true
                    id: iwh_3f9a…
                    token: …shown once…
                    webhook_host: hooks.example.com
                    domains:
                    - example-shop.com
                    events:
                    - incident.declared
                    - incident.cleared
                    - incident.test
                    delivered: 0
                    consecutive_failures: 0
              schema:
                type:
                - object
                - 'null'
                properties:
                  ok:
                    type:
                    - boolean
                    - 'null'
                  id: {}
                  token: {}
                  webhook_host:
                    type:
                    - string
                    - 'null'
                  domains:
                    type:
                    - array
                    - 'null'
                    items:
                      type:
                      - string
                      - 'null'
                  events:
                    type:
                    - array
                    - 'null'
                    items:
                      type:
                      - string
                      - 'null'
                  delivered:
                    type:
                    - number
                    - 'null'
                  consecutive_failures:
                    type:
                    - number
                    - 'null'
                additionalProperties: true
                x-schema-source: worked-example
      x-codeSamples:
      - lang: Shell
        label: curl
        source: 'curl -s -X POST https://crawlcheck.io/api/v1/incident/subscribe -H ''content-type: application/json'' -d ''{"webhook":"https://hooks.example.com/cc","domains":["example-shop.com"]}'''
      security: []
      x-auth: public; no credential read
      x-crawlcheck-budget:
        request_body_max: 1048576
        items: 'domains: up to 100 per subscription (400 over)'
        rate_limit: 'shared: 30 calls per address per UTC hour across the MCP checks, anchors, origin, incidents and high-risk confirm (429)'
      tags:
      - Incident
    servers:
    - url: https://crawlcheck.io
  /api/v1/incident/subscribe/test:
    post:
      operationId: incidentSubscribeTest
      summary: Send a signed incident.test event to your webhook now ({id} +…
      responses:
        '200':
          description: delivery result and the event
          content:
            application/json:
              examples:
                worked:
                  summary: Shape; event is what a real declaration delivers, with event incident.declared.
                  value:
                    ok: true
                    delivered: true
                    status: 200
                    event:
                      kind: crawlcheck-incident-event
                      event: incident.declared
                      domain: example-shop.com
                      state: incident
                      at: '2026-10-09T04:40:00Z'
                      seq: 12
                      blocks:
                      - connect
                      - transact
                      reason: payment page compromised
                      revocations: https://crawlcheck.io/api/v1/revocations
                      resolve: https://crawlcheck.io/api/v1/resolve?domain=example-shop.com
                      signature: …
              schema:
                type:
                - object
                - 'null'
                properties:
                  ok:
                    type:
                    - boolean
                    - 'null'
                  delivered:
                    type:
                    - boolean
                    - 'null'
                  status:
                    type:
                    - number
                    - 'null'
                  event:
                    type:
                    - object
                    - 'null'
                    properties:
                      kind:
                        type:
                        - string
                        - 'null'
                      event:
                        type:
                        - string
                        - 'null'
                      domain:
                        type:
                        - string
                        - 'null'
                      state:
                        type:
                        - string
                        - 'null'
                      at:
                        type:
                        - string
                        - 'null'
                      seq:
                        type:
                        - number
                        - 'null'
                      blocks:
                        type:
                        - array
                        - 'null'
                        items:
                          type:
                          - string
                          - 'null'
                      reason:
                        type:
                        - string
                        - 'null'
                      revocations:
                        type:
                        - string
                        - 'null'
                      resolve:
                        type:
                        - string
                        - 'null'
                      signature: {}
                    additionalProperties: true
                additionalProperties: true
                x-schema-source: worked-example
      x-codeSamples:
      - lang: Shell
        label: curl
        source: 'curl -s -X POST https://crawlcheck.io/api/v1/incident/subscribe/test -H ''x-subscription-token: …'' -d ''{"id":"iwh_3f9a…"}'''
      security: []
      x-auth: public; no credential read
      x-crawlcheck-budget:
        request_body_max: 1048576
      tags:
      - Incident
    servers:
    - url: https://crawlcheck.io
  /api/v1/incident/unsubscribe:
    post:
      operationId: incidentUnsubscribe
      summary: Remove an incident-webhook subscription ({id} + x-subscription-token)
      responses:
        '200':
          description: removed
          content:
            application/json:
              examples:
                worked:
                  summary: Shape.
                  value:
                    ok: true
                    removed: iwh_3f9a…
              schema:
                type:
                - object
                - 'null'
                properties:
                  ok:
                    type:
                    - boolean
                    - 'null'
                  removed: {}
                additionalProperties: true
                x-schema-source: worked-example
      x-codeSamples:
      - lang: Shell
        label: curl
        source: 'curl -s -X POST https://crawlcheck.io/api/v1/incident/unsubscribe -H ''x-subscription-token: …'' -d ''{"id":"iwh_3f9a…"}'''
      security: []
      x-auth: public; no credential read
      x-crawlcheck-budget:
        request_body_max: 1048576
      tags:
      - Incident
    servers:
    - url: https://crawlcheck.io
  /api/v1/incident/selftest:
    get:
      operationId: incidentSelftest
      summary: 'The daily self-test of the incident switch on selftest.crawlcheck.io: flip…'
      responses:
        '200':
          description: runs
          content:
            application/json:
              examples:
                worked:
                  value:
                    kind: crawlcheck-incident-selftest
                    domain: selftest.crawlcheck.io
                    runs:
                    - at: '2026-10-07T11:47:00.000Z'
                      switch_status: 200
                      resolve_incident: true
                      receipt_decision: block
                      revocations_listed: true
                      ok: true
                      ms: 640
              schema:
                type:
                - object
                - 'null'
                properties:
                  kind:
                    type:
                    - string
                    - 'null'
                  domain:
                    type:
                    - string
                    - 'null'
                  runs:
                    type:
                    - array
                    - 'null'
                    items:
                      type:
                      - object
                      - 'null'
                      properties:
                        at:
                          type:
                          - string
                          - 'null'
                        switch_status:
                          type:
                          - number
                          - 'null'
                        resolve_incident:
                          type:
                          - boolean
                          - 'null'
                        receipt_decision:
                          type:
                          - string
                          - 'null'
                        revocations_listed:
                          type:
                          - boolean
                          - 'null'
                        ok:
                          type:
                          - boolean
                          - 'null'
                        ms:
                          type:
                          - number
                          - 'null'
                      additionalProperties: true
                additionalProperties: true
                x-schema-source: worked-example
      x-codeSamples:
      - lang: Shell
        label: curl
        source: curl -s 'https://crawlcheck.io/api/v1/incident/selftest'
      security: []
      x-auth: public; no credential read
      tags:
      - Incident
    servers:
    - url: https://crawlcheck.io
components:
  securitySchemes:
    licenceKey:
      type: apiKey
      in: header
      name: x-crawlcheck-key
      description: 'Your licence key: cc_ followed by 32 hex characters. Sent on every keyed call.'
    bearer:
      type: http
      scheme: bearer
      description: The same licence key as a Bearer token. Accepted on /api/v1/* and /api/usage.
externalDocs:
  url: https://crawlcheck.io/docs/api
  description: Human-readable reference
x-refined-from:
- crawlcheck-io-openapi.json
- crawlcheck-io-openapi.yml