> ## 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. # Approve an external connector change > Approves an external connector change and applies it in one step: register makes the registration active, revoke ends it. ## OpenAPI ````yaml openapi.bundled.yaml POST /external-connectors/changes/{id}/approve openapi: 3.1.0 info: title: Parmana API version: 1.0.0 description: > Parmana is an Execution Trust Infrastructure that ensures there is no gap between what humans decide and what AI systems do. The API enables creation, execution, verification, replay, and auditing of Business Transactions through cryptographically verifiable Execution Trust Records. **Every route requires a caller bearer key**, except the liveness/readiness probes and documentation/verification routes that must be reachable with no credential: GET /health, GET /ready, GET /openapi.yaml, GET /documentation, GET /reference, POST /refusal/verify, POST /execution-intents/verify, POST /audit/verify, GET /keys/{keyId}, and GET /.well-known/jwks.json. Send `Authorization: Bearer ` on every other request. Keys are issued by `scripts/generate-api-key.ts` and configured server-side via `PARMANA_API_KEYS`; only a hash of each key is ever held by the server, verified in constant time. A missing or invalid credential returns 401 before a Business Transaction is even constructed, independent of Policy evaluation and gateway attestation, see `packages/api/src/middleware/caller-auth.ts` and [Authentication](/api-reference/authentication). Local development may set `PARMANA_AUTH_DISABLED=true` to skip this middleware entirely; that flag must never be set in a real deployment. contact: name: Parmana Systems email: founder@parmanasystems.com license: name: Proprietary, source-available for evaluation only, see LICENSE url: https://github.com/pavancharak/AgentLabsBuildathon/blob/main/LICENSE servers: - url: https://parmana-api-real.vercel.app description: >- Production (real, deployed instance -- the docs site playground uses this by default) - 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: 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/{id}/approve: post: tags: - External Connectors summary: Approve an external connector change description: > Approves an external connector change and applies it in one step: register makes the registration active, revoke ends it. For a register, the endpoint's address is checked again first, so a DNS change since the proposal cannot point it at a private address. Requires, in order: a human credential, not the proposer (403 SAME_ACTOR_CANNOT_APPROVE_OWN_CHANGE), and a step up authorization signed with the checker step up key for this change id and action approve, used once (403 STEP_UP_AUTHORIZATION_INVALID). It is the same step up authorization policy changes use, with the change id in payload.pendingPolicyChangeId. operationId: approveExternalConnectorChange parameters: - name: id in: path required: true description: The changeId. schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/approve-policy-change-request.schema' examples: stepUp: summary: Real captured request value: stepUpAuthorization: payload: version: 1 nonce: a11a41c1-651e-431e-82ef-5199791a6428 pendingPolicyChangeId: 1aa68ad8-ab5c-4beb-9ff3-7a6b1fc1ff37 action: approve authorizedAt: '2026-09-30T17:25:46.377Z' expiresAt: '2026-09-30T17:27:46.377Z' signature: >- f7L+V1mwISUMWPZ85KqGJ2s1TaPfBiPHhwfsWjwhu2/1cSCJjP06MvgJ6eM6F01uR1T6/qT2FcHPpD/ETa+bDA== keyId: human-checker-step-up-key algorithm: ed25519 responses: '200': description: Approved and applied. content: application/json: schema: $ref: '#/components/schemas/external-connector-change.schema' examples: approved: 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: APPROVED resolvedBy: human-checker resolvedAt: '2026-09-30T17:25:46.385Z' revokeApproved: summary: Real captured response, a revoke value: changeId: d1164799-36e9-4281-878a-93d666befd42 action: revoke capability: erp:create-invoice reason: The ERP endpoint moves to a new host. proposedBy: human-maker proposedAt: '2026-09-30T19:03:21.551Z' status: APPROVED resolvedBy: human-checker resolvedAt: '2026-09-30T19:03:21.554Z' '400': description: >- EXTERNAL_ENDPOINT_ADDRESS_REFUSED. The endpoint now resolves to an address that is not public, or does not resolve. The change stays pending; reject it or fix the DNS and approve again with a new step up authorization. content: application/json: schema: $ref: '#/components/schemas/error.schema' examples: addressChanged: summary: >- Real captured response, the host moved to a private address after the proposal value: error: >- The endpoint host 'crm.example.com' resolves to an address that is not public (10.0.0.7). code: EXTERNAL_ENDPOINT_ADDRESS_REFUSED '401': $ref: '#/components/responses/Unauthorized' '403': description: >- NON_HUMAN_CALLER_DENIED, SAME_ACTOR_CANNOT_APPROVE_OWN_CHANGE, or STEP_UP_AUTHORIZATION_INVALID. content: application/json: schema: $ref: '#/components/schemas/error.schema' examples: sameActor: summary: Real captured response value: error: >- External connector change '1aa68ad8-ab5c-4beb-9ff3-7a6b1fc1ff37' was proposed by this same caller — the proposer (maker) may not also approve or reject it (checker). code: SAME_ACTOR_CANNOT_APPROVE_OWN_CHANGE '404': description: >- No external connector change has this id (EXTERNAL_CONNECTOR_CHANGE_NOT_FOUND). content: application/json: schema: $ref: '#/components/schemas/error.schema' examples: notFound: summary: Real captured response value: error: >- External connector change '00000000-0000-0000-0000-000000000000' not found. code: EXTERNAL_CONNECTOR_CHANGE_NOT_FOUND '409': description: >- CONFLICT. The change is already resolved, the capability to register now has an active registration, or the capability to revoke no longer has one. Nothing was written. content: application/json: schema: $ref: '#/components/schemas/error.schema' examples: alreadyResolved: summary: Real captured response, the same change approved twice value: error: >- External connector change 'd1164799-36e9-4281-878a-93d666befd42' is already APPROVED. code: CONFLICT components: schemas: approve-policy-change-request.schema: title: Approve Policy Change Request description: Request body for POST /policies/pending-changes/{id}/approve. type: object additionalProperties: false required: - stepUpAuthorization properties: stepUpAuthorization: $ref: '#/components/schemas/policy-change-step-up-authorization.schema' examples: - stepUpAuthorization: payload: version: 1 nonce: 343ee454-92c6-4ef9-9cfe-e98329e51f53 pendingPolicyChangeId: 6f4e4020-adf5-4449-938d-27aab58f66b7 action: approve authorizedAt: '2026-09-15T03:47:51.939Z' expiresAt: '2026-09-15T03:49:51.939Z' signature: >- keOXnzUk8KcGrQTkpXC4Ki8ps3GTvMANwqq96b+toxba07gjkcmpyL/vaPZ7+pPZ1HAOJOOy3rj5XfhcwOTnAw== keyId: human-checker-step-up-key algorithm: ed25519 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' 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 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 policy-change-step-up-authorization.schema: title: Policy Change Step-Up Authorization description: >- Signed envelope proving a checker's explicit, fresh intent to approve or reject one specific Pending Policy Change (Policy Governance, Layer 4). Produced by PolicyChangeStepUpAuthorizationSigner (@parmana/crypto) using the checker's own step-up private key, never the bearer API key. Verified server-side against: the checker's registered stepUpPublicKey, payload.pendingPolicyChangeId matching the URL's {id}, payload.action matching the endpoint (approve vs reject), payload.expiresAt not yet passed, and payload.nonce not previously seen (single-use, replay-rejected on a second attempt with the same envelope). type: object additionalProperties: true required: - payload - signature - keyId - algorithm properties: payload: type: object additionalProperties: true required: - version - nonce - pendingPolicyChangeId - action - authorizedAt - expiresAt properties: version: type: integer nonce: type: string description: >- Single-use value; a second request replaying the same envelope is rejected. pendingPolicyChangeId: type: string action: type: string enum: - approve - reject authorizedAt: type: string format: date-time expiresAt: type: string format: date-time signature: type: string description: >- Base64-encoded signature over the canonical payload, signed with the checker's step-up private key. keyId: type: string algorithm: type: string examples: - ed25519 examples: - payload: version: 1 nonce: 343ee454-92c6-4ef9-9cfe-e98329e51f53 pendingPolicyChangeId: 6f4e4020-adf5-4449-938d-27aab58f66b7 action: approve authorizedAt: '2026-09-15T03:47:51.939Z' expiresAt: '2026-09-15T03:49:51.939Z' signature: >- keOXnzUk8KcGrQTkpXC4Ki8ps3GTvMANwqq96b+toxba07gjkcmpyL/vaPZ7+pPZ1HAOJOOy3rj5XfhcwOTnAw== keyId: human-checker-step-up-key algorithm: ed25519 responses: Unauthorized: description: >- Missing or invalid caller credential (StaticKeyAuthenticator returned no identity). Real captured response, packages/api/src/middleware/caller-auth.ts. 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 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. ````