> ## Documentation Index > Fetch the complete documentation index at: https://docs.parmanasystems.com/llms.txt > Use this file to discover all available pages before exploring further. # Propose registering or revoking an external connector > Proposes connecting your own system to Parmana with no Parmana code change: `register` names a capability, the HTTPS endpoint to release it to, the policy that governs it, the parameters to forward and optionally a timeout; `revoke` ends... ## OpenAPI ````yaml openapi.bundled.yaml POST /external-connectors/changes openapi: 3.1.0 info: title: Parmana API version: 1.0.0 description: > Parmana sits between an AI agent and the systems it acts on. An agent sends a Business Transaction: who authorized it, what action it wants, and the facts that justify it. Parmana evaluates the policy bound to the action, checks any signed human approval the policy requires, releases the action to the connector only if the policy approves, and returns a signed Execution Trust Record anyone can verify. **Authentication.** Send `Authorization: Bearer ` on every request. The only routes that need no key are the probes, the documents and the independent verification routes: `GET /health`, `GET /ready`, `GET /openapi.yaml`, `GET /openapi.json`, `GET /api-manifest.json`, `GET /documentation`, `GET /reference`, `GET /parmana-handbook.pdf`, `GET /handbook/download-leads`, `POST /handbook/download-leads`, `POST /refusal/verify`, `POST /execution-intents/verify`, `POST /audit/verify`, `GET /keys/{keyId}` and `GET /.well-known/jwks.json`. A missing or unknown key returns `401` before anything else runs. The server holds only a hash of each key. See [Authentication](/api-reference/authentication). **Two kinds of key.** An agent or service key may invoke only the capabilities listed on it. A human key (`credentialHolderType: USER`) is required for governance: proposing and approving policies, approvers and external connectors, and repairing Execution Intents. Approving or rejecting a change also needs a step up authorization signed with the checker's own step up key, and the checker must not be the person who proposed it. **Ownership.** Every lookup by `businessTransactionId` is scoped to the key that submitted the transaction. A transaction submitted by another key returns the same `404` as one that does not exist. **Try it live.** The first server below is the public sandbox, `https://parmana-sandbox.vercel.app`: the same code as production with its own database, keys and demo approver, whose one action, `sandbox:receipt`, acts on nothing. Every "Try it" panel calls it with the published demo key prefilled. The demo key may invoke only `sandbox:receipt`, so other capabilities return `403` and governance routes return `403 NON_HUMAN_CALLER_DENIED`. Everything sent to the sandbox is visible to every visitor. See [Playground](/playground). Production needs a key issued by its operator. **Start here:** the [Playground](/playground) (no install), the [Quickstart](/quickstart), then [Integrate Parmana](/agents/integrate) for agents and [Connect any external system](/guides/connect-any-external-system) for your own endpoint. contact: name: Parmana Systems email: founder@parmanasystems.com license: name: Proprietary, source-available for evaluation only, see LICENSE url: https://github.com/pavancharak/parmana/blob/main/LICENSE servers: - url: https://parmana-sandbox.vercel.app description: >- Public sandbox (the docs playground). Same code as production, demo data only, acts on nothing. Demo key prefilled. - url: https://parmana-api-real.vercel.app description: Production. Needs a key issued by the operator. - url: http://localhost:3000 description: Local (packages/api, PORT env var, default 3000) security: - bearerAuth: [] tags: - name: Execution description: >- Executes a Business Transaction through the complete Execution Trust pipeline - name: Transactions description: Business Transaction creation and retrieval - name: Verification description: Deterministic verification of an Execution Trust Record - name: Receipts description: Cryptographically signed Execution Trust Receipts - name: Trust Records description: Execution Trust Record retrieval - name: Replay description: Deterministic replay of a recorded Execution Trust Record - name: Policies description: Policy existence/readability check - name: Policy Governance description: Maker-checker proposal, listing, approval, and rejection of policy changes - name: Approvers description: Maker-checker for the keys trusted to sign approvals, without a deploy - name: External Connectors description: >- Maker-checker for binding a capability to an operator's HTTPS endpoint and its policy, without a deploy (ADR-0013) - name: Business Signal Sources description: >- Maker-checker for the business systems Parmana asks for the facts a policy needs, without a deploy (RFC-0023) - name: Authority Grants description: >- Maker-checker for which agent may have which action decided, within which limits, until when (RFC-0023) - name: Sandbox description: >- Routes that exist only on the public sandbox (ADR-0014), for trying Parmana from a browser - name: Refusal Records description: >- Durable, signed evidence that a policy decision rejected a transaction (RFC-0021) - name: Execution Intents description: >- A signed statement, stored before an action is released, of exactly what is about to be released, plus the operator tools to find and repair a released action that has no signed Trust Record (ADR-0012) - name: Audit description: >- Signed caller-authentication audit events, independently third-party-verifiable - name: System description: Operational endpoints paths: /external-connectors/changes: post: tags: - External Connectors summary: Propose registering or revoking an external connector description: > Proposes connecting your own system to Parmana with no Parmana code change: `register` names a capability, the HTTPS endpoint to release it to, the policy that governs it, the parameters to forward and optionally a timeout; `revoke` ends the active registration for a capability. Nothing changes until a different person approves it. The endpoint must be `https`, name a domain (not an IP address or localhost), carry no user name, password or fragment, and resolve only to public addresses; the address is checked again on approval and at every release. Capabilities in a built in namespace (`paytm`, `hubspot`, `github`, `slack`, `test`) are refused. To move a capability, revoke it, then register the new endpoint. Needs a human key. operationId: proposeExternalConnectorChange requestBody: required: true content: application/json: schema: $ref: >- #/components/schemas/propose-external-connector-change-request.schema examples: register: summary: Real captured request value: action: register capability: erp:create-invoice endpointUrl: https://erp.example.com/parmana/release policy: erp-invoice allowedParameters: - amount - currency - customerId timeoutMs: 10000 reason: >- Finance creates invoices in the ERP through Parmana from October. revoke: summary: Real captured request value: action: revoke capability: erp:create-invoice reason: The ERP endpoint moves to a new host. responses: '201': description: Proposed and waiting for a checker. Keep the `changeId`. content: application/json: schema: $ref: '#/components/schemas/external-connector-change-response.schema' examples: register: summary: Real captured response value: changeId: 1aa68ad8-ab5c-4beb-9ff3-7a6b1fc1ff37 action: register capability: erp:create-invoice endpointUrl: https://erp.example.com/parmana/release policy: erp-invoice allowedParameters: - amount - currency - customerId timeoutMs: 10000 reason: >- Finance creates invoices in the ERP through Parmana from October. proposedBy: human-maker proposedAt: '2026-09-30T17:25:46.316Z' status: PENDING_APPROVAL revoke: summary: Real captured response value: changeId: 5bdbfd6a-babf-4977-b090-d561ddcee0d7 action: revoke capability: erp:create-invoice reason: The ERP endpoint moves to a new host. proposedBy: human-maker proposedAt: '2026-09-30T17:25:46.418Z' status: PENDING_APPROVAL '400': description: >- `INVALID_EXTERNAL_CONNECTOR`: a field is missing or malformed, the namespace is built in, or a revoke carries registration fields. `EXTERNAL_ENDPOINT_ADDRESS_REFUSED`: the endpoint is not https, names an IP address or localhost, resolves to an address that is not public, or does not resolve. content: application/json: schema: $ref: '#/components/schemas/error.schema' examples: builtInNamespace: summary: Real captured response value: error: >- The namespace 'paytm' belongs to a built in connector. Use another namespace. code: INVALID_EXTERNAL_CONNECTOR privateAddress: summary: Real captured response value: error: >- The endpoint host 'erp-internal.example.com' resolves to an address that is not public (10.0.0.7). code: EXTERNAL_ENDPOINT_ADDRESS_REFUSED badCapability: summary: Real captured response value: error: >- capability must be namespace:verb, at most 128 characters, matching ^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*:[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$. code: INVALID_EXTERNAL_CONNECTOR badTimeout: summary: Real captured response value: error: >- timeoutMs must be an integer from 1000 to 30000; it defaults to 10000. code: INVALID_EXTERNAL_CONNECTOR duplicateParameter: summary: Real captured response value: error: >- allowedParameters must be an array of at most 64 distinct names, each matching ^[A-Za-z_][A-Za-z0-9_]{0,63}$. code: INVALID_EXTERNAL_CONNECTOR revokeWithRegistrationFields: summary: Real captured response value: error: A revoke takes only action, capability and reason. code: INVALID_EXTERNAL_CONNECTOR plainHttp: summary: Real captured response value: error: endpointUrl must use https. code: EXTERNAL_ENDPOINT_ADDRESS_REFUSED '401': $ref: '#/components/responses/Unauthorized' '403': description: '`NON_HUMAN_CALLER_DENIED`: this needs a human key.' content: application/json: schema: $ref: '#/components/schemas/error.schema' examples: service: summary: Real captured response, a service credential value: error: >- This action requires a caller credential provisioned as a verified human (credentialHolderType: USER). code: NON_HUMAN_CALLER_DENIED '409': description: >- `CONFLICT`: the capability already has an active registration (to register) or has none (to revoke), or another change for it is pending. content: application/json: schema: $ref: '#/components/schemas/error.schema' examples: pending: summary: Real captured response value: error: >- A change for capability 'erp:create-invoice' is already pending. It must be approved or rejected first. code: CONFLICT alreadyActive: summary: Real captured response value: error: >- Capability 'erp:create-invoice' already has an active external connector. Revoke it first. code: CONFLICT revokeUnregistered: summary: Real captured response value: error: >- Capability 'erp:create-invoice' has no active external connector. code: CONFLICT x-codeSamples: - lang: bash label: cURL source: >- curl -X POST https://parmana-api-real.vercel.app/external-connectors/changes \ -H "Authorization: Bearer $PARMANA_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "action": "register", "capability": "erp:create-invoice", "endpointUrl": "https://erp.example.com/parmana/release", "policy": "erp-invoice", "allowedParameters": [ "amount", "currency" ], "timeoutMs": 10000, "reason": "Finance creates invoices in the ERP through Parmana." }' - lang: typescript label: TypeScript source: |- import { ParmanaClient } from "@parmana/sdk"; const client = new ParmanaClient({ endpoint: "https://parmana-api-real.vercel.app", apiKey: process.env.PARMANA_API_KEY!, }); const change = await client.proposeExternalConnectorChange({ action: "register", capability: "erp:create-invoice", endpointUrl: "https://erp.example.com/parmana/release", policy: "erp-invoice", allowedParameters: ["amount", "currency"], timeoutMs: 10000, reason: "Finance creates invoices in the ERP through Parmana.", }); console.log(change.changeId); - lang: python label: Python source: |- import os from parmana import ParmanaClient client = ParmanaClient( endpoint="https://parmana-api-real.vercel.app", api_key=os.environ["PARMANA_API_KEY"], ) change = client.external_connectors.propose_register( capability="erp:create-invoice", endpoint_url="https://erp.example.com/parmana/release", policy="erp-invoice", allowed_parameters=["amount", "currency"], timeout_ms=10000, reason="Finance creates invoices in the ERP through Parmana.", ) print(change.change_id) components: schemas: propose-external-connector-change-request.schema: title: Propose External Connector Change Request description: >- Request body for POST /external-connectors/changes. A register carries endpointUrl, policy, allowedParameters and optionally timeoutMs; a revoke carries none of them. type: object additionalProperties: true required: - action - capability - reason properties: action: type: string enum: - register - revoke capability: type: string pattern: ^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*:[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$ maxLength: 128 endpointUrl: type: string maxLength: 2048 description: Required for register. https only, a public host name. policy: type: string pattern: ^[a-z0-9][a-z0-9-]{0,127}$ description: Required for register. allowedParameters: type: array maxItems: 64 uniqueItems: true items: type: string pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$ description: Required for register. May be empty. timeoutMs: type: integer minimum: 1000 maximum: 30000 default: 10000 reason: type: string minLength: 1 maxLength: 2000 examples: - action: register capability: erp:create-invoice endpointUrl: https://erp.example.com/parmana/release policy: erp-invoice allowedParameters: - amount - currency - customerId timeoutMs: 10000 reason: Finance creates invoices in the ERP through Parmana from October. - action: revoke capability: erp:create-invoice reason: The ERP endpoint moves to a new host. external-connector-change-response.schema: $ref: '#/components/schemas/external-connector-change.schema' title: External Connector Change Response description: >- Response of POST /external-connectors/changes (201) and of approve and reject (200). A bare External Connector Change, no wrapper. error.schema: title: Error Response description: >- Shared error envelope produced by packages/api/src/middleware/error-handler.ts and by every route's inline validation checks. error is always a plain human-readable string (never a nested object). code is present only when the failure was a RuntimeError subclass reaching the centralized error handler (VerificationFailedError, ReceiptGenerationError, or an uncategorized RuntimeError); it is absent from every inline route-level check (businessTransactionId format/required checks) and from BusinessTransactionValidationError, PolicyValidationError, SignalValidationError, PolicyNotFoundError, DuplicateBusinessTransactionError, and the generic 500 fallback. POST /policies/validate does NOT use this envelope at all. See its own response schema. For the triggering condition and recommended caller action behind any specific error/code/status combination, see the Error catalog at /api-reference/error-catalog. type: object additionalProperties: false required: - error properties: error: type: string description: Human-readable error message. code: type: string description: >- Stable machine-readable error code. Only present for errors that reach the handler as a RuntimeError. examples: - RUNTIME_ERROR - VERIFICATION_FAILED - RECEIPT_GENERATION_FAILED - POLICY_DENIED - CAPABILITY_NOT_ALLOWED - RATE_LIMITED - AUDIT_UNAVAILABLE - SIGNING_UNAVAILABLE - CONNECTOR_NOT_REGISTERED - EXECUTION_RECORD_INCOMPLETE - EXECUTION_INTENT_UNAVAILABLE - EXECUTION_INTENT_RESULT_NOT_RECORDED - EXECUTION_INTENT_NOT_FOUND - EXECUTION_INTENTS_NOT_ENABLED - EXECUTION_INTENT_NOT_RESOLVABLE - EXECUTION_INTENT_RESOLUTION_INVALID - NON_HUMAN_CALLER_DENIED - EXECUTION_OUTCOME_UNKNOWN - AUTHORIZATION_NO_LONGER_VALID executionStatus: type: string enum: - EXECUTION_UNKNOWN - NOT_EXECUTED description: >- RFC-0023 phase 4. EXECUTION_UNKNOWN with EXECUTION_OUTCOME_UNKNOWN: the action was released and the call failed, so whether it ran is unknown; never reported as failed, and the Execution Intent stays ERRORED until a person resolves it. NOT_EXECUTED with AUTHORIZATION_NO_LONGER_VALID: the release was refused because a business condition or the authority grant it rested on no longer held, and nothing was sent. examples: - error: businessTransactionId must be a valid UUID. - error: >- Business Transaction 'eed2a972-1bf5-4166-8472-761f76fbf1b2' already exists. - error: >- Execution rejected: Vendor payment rejected because the assessed payment risk exceeds the maximum permitted threshold. code: RUNTIME_ERROR external-connector-change.schema: title: External Connector Change description: >- A proposal to register an external connector, or to revoke the active one for a capability, and its resolution (ADR-0013). One person proposes it; a different person approves or rejects it with a step up authorization. Only an approved change affects which external connectors are registered. type: object additionalProperties: false required: - changeId - action - capability - reason - proposedBy - proposedAt - status properties: changeId: type: string description: >- Unique id of the change, a UUID. The step up authorization for approve or reject names it in payload.pendingPolicyChangeId. An approved register change's id is also the registrationId. action: type: string enum: - register - revoke description: >- register binds the capability to the endpoint; revoke ends the active registration for the capability. capability: type: string pattern: ^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*:[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$ maxLength: 128 description: >- namespace:verb. Never in a built in connector's namespace (paytm, hubspot, github, slack, test). endpointUrl: type: string description: >- register only. The endpoint as the server stored it, normalized by URL parsing: https, a host name with a domain, no IP literal, no localhost, no user name, password or fragment, resolving only to public addresses. It is the audience of every release to this endpoint. policy: type: string pattern: ^[a-z0-9][a-z0-9-]{0,127}$ description: >- register only. The name of the policy that governs the capability. The version in effect is decided by policy governance. allowedParameters: type: array maxItems: 64 uniqueItems: true items: type: string pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$ description: >- register only. The only parameter names Parmana will forward to the endpoint. timeoutMs: type: integer minimum: 1000 maximum: 30000 description: >- register only. How long Parmana waits for the endpoint's answer. Defaults to 10000. reason: type: string maxLength: 2000 description: Why, from the proposer. proposedBy: type: string description: The proposer's caller id. Always a human credential. proposedAt: type: string format: date-time status: type: string enum: - PENDING_APPROVAL - APPROVED - REJECTED description: >- PENDING_APPROVAL until a second person approves or rejects it; then APPROVED or REJECTED, once. resolvedBy: type: string description: Who approved or rejected it. Never the proposer. resolvedAt: type: string format: date-time rejectionReason: type: string description: Present when REJECTED. examples: - changeId: 1aa68ad8-ab5c-4beb-9ff3-7a6b1fc1ff37 action: register capability: erp:create-invoice endpointUrl: https://erp.example.com/parmana/release policy: erp-invoice allowedParameters: - amount - currency - customerId timeoutMs: 10000 reason: Finance creates invoices in the ERP through Parmana from October. proposedBy: human-maker proposedAt: '2026-09-30T17:25:46.316Z' status: APPROVED resolvedBy: human-checker resolvedAt: '2026-09-30T17:25:46.385Z' responses: Unauthorized: description: >- The `Authorization` header is missing, is not a bearer key, or names a key the server does not know. Nothing ran. Send a valid key. content: application/json: schema: $ref: '#/components/schemas/error.schema' examples: authRequired: summary: Real captured response, missing or invalid Authorization header value: error: authentication required securitySchemes: bearerAuth: type: http scheme: bearer x-default: 2VfYWCzt_cBAPK-8uufX6ordfY2JuQhFPsohuEumKME description: > Caller API key issued by scripts/generate-api-key.ts. Sent as Authorization: Bearer . Verified against a stored SHA-256 hash in constant time by packages/api/src/auth/StaticKeyAuthenticator.ts. Required on every route not listed as exempt in this document's top-level description. See /api-reference/authentication. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.