CrawlCheck Staple API

openapi: 3.2.0
info:
  title: Crawlcheck Io Staple 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 Staple 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: Staple
paths:
  /api/v1/staple:
    get:
      operationId: staple
      summary: 'A site’s staple: the signed ccr1 record to send in the CrawlCheck-Staple header…'
      parameters:
      - name: domain
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: crawlcheck-staple
          content:
            application/json:
              examples:
                worked:
                  summary: Shape; not a measurement.
                  value:
                    kind: crawlcheck-staple
                    v: 1
                    domain: example.com
                    record: v=ccr1;d=example.com;st=measured;read=allow;…;s=…
                    fresh_until: …
                    refresh_after: …
                    header: 'CrawlCheck-Staple: v=ccr1;…'
                    answer:
                      kind: crawlcheck-resolve
              schema:
                type:
                - object
                - 'null'
                properties:
                  kind:
                    type:
                    - string
                    - 'null'
                  v:
                    type:
                    - number
                    - 'null'
                  domain:
                    type:
                    - string
                    - 'null'
                  record: {}
                  fresh_until: {}
                  refresh_after: {}
                  header: {}
                  answer:
                    type:
                    - object
                    - 'null'
                    properties:
                      kind:
                        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/staple?domain=example.com'
      security: []
      x-auth: public; no credential read
      tags:
      - Staple
    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