CrawlCheck Share API
The Share API from CrawlCheck — 1 operation(s) for share.
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-share-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 Share 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 Share 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: Share
paths:
/api/share:
post:
operationId: createShareLink
summary: Create a scoped share link for one report (licence required; up to 90 days…
parameters:
- name: x-crawlcheck-key
in: header
required: true
schema:
type: string
pattern: ^cc_[0-9a-f]{32}$
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- rid
properties:
rid:
type: string
description: Report id, or a report URL
days:
type: integer
minimum: 1
maximum: 90
default: 30
examples:
worked:
summary: The request behind the worked response
value:
rid: qfk9rgfwyg
days: 7
responses:
'200':
description: url, rid, expires, revoke
content:
application/json:
examples:
worked:
summary: Produced by the production Worker code against a stored copy of a real record; ids, keys and tokens are placeholders.
value:
ok: true
url: https://crawlcheck.io/r/qfk9rgfwyg?s=0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f
rid: qfk9rgfwyg
expires: '2026-10-08T02:29:45.334Z'
revoke: DELETE /api/share?s=0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f
schema:
type:
- object
- 'null'
properties:
ok:
type:
- boolean
- 'null'
url:
type:
- string
- 'null'
rid:
type:
- string
- 'null'
expires:
type:
- string
- 'null'
revoke:
type:
- string
- 'null'
additionalProperties: true
x-schema-source: worked-example
'400':
description: No usable report id
'401':
description: No valid licence key
'403':
description: Report domain is not on this licence
'404':
description: No such report
x-codeSamples:
- lang: Shell
label: curl
source: "curl -s -X POST \\\n -H \"x-crawlcheck-key: $CRAWLCHECK_KEY\" \\\n -H \"content-type: application/json\" \\\n -d '{\"rid\":\"qfk9rgfwyg\",\"days\":7}' \\\n 'https://crawlcheck.io/api/share'"
security:
- licenceKey: []
- bearer: []
x-auth: 'a licence key (x-crawlcheck-key or Authorization: Bearer) or the signed-in /manage session; 401 or 403 otherwise'
x-crawlcheck-budget:
request_body_max: 1048576
tags:
- Share
delete:
operationId: revokeShareLink
summary: Revoke a share link created with the same licence
parameters:
- name: x-crawlcheck-key
in: header
required: true
schema:
type: string
pattern: ^cc_[0-9a-f]{32}$
- name: s
in: query
required: true
schema:
type: string
pattern: ^[0-9a-f]{32}$
responses:
'200':
description: Revoked
content:
application/json:
examples:
worked:
summary: Produced by the production Worker code against a stored copy of a real record; ids, keys and tokens are placeholders.
value:
ok: true
revoked: 0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f
schema:
type:
- object
- 'null'
properties:
ok:
type:
- boolean
- 'null'
revoked:
type:
- string
- 'null'
additionalProperties: true
x-schema-source: worked-example
'400':
description: No usable token
'401':
description: No valid licence key
'404':
description: No such token on this licence
x-codeSamples:
- lang: Shell
label: curl
source: "curl -s -X DELETE \\\n -H \"x-crawlcheck-key: $CRAWLCHECK_KEY\" \\\n 'https://crawlcheck.io/api/share?s=0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f'"
security: []
x-auth: public; no credential read
x-crawlcheck-budget:
request_body_max: 1048576
tags:
- Share
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