CrawlCheck Changes API

openapi: 3.2.0
info:
  title: Crawlcheck Io Changes 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 Changes 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: Changes
paths:
  /api/v1/changes/subscribe:
    get:
      operationId: changeSubscription
      summary: Read your change-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:
                  value:
                    ok: true
                    id: cwh_9a2b4c6d8e0f1a2b
                    webhook_host: hooks.example.com
                    domains:
                    - example.com
                    sections: all
                    delivered: 3
                    consecutive_failures: 0
                    last_delivery:
                      at: '2026-10-29T18:10:00.000Z'
                      status: 200
                      ok: true
                    state: 'on'
              schema:
                type:
                - object
                - 'null'
                properties:
                  ok:
                    type:
                    - boolean
                    - 'null'
                  id:
                    type:
                    - string
                    - 'null'
                  webhook_host:
                    type:
                    - string
                    - 'null'
                  domains:
                    type:
                    - array
                    - 'null'
                    items:
                      type:
                      - string
                      - 'null'
                  sections:
                    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'
                    additionalProperties: true
                  state:
                    type:
                    - string
                    - 'null'
                additionalProperties: true
                x-schema-source: worked-example
      x-codeSamples:
      - lang: Shell
        label: curl
        source: 'curl -s ''https://crawlcheck.io/api/v1/changes/subscribe?id=cwh_9a2b4c6d8e0f1a2b'' -H ''x-subscription-token: 3f1c…'''
      security: []
      x-auth: public; no credential read
      tags:
      - Changes
    post:
      operationId: changeSubscribe
      summary: 'Change webhook: POST {webhook, domains, sections?} (https, public host; 1-100…'
      responses:
        '201':
          description: subscription id + token (shown once)
          content:
            application/json:
              examples:
                worked:
                  summary: The token is shown once.
                  value:
                    ok: true
                    token: 3f1c…
                    events:
                    - change.recorded
                    - change.test
                    id: cwh_9a2b4c6d8e0f1a2b
                    webhook_host: hooks.example.com
                    domains:
                    - example.com
                    sections:
                    - crawl_policy
                    - delivery
                    delivered: 0
                    consecutive_failures: 0
                    state: 'on'
              schema:
                type:
                - object
                - 'null'
                properties:
                  ok:
                    type:
                    - boolean
                    - 'null'
                  token: {}
                  events:
                    type:
                    - array
                    - 'null'
                    items:
                      type:
                      - string
                      - 'null'
                  id:
                    type:
                    - string
                    - 'null'
                  webhook_host:
                    type:
                    - string
                    - 'null'
                  domains:
                    type:
                    - array
                    - 'null'
                    items:
                      type:
                      - string
                      - 'null'
                  sections:
                    type:
                    - array
                    - 'null'
                    items:
                      type:
                      - string
                      - 'null'
                  delivered:
                    type:
                    - number
                    - 'null'
                  consecutive_failures:
                    type:
                    - number
                    - 'null'
                  state:
                    type:
                    - string
                    - 'null'
                additionalProperties: true
                x-schema-source: worked-example
        '400':
          description: bad webhook, domains or sections
        '429':
          description: hourly limit
      x-codeSamples:
      - lang: Shell
        label: curl
        source: 'curl -s -X POST https://crawlcheck.io/api/v1/changes/subscribe -H ''content-type: application/json'' -d ''{"webhook":"https://hooks.example.com/crawlcheck","domains":["example.com"]}'''
      security: []
      x-auth: public; no credential read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type:
              - object
              - 'null'
              properties:
                webhook:
                  type:
                  - string
                  - 'null'
                domains:
                  type:
                  - array
                  - 'null'
                  items:
                    type:
                    - string
                    - 'null'
                sections:
                  type:
                  - array
                  - 'null'
                  items:
                    type:
                    - string
                    - 'null'
              additionalProperties: true
              x-schema-source: worked-example
            examples:
              worked:
                summary: The request behind the worked response
                value:
                  webhook: https://hooks.example.com/crawlcheck
                  domains:
                  - example.com
                  sections:
                  - crawl_policy
                  - delivery
      x-crawlcheck-budget:
        request_body_max: 1048576
      tags:
      - Changes
    servers:
    - url: https://crawlcheck.io
  /api/v1/changes/subscribe/test:
    post:
      operationId: changeSubscribeTest
      summary: Send a signed change.test event to your webhook now ({id} +…
      responses:
        '200':
          description: delivery result and the event
          content:
            application/json:
              examples:
                worked:
                  value:
                    ok: true
                    delivery:
                      ok: true
                      status: 200
                    event:
                      kind: crawlcheck-change-event
                      event: change.test
                      domain: example.com
                      changes: []
                      sha256: …
                      signature:
                        v: 1
                        alg: Ed25519
                        kid: …
                        sig: …
              schema:
                type:
                - object
                - 'null'
                properties:
                  ok:
                    type:
                    - boolean
                    - 'null'
                  delivery:
                    type:
                    - object
                    - 'null'
                    properties:
                      ok:
                        type:
                        - boolean
                        - 'null'
                      status:
                        type:
                        - number
                        - 'null'
                    additionalProperties: true
                  event:
                    type:
                    - object
                    - 'null'
                    properties:
                      kind:
                        type:
                        - string
                        - 'null'
                      event:
                        type:
                        - string
                        - 'null'
                      domain:
                        type:
                        - string
                        - 'null'
                      changes:
                        type:
                        - array
                        - 'null'
                        items: {}
                      sha256: {}
                      signature:
                        type:
                        - object
                        - 'null'
                        properties:
                          v:
                            type:
                            - number
                            - 'null'
                          alg:
                            type:
                            - string
                            - 'null'
                          kid: {}
                          sig: {}
                        additionalProperties: true
                    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/changes/subscribe/test -H ''x-subscription-token: 3f1c…'' -H ''content-type: application/json'' -d ''{"id":"cwh_9a2b4c6d8e0f1a2b"}'''
      security: []
      x-auth: public; no credential read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type:
              - object
              - 'null'
              properties:
                id:
                  type:
                  - string
                  - 'null'
              additionalProperties: true
              x-schema-source: worked-example
            examples:
              worked:
                summary: The request behind the worked response
                value:
                  id: cwh_9a2b4c6d8e0f1a2b
      x-crawlcheck-budget:
        request_body_max: 1048576
      tags:
      - Changes
    servers:
    - url: https://crawlcheck.io
  /api/v1/changes/unsubscribe:
    post:
      operationId: changeUnsubscribe
      summary: Remove a change-webhook subscription ({id} + x-subscription-token)
      responses:
        '200':
          description: removed
          content:
            application/json:
              examples:
                worked:
                  value:
                    ok: true
                    removed: cwh_9a2b4c6d8e0f1a2b
              schema:
                type:
                - object
                - 'null'
                properties:
                  ok:
                    type:
                    - boolean
                    - 'null'
                  removed:
                    type:
                    - string
                    - 'null'
                additionalProperties: true
                x-schema-source: worked-example
      x-codeSamples:
      - lang: Shell
        label: curl
        source: 'curl -s -X POST https://crawlcheck.io/api/v1/changes/unsubscribe -H ''x-subscription-token: 3f1c…'' -H ''content-type: application/json'' -d ''{"id":"cwh_9a2b4c6d8e0f1a2b"}'''
      security: []
      x-auth: public; no credential read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type:
              - object
              - 'null'
              properties:
                id:
                  type:
                  - string
                  - 'null'
              additionalProperties: true
              x-schema-source: worked-example
            examples:
              worked:
                summary: The request behind the worked response
                value:
                  id: cwh_9a2b4c6d8e0f1a2b
      x-crawlcheck-budget:
        request_body_max: 1048576
      tags:
      - Changes
    servers:
    - url: https://crawlcheck.io
  /api/v1/changes/stream:
    get:
      operationId: changesStream
      summary: 'The change feed as Server-Sent Events: one event: change per section of a…'
      parameters:
      - name: domain
        in: query
        required: false
        schema:
          type: string
      - name: section
        in: query
        required: false
        schema:
          type: string
      - name: since
        in: query
        required: false
        schema:
          type: string
      - name: Last-Event-ID
        in: header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: text/event-stream
          content:
            text/event-stream:
              examples:
                worked:
                  summary: 'Shape: the raw stream. In a browser or Node: new EventSource(url).addEventListener(''change'', e => JSON.parse(e.data)).'
                  value:
                    stream: 'retry: 3000


                      id: chg:ev:20261009043012:example.com#0

                      event: change

                      data: {"domain":"example.com","at":"2026-10-09T04:30:12.551Z","section":"crawl_policy","from_state":"observed","to_state":"observed","detail":"GPTBot: now disallowed"}


                      : 2026-10-09T04:30:27Z sent 1

                      '
              schema:
                type: string
                x-schema-source: worked-example
      x-codeSamples:
      - lang: Shell
        label: curl
        source: curl -N 'https://crawlcheck.io/api/v1/changes/stream?section=crawl_policy'
      security: []
      x-auth: public; no credential read
      tags:
      - Changes
    servers:
    - url: https://crawlcheck.io
  /api/v1/changes:
    get:
      operationId: resolveChangesV1
      summary: 'What moved: one event per resolve-answer section that changed when an answer…'
      parameters:
      - name: since
        in: query
        schema:
          type: string
      - name: domain
        in: query
        schema:
          type: string
      responses:
        '200':
          description: crawlcheck-changes
          content:
            application/json:
              examples:
                worked:
                  summary: Shape of the feed with one example event; not a measurement.
                  value:
                    kind: crawlcheck-changes
                    v: 1
                    since: '2026-10-01T00:00:00Z'
                    domain: null
                    generated_at: '2026-10-03T06:00:00.000Z'
                    count: 1
                    next_since: '2026-10-02T14:12:08.000Z'
                    reading: One event per section of a resolve answer that moved when the answer was rebuilt. Re-resolve the domains listed; everything else is as you last read it.
                    events:
                    - domain: example.com
                      at: '2026-10-02T14:12:08.000Z'
                      section: delivery
                      from_state: observed
                      to_state: observed
                      detail: 'GPTBot: 200 → 403'
              schema:
                type:
                - object
                - 'null'
                properties:
                  kind:
                    type:
                    - string
                    - 'null'
                  v:
                    type:
                    - number
                    - 'null'
                  since:
                    type:
                    - string
                    - 'null'
                  domain: {}
                  generated_at:
                    type:
                    - string
                    - 'null'
                  count:
                    type:
                    - number
                    - 'null'
                  next_since:
                    type:
                    - string
                    - 'null'
                  reading:
                    type:
                    - string
                    - 'null'
                  events:
                    type:
                    - array
                    - 'null'
                    items:
                      type:
                      - object
                      - 'null'
                      properties:
                        domain:
                          type:
                          - string
                          - 'null'
                        at:
                          type:
                          - string
                          - 'null'
                        section:
                          type:
                          - string
                          - 'null'
                        from_state:
                          type:
                          - string
                          - 'null'
                        to_state:
                          type:
                          - string
                          - 'null'
                        detail:
                          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/changes?since=2026-10-01T00:00:00Z'
      security: []
      x-auth: public; no credential read
      tags:
      - Changes
    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