Documentation sections

For developers

Read-only HTTP tools

Declarative server-side methods for fresh diagnostics without changing customer data.

Updated: August 10, 2026

01

Configuration

jsonKanyman docs
{
  "name": "project.get_diagnostics",
  "capability_version": "1.0.0",
  "description": "Retrieve safe project diagnostics",
  "method": "POST",
  "url": "https://api.example.com/kanyman/project-diagnostics",
  "input_schema": {
    "type": "object",
    "additionalProperties": false,
    "properties": {}
  },
  "output_schema": {
    "type": "object",
    "additionalProperties": false,
    "properties": {}
  },
  "side_effect": "none",
  "confirmation_policy": "none",
  "idempotency_policy": "none",
  "auth_type": "hmac",
  "auth_version": "v2",
  "hmac_key_id": "connector-current"
}

The tool is created as a draft. An admin runs a safe probe with subject=kanyman_configuration_test, a new request_id, and empty entities. A successful response matching the output schema, or a signed 404 OBJECT_NOT_FOUND with the same request_id, activates the transport without accessing a real object.

02

Request to your endpoint

jsonKanyman docs
{
  "request_id": "ktc_...",
  "integration_id": "ext_...",
  "subject": "opaque-user-reference",
  "entities": [{ "type": "project", "ref": "prj_..." }],
  "input": { "request_id": "req_..." }
}

The model controls only the input object. Kanyman extracts integration_id, subject, and entities from validated context and adds them on the server.

03

Authorization and HMAC

For HMAC v2, sign METHOD\nPATH\nTIMESTAMP\nNONCE\nBODY_SHA256 and validate X-Kanyman-Key-Id, X-Kanyman-Timestamp, X-Kanyman-Nonce, X-Kanyman-Body-SHA256, and X-Kanyman-Signature: <hex>. The body is limited to 32 KiB, each nonce is single-use, and query strings are forbidden. HMAC v1 remains only for compatibility with existing integrations.

04

Network restrictions

  • Only a public HTTPS endpoint using POST is allowed.
  • Private, loopback, link-local, and reserved addresses are forbidden.
  • DNS is checked before the outbound call and redirects are disabled.
  • A timeout, response-size limit, and rate limit are applied.
  • Input and output must pass closed JSON Schemas.
  • Credentials, input, and output are encrypted at rest; audit records do not expose secrets.
  • HMAC rotation atomically changes the current/previous key and requires another probe before activation.

Continue reading

Read-only HTTP tools — Kanyman Docs