CrawlCheck Failure Policy API

openapi: 3.2.0
info:
  title: Crawlcheck Io Failure Policy 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 Failure Policy 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: Failure Policy
paths:
  /api/v1/failure-policy:
    get:
      operationId: failurePolicy
      summary: 'The Resolve failure policy: one row per state an answer can be in when…'
      responses:
        '200':
          description: crawlcheck-failure-policy
          content:
            application/json:
              examples:
                worked:
                  summary: Shape; one row shown, signature shortened.
                  value:
                    kind: crawlcheck-failure-policy
                    v: 1
                    decisions: allow | warn | require_confirmation | block; unchanged = the answer's own decision stands
                    rows:
                    - state: incident_list_unreadable
                      detected_when: the owner-incident list could not be read
                      answer: incident.state unread; doubt incident_list_unread
                      read: unchanged
                      cite: unchanged
                      connect: require_confirmation
                      transact: block
                      administer: block
                      test: an incident read that throws blocks transact and lowers connect to require_confirmation
                    spec: https://crawlcheck.io/spec/failure-policy
                    sha256: …
                    signature:
                      v: 1
                      alg: Ed25519
                      kid: …
                      sig: …
              schema:
                type:
                - object
                - 'null'
                properties:
                  kind:
                    type:
                    - string
                    - 'null'
                  v:
                    type:
                    - number
                    - 'null'
                  decisions:
                    type:
                    - string
                    - 'null'
                  rows:
                    type:
                    - array
                    - 'null'
                    items:
                      type:
                      - object
                      - 'null'
                      properties:
                        state:
                          type:
                          - string
                          - 'null'
                        detected_when:
                          type:
                          - string
                          - 'null'
                        answer:
                          type:
                          - string
                          - 'null'
                        read:
                          type:
                          - string
                          - 'null'
                        cite:
                          type:
                          - string
                          - 'null'
                        connect:
                          type:
                          - string
                          - 'null'
                        transact:
                          type:
                          - string
                          - 'null'
                        administer:
                          type:
                          - string
                          - 'null'
                        test:
                          type:
                          - string
                          - 'null'
                      additionalProperties: true
                  spec:
                    type:
                    - string
                    - 'null'
                  sha256: {}
                  signature:
                    type:
                    - object
                    - 'null'
                    properties:
                      v:
                        type:
                        - number
                        - 'null'
                      alg:
                        type:
                        - string
                        - 'null'
                      kid: {}
                      sig: {}
                    additionalProperties: true
                additionalProperties: true
                x-schema-source: worked-example
      x-codeSamples:
      - lang: Shell
        label: curl
        source: curl -s https://crawlcheck.io/api/v1/failure-policy
      security: []
      x-auth: public; no credential read
      tags:
      - Failure Policy
    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