CrawlCheck Policy API
The Policy API from CrawlCheck — 2 operation(s) for policy.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/crawlcheck-io:crawlcheck-io-policy-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Crawlcheck Io 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 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: Policy
paths:
/api/v1/policy:
get:
operationId: policyGet
summary: 'A stored policy by id: the exact normalised crawlcheck-policy document.'
parameters:
- name: id
in: query
required: true
schema:
type: string
responses:
'200':
description: policy
content:
application/json:
examples:
worked:
summary: 'Shape: the stored document.'
value:
ok: true
id: pol1:9f2c…
kind: crawlcheck-policy
v: 1
name: Shopping agent, production
actions: {}
tests: []
schema:
type:
- object
- 'null'
properties:
ok:
type:
- boolean
- 'null'
id: {}
kind:
type:
- string
- 'null'
v:
type:
- number
- 'null'
name:
type:
- string
- 'null'
actions:
type:
- object
- 'null'
properties: {}
additionalProperties: true
tests:
type:
- array
- 'null'
items: {}
additionalProperties: true
x-schema-source: worked-example
x-codeSamples:
- lang: Shell
label: curl
source: curl -s 'https://crawlcheck.io/api/v1/policy?id=pol1:9f2c…'
security: []
x-auth: public; no credential read
tags:
- Policy
post:
operationId: policyPublish
summary: 'Policy as code: POST a crawlcheck-policy document (defaults, per-action rules…'
requestBody:
required: true
content:
application/json:
schema:
$ref: https://crawlcheck.io/schemas/policy.json
responses:
'200':
description: id and normalised document
content:
application/json:
examples:
worked:
summary: Shape; abbreviated.
value:
ok: true
stored: true
policy:
id: pol1:9f2c…
document:
kind: crawlcheck-policy
v: 1
name: Shopping agent, production
actions:
read:
max_age_hours: 168
on_warn: warn
require_entity: false
human_approval: []
allow: []
deny: []
transact:
max_age_hours: 24
on_warn: block
require_entity: false
human_approval:
- transact
allow: []
deny: []
tests:
- domain: crawlcheck.io
action: read
expect:
- allow
- warn
url: https://crawlcheck.io/api/v1/policy?id=pol1:9f2c…
use:
preflight:
domain: example.com
action: read
policy_id: pol1:9f2c…
schema:
type:
- object
- 'null'
properties:
ok:
type:
- boolean
- 'null'
stored:
type:
- boolean
- 'null'
policy:
type:
- object
- 'null'
properties:
id: {}
document:
type:
- object
- 'null'
properties:
kind:
type:
- string
- 'null'
v:
type:
- number
- 'null'
name:
type:
- string
- 'null'
actions:
type:
- object
- 'null'
properties:
read:
type:
- object
- 'null'
properties:
max_age_hours:
type:
- number
- 'null'
on_warn:
type:
- string
- 'null'
require_entity:
type:
- boolean
- 'null'
human_approval:
type:
- array
- 'null'
items: {}
allow:
type:
- array
- 'null'
items: {}
deny:
type:
- array
- 'null'
items: {}
additionalProperties: true
transact:
type:
- object
- 'null'
properties:
max_age_hours:
type:
- number
- 'null'
on_warn:
type:
- string
- 'null'
require_entity:
type:
- boolean
- 'null'
human_approval:
type:
- array
- 'null'
items:
type:
- string
- 'null'
allow:
type:
- array
- 'null'
items: {}
deny:
type:
- array
- 'null'
items: {}
additionalProperties: true
additionalProperties: true
tests:
type:
- array
- 'null'
items:
type:
- object
- 'null'
properties:
domain:
type:
- string
- 'null'
action:
type:
- string
- 'null'
expect:
type:
- array
- 'null'
items:
type:
- string
- 'null'
additionalProperties: true
additionalProperties: true
url: {}
additionalProperties: true
use:
type:
- object
- 'null'
properties:
preflight:
type:
- object
- 'null'
properties:
domain:
type:
- string
- 'null'
action:
type:
- string
- 'null'
policy_id: {}
additionalProperties: true
additionalProperties: true
additionalProperties: true
x-schema-source: worked-example
'422':
description: lint errors
x-codeSamples:
- lang: Shell
label: curl
source: curl -s -X POST https://crawlcheck.io/api/v1/policy --data @crawlcheck-policy.json
security: []
x-auth: public; no credential read
x-crawlcheck-budget:
request_body_max: 16384
items: 'tests: up to 50 in the file (20 run on each put)'
rate_limit: 20 puts per address per hour
tags:
- Policy
servers:
- url: https://crawlcheck.io
/api/v1/policy/test:
post:
operationId: policyTest
summary: Run a policy's tests (or cases[]) through the preflight engine against today's…
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
policy:
type: object
policy_id:
type: string
cases:
type: array
responses:
'200':
description: results
content:
application/json:
examples:
worked:
summary: Shape.
value:
ok: true
kind: crawlcheck-policy-test
total: 2
passed: 2
skipped: 0
results:
- domain: crawlcheck.io
action: read
expect:
- allow
- warn
decision: allow
reason_codes:
- resolve.actions.read
status: measured
pass: true
- domain: crawlcheck.io
action: transact
expect:
- require_confirmation
- block
- unsupported
decision: require_confirmation
reason_codes:
- resolve.actions.transact
- policy.human_approval
status: measured
pass: true
schema:
type:
- object
- 'null'
properties:
ok:
type:
- boolean
- 'null'
kind:
type:
- string
- 'null'
total:
type:
- number
- 'null'
passed:
type:
- number
- 'null'
skipped:
type:
- number
- 'null'
results:
type:
- array
- 'null'
items:
type:
- object
- 'null'
properties:
domain:
type:
- string
- 'null'
action:
type:
- string
- 'null'
expect:
type:
- array
- 'null'
items:
type:
- string
- 'null'
decision:
type:
- string
- 'null'
reason_codes:
type:
- array
- 'null'
items:
type:
- string
- 'null'
status:
type:
- string
- 'null'
pass:
type:
- boolean
- 'null'
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/policy/test -d '{"policy_id":"pol1:9f2c…"}'
security: []
x-auth: public; no credential read
x-crawlcheck-budget:
request_body_max: 16384
items: 'tests: up to 50'
rate_limit: 30 test runs per address per hour
tags:
- 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