# v1 · Proof, vaults, receipts and passports

Paths on this page are relative to <code>/api/liquidity-studio/v1</code>. Authentication and required headers vary by operation.

[API reference overview](/api-reference/v1/overview/) · [OpenAPI download](/openapi/liquidity-studio.openapi.json)

## Operations on this page

| Method | Path | Operation |
| --- | --- | --- |
| <code>GET</code> | <code>/vaults</code> | [getVaults](#getVaults) |
| <code>POST</code> | <code>/vaults</code> | [postVaults](#postVaults) |
| <code>POST</code> | <code>/vaults/preview-deployment</code> | [postVaultsPreviewDeployment](#postVaultsPreviewDeployment) |
| <code>GET</code> | <code>/vaults/{vaultId}</code> | [getVaultsByVaultId](#getVaultsByVaultId) |
| <code>GET</code> | <code>/vaults/{vaultId}/issuer-exit-kit</code> | [getVaultsByVaultIdIssuerExitKit](#getVaultsByVaultIdIssuerExitKit) |
| <code>GET</code> | <code>/vaults/{vaultId}/positions</code> | [getVaultsByVaultIdPositions](#getVaultsByVaultIdPositions) |
| <code>GET</code> | <code>/vaults/{vaultId}/inventory</code> | [getVaultsByVaultIdInventory](#getVaultsByVaultIdInventory) |
| <code>GET</code> | <code>/vaults/{vaultId}/depth</code> | [getVaultsByVaultIdDepth](#getVaultsByVaultIdDepth) |
| <code>GET</code> | <code>/vaults/{vaultId}/depth-history</code> | [getVaultsByVaultIdDepthHistory](#getVaultsByVaultIdDepthHistory) |
| <code>GET</code> | <code>/vaults/{vaultId}/policy</code> | [getVaultsByVaultIdPolicy](#getVaultsByVaultIdPolicy) |
| <code>POST</code> | <code>/vaults/{vaultId}/deployment-preview</code> | [postVaultsByVaultIdDeploymentPreview](#postVaultsByVaultIdDeploymentPreview) |
| <code>POST</code> | <code>/vaults/{vaultId}/deployment-handoff</code> | [postVaultsByVaultIdDeploymentHandoff](#postVaultsByVaultIdDeploymentHandoff) |
| <code>POST</code> | <code>/vaults/{vaultId}/runtime-deployment-handoff</code> | [postVaultsByVaultIdRuntimeDeploymentHandoff](#postVaultsByVaultIdRuntimeDeploymentHandoff) |
| <code>POST</code> | <code>/vaults/{vaultId}/deployment-finalization</code> | [postVaultsByVaultIdDeploymentFinalization](#postVaultsByVaultIdDeploymentFinalization) |
| <code>POST</code> | <code>/vaults/{vaultId}/deployment-handoff/cancel-expired</code> | [postVaultsByVaultIdDeploymentHandoffCancelExpired](#postVaultsByVaultIdDeploymentHandoffCancelExpired) |
| <code>POST</code> | <code>/vaults/{vaultId}/deployment-risk/reassess</code> | [postVaultsByVaultIdDeploymentRiskReassess](#postVaultsByVaultIdDeploymentRiskReassess) |
| <code>POST</code> | <code>/vaults/{vaultId}/lifecycle-transitions</code> | [postVaultsByVaultIdLifecycleTransitions](#postVaultsByVaultIdLifecycleTransitions) |
| <code>POST</code> | <code>/vaults/{vaultId}/testnet-mechanics-gates</code> | [postVaultsByVaultIdTestnetMechanicsGates](#postVaultsByVaultIdTestnetMechanicsGates) |
| <code>POST</code> | <code>/vaults/{vaultId}/testnet-mechanics-gates/{artifactId}/approval</code> | [postVaultsByVaultIdTestnetMechanicsGatesByArtifactIdApproval](#postVaultsByVaultIdTestnetMechanicsGatesByArtifactIdApproval) |
| <code>POST</code> | <code>/vaults/{vaultId}/live-expansion-gates</code> | [postVaultsByVaultIdLiveExpansionGates](#postVaultsByVaultIdLiveExpansionGates) |
| <code>POST</code> | <code>/vaults/{vaultId}/live-expansion-gates/{artifactId}/approval</code> | [postVaultsByVaultIdLiveExpansionGatesByArtifactIdApproval](#postVaultsByVaultIdLiveExpansionGatesByArtifactIdApproval) |
| <code>POST</code> | <code>/vaults/{vaultId}/capital-top-up-handoffs</code> | [postVaultsByVaultIdCapitalTopUpHandoffs](#postVaultsByVaultIdCapitalTopUpHandoffs) |
| <code>POST</code> | <code>/vaults/{vaultId}/capital-top-up-handoffs/{handoffId}/finalization</code> | [postVaultsByVaultIdCapitalTopUpHandoffsByHandoffIdFinalization](#postVaultsByVaultIdCapitalTopUpHandoffsByHandoffIdFinalization) |
| <code>POST</code> | <code>/vaults/{vaultId}/capital-top-up-finalizations/{finalizationId}/reassessment</code> | [postVaultsByVaultIdCapitalTopUpFinalizationsByFinalizationIdReassessment](#postVaultsByVaultIdCapitalTopUpFinalizationsByFinalizationIdReassessment) |
| <code>POST</code> | <code>/vaults/{vaultId}/control-handoffs</code> | [postVaultsByVaultIdControlHandoffs](#postVaultsByVaultIdControlHandoffs) |
| <code>POST</code> | <code>/vaults/{vaultId}/control-handoffs/{handoffId}/finalization</code> | [postVaultsByVaultIdControlHandoffsByHandoffIdFinalization](#postVaultsByVaultIdControlHandoffsByHandoffIdFinalization) |
| <code>POST</code> | <code>/vaults/{vaultId}/policy-drafts</code> | [postVaultsByVaultIdPolicyDrafts](#postVaultsByVaultIdPolicyDrafts) |
| <code>GET</code> | <code>/vaults/{vaultId}/policy-drafts</code> | [getVaultsByVaultIdPolicyDrafts](#getVaultsByVaultIdPolicyDrafts) |
| <code>POST</code> | <code>/vaults/{vaultId}/policy-drafts/{policyId}/approve</code> | [postVaultsByVaultIdPolicyDraftsByPolicyIdApprove](#postVaultsByVaultIdPolicyDraftsByPolicyIdApprove) |
| <code>POST</code> | <code>/vaults/{vaultId}/policy-drafts/{policyId}/handoffs</code> | [postVaultsByVaultIdPolicyDraftsByPolicyIdHandoffs](#postVaultsByVaultIdPolicyDraftsByPolicyIdHandoffs) |
| <code>POST</code> | <code>/vaults/{vaultId}/policy-handoffs/{handoffId}/finalization</code> | [postVaultsByVaultIdPolicyHandoffsByHandoffIdFinalization](#postVaultsByVaultIdPolicyHandoffsByHandoffIdFinalization) |
| <code>GET</code> | <code>/vaults/{vaultId}/proposals</code> | [getVaultsByVaultIdProposals](#getVaultsByVaultIdProposals) |
| <code>POST</code> | <code>/vaults/{vaultId}/proposals</code> | [postVaultsByVaultIdProposals](#postVaultsByVaultIdProposals) |
| <code>POST</code> | <code>/vaults/{vaultId}/proposals/{proposalId}/approve</code> | [postVaultsByVaultIdProposalsByProposalIdApprove](#postVaultsByVaultIdProposalsByProposalIdApprove) |
| <code>POST</code> | <code>/vaults/{vaultId}/proposals/{proposalId}/safe-bundle</code> | [postVaultsByVaultIdProposalsByProposalIdSafeBundle](#postVaultsByVaultIdProposalsByProposalIdSafeBundle) |
| <code>GET</code> | <code>/vaults/{vaultId}/executions</code> | [getVaultsByVaultIdExecutions](#getVaultsByVaultIdExecutions) |
| <code>POST</code> | <code>/vaults/{vaultId}/commercial-terms</code> | [postVaultsByVaultIdCommercialTerms](#postVaultsByVaultIdCommercialTerms) |
| <code>POST</code> | <code>/vaults/{vaultId}/commercial-terms/{termsId}/acceptance</code> | [postVaultsByVaultIdCommercialTermsByTermsIdAcceptance](#postVaultsByVaultIdCommercialTermsByTermsIdAcceptance) |
| <code>GET</code> | <code>/vaults/{vaultId}/reports/{period}</code> | [getVaultsByVaultIdReportsByPeriod](#getVaultsByVaultIdReportsByPeriod) |
| <code>POST</code> | <code>/vaults/{vaultId}/deploy</code> | [postVaultsByVaultIdDeploy](#postVaultsByVaultIdDeploy) |
| <code>POST</code> | <code>/vaults/{vaultId}/funding-intents</code> | [postVaultsByVaultIdFundingIntents](#postVaultsByVaultIdFundingIntents) |
| <code>POST</code> | <code>/vaults/{vaultId}/pause</code> | [postVaultsByVaultIdPause](#postVaultsByVaultIdPause) |
| <code>POST</code> | <code>/vaults/{vaultId}/exit-preview</code> | [postVaultsByVaultIdExitPreview](#postVaultsByVaultIdExitPreview) |
| <code>POST</code> | <code>/vaults/{vaultId}/exit</code> | [postVaultsByVaultIdExit](#postVaultsByVaultIdExit) |
| <code>GET</code> | <code>/vaults/{vaultId}/balances</code> | [getVaultsByVaultIdBalances](#getVaultsByVaultIdBalances) |
| <code>POST</code> | <code>/vaults/{vaultId}/strategy-evaluations</code> | [postVaultsByVaultIdStrategyEvaluations](#postVaultsByVaultIdStrategyEvaluations) |
| <code>GET</code> | <code>/vaults/{vaultId}/strategy-state</code> | [getVaultsByVaultIdStrategyState](#getVaultsByVaultIdStrategyState) |
| <code>GET</code> | <code>/vaults/{vaultId}/policies</code> | [getVaultsByVaultIdPolicies](#getVaultsByVaultIdPolicies) |
| <code>POST</code> | <code>/vaults/{vaultId}/policies</code> | [postVaultsByVaultIdPolicies](#postVaultsByVaultIdPolicies) |
| <code>POST</code> | <code>/vaults/{vaultId}/policies/{version}/review</code> | [postVaultsByVaultIdPoliciesByVersionReview](#postVaultsByVaultIdPoliciesByVersionReview) |
| <code>POST</code> | <code>/vaults/{vaultId}/policies/{version}/approve</code> | [postVaultsByVaultIdPoliciesByVersionApprove](#postVaultsByVaultIdPoliciesByVersionApprove) |
| <code>POST</code> | <code>/vaults/{vaultId}/policies/{version}/activate</code> | [postVaultsByVaultIdPoliciesByVersionActivate](#postVaultsByVaultIdPoliciesByVersionActivate) |
| <code>POST</code> | <code>/vaults/{vaultId}/policies/{version}/revoke</code> | [postVaultsByVaultIdPoliciesByVersionRevoke](#postVaultsByVaultIdPoliciesByVersionRevoke) |
| <code>GET</code> | <code>/vaults/{vaultId}/market-quality</code> | [getVaultsByVaultIdMarketQuality](#getVaultsByVaultIdMarketQuality) |
| <code>GET</code> | <code>/vaults/{vaultId}/data-health</code> | [getVaultsByVaultIdDataHealth](#getVaultsByVaultIdDataHealth) |
| <code>GET</code> | <code>/vaults/{vaultId}/incidents</code> | [getVaultsByVaultIdIncidents](#getVaultsByVaultIdIncidents) |
| <code>POST</code> | <code>/vaults/{vaultId}/incidents/{incidentId}/acknowledge</code> | [postVaultsByVaultIdIncidentsByIncidentIdAcknowledge](#postVaultsByVaultIdIncidentsByIncidentIdAcknowledge) |
| <code>GET</code> | <code>/vaults/{vaultId}/evidence</code> | [getVaultsByVaultIdEvidence](#getVaultsByVaultIdEvidence) |
| <code>GET</code> | <code>/vaults/{vaultId}/events</code> | [getVaultsByVaultIdEvents](#getVaultsByVaultIdEvents) |
| <code>POST</code> | <code>/vaults/{vaultId}/reports</code> | [postVaultsByVaultIdReports](#postVaultsByVaultIdReports) |

<a id="getVaults"></a>

## getVaults

`GET /vaults`

Operation ID: <code>getVaults</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

This operation declares no parameters.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaults"></a>

## postVaults

`POST /vaults`

Operation ID: <code>postVaults</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>name</code> | Yes | <code>string</code> | Min length: <code>2</code>; Max length: <code>80</code> |
| <code>projectToken</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{40}$</code> |
| <code>quoteToken</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{40}$</code> |
| <code>quoteProfile</code> | Yes | <code>string</code> | Allowed: <code>USDT</code>, <code>WBOT</code> |
| <code>ownerSafe</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{40}$</code> |
| <code>poolAddress</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{40}$</code> |
| <code>launchContext</code> | Yes | <code>string</code> | Allowed: <code>PRE&#95;TGE</code>, <code>POST&#95;LAUNCH</code> |
| <code>strategy</code> | Yes | <code>object</code> | Additional properties rejected |
| <code>strategy.kind</code> | Yes | <code>string</code> | Allowed: <code>BOOTSTRAP</code>, <code>MAINTAIN</code>, <code>DIVERSIFY</code> |
| <code>strategy.version</code> | Yes | <code>string</code> | Min length: <code>1</code>; Max length: <code>80</code> |
| <code>strategy.targetInventoryPips</code> | Yes | <code>integer</code> | Minimum: <code>0</code>; Maximum: <code>1000000</code> |
| <code>strategy.rebalanceThresholdPips</code> | Yes | <code>integer</code> | Minimum: <code>0</code>; Maximum: <code>1000000</code> |
| <code>strategy.quoteReserveFloor</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>strategy.maxCandidateAmount</code> | Yes | <code>string</code> | Pattern: <code>^&#91;1-9&#93;&#91;0-9&#93;&#42;$</code> |
| <code>strategy.rangeWidthTicks</code> | Yes | <code>integer</code> | Maximum: <code>1774544</code>; Exclusive minimum: <code>0</code> |
| <code>strategy.diversificationTriggerPips</code> | Yes | <code>integer</code> | Minimum: <code>0</code>; Maximum: <code>1000000</code> |
| <code>strategy.diversificationMandate</code> | No | <code>object</code> | Additional properties rejected |
| <code>strategy.diversificationMandate.executionMode</code> | Yes | Constant <code>ISSUER&#95;SAFE&#95;APPROVAL&#95;ONLY</code> | — |
| <code>strategy.diversificationMandate.totalTokenSaleCap</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>strategy.diversificationMandate.dailyTokenSaleCap</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>strategy.diversificationMandate.hourlyTokenSaleCap</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>strategy.diversificationMandate.maximumOrganicVolumeParticipationPips</code> | Yes | <code>integer</code> | Minimum: <code>1</code>; Maximum: <code>1000000</code> |
| <code>strategy.diversificationMandate.minimumSalePriceX18</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>strategy.diversificationMandate.minimumRetainedTokenBalance</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>strategy.diversificationMandate.targetProtectedQuoteReserve</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>strategy.diversificationMandate.validUntil</code> | Yes | <code>string</code> | Format: <code>date-time</code> |
| <code>strategy.diversificationMandate.proceedsRule</code> | Yes | Constant <code>PROTECTED&#95;QUOTE&#95;RESERVE</code> | — |
| <code>strategy.diversificationMandate.repurchaseAllowed</code> | Yes | Constant <code>false</code> | — |
| <code>strategy.diversificationMandate.unlockDisclosureArtifactHash</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{64}$</code> |
| <code>strategy.diversificationMandate.insiderWalletDisclosureArtifactHash</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{64}$</code> |
| <code>strategy.diversificationMandate.publicReportingMode</code> | Yes | <code>string</code> | Allowed: <code>PRIVATE</code>, <code>ISSUER&#95;APPROVED&#95;PUBLIC</code> |
| <code>qualification</code> | Yes | <code>object</code> | Additional properties rejected |
| <code>qualification.legalEntityName</code> | Yes | <code>string</code> | Min length: <code>2</code>; Max length: <code>200</code> |
| <code>qualification.projectName</code> | Yes | <code>string</code> | Min length: <code>2</code>; Max length: <code>160</code> |
| <code>qualification.maximumDeployableTokenAtomic</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>qualification.maximumDeployableQuoteAtomic</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>qualification.protectedQuoteReserveAtomic</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>qualification.reserveRationale</code> | Yes | <code>string</code> | Min length: <code>12</code>; Max length: <code>1000</code> |
| <code>qualification.executionRecipientPolicy</code> | Yes | Constant <code>IMMUTABLE&#95;VAULT&#95;ONLY</code> | — |
| <code>qualification.exitRecipient</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{40}$</code> |
| <code>qualification.intendedPolicyTerm</code> | Yes | <code>object</code> | Additional properties rejected |
| <code>qualification.intendedPolicyTerm.validAfter</code> | Yes | <code>string</code> | Format: <code>date-time</code> |
| <code>qualification.intendedPolicyTerm.validUntil</code> | Yes | <code>string</code> | Format: <code>date-time</code> |
| <code>qualification.contacts</code> | Yes | Array of <code>object</code> | Min items: <code>2</code>; Max items: <code>12</code> |
| <code>qualification.contacts&#91;&#93;.kind</code> | Yes | <code>string</code> | Allowed: <code>OPERATIONS</code>, <code>EMERGENCY</code>, <code>GOVERNANCE</code> |
| <code>qualification.contacts&#91;&#93;.name</code> | Yes | <code>string</code> | Min length: <code>2</code>; Max length: <code>120</code> |
| <code>qualification.contacts&#91;&#93;.email</code> | Yes | <code>string</code> | Format: <code>email</code>; Max length: <code>254</code> |
| <code>qualification.contacts&#91;&#93;.responseWindowMinutes</code> | Yes | <code>integer</code> | Minimum: <code>1</code>; Maximum: <code>10080</code> |
| <code>qualification.launch</code> | Yes | <code>object</code> | Additional properties rejected |
| <code>qualification.launch.launchDate</code> | Yes | <code>string</code> | Format: <code>date-time</code> |
| <code>qualification.launch.unlockScheduleArtifactHash</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{64}$</code> |
| <code>qualification.tokenDisclosureArtifactHash</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{64}$</code> |
| <code>qualification.governanceApprovalArtifactHash</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{64}$</code> |
| <code>qualification.dataRoom</code> | Yes | <code>object</code> | Additional properties rejected |
| <code>qualification.dataRoom.termsVersion</code> | Yes | <code>string</code> | Min length: <code>1</code>; Max length: <code>120</code> |
| <code>qualification.dataRoom.termsSource</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |
| <code>qualification.dataRoom.acceptedAt</code> | Yes | <code>string</code> | Format: <code>date-time</code> |
| <code>qualification.desiredOutcomes</code> | Yes | Array of <code>string</code> | Min items: <code>1</code>; Max items: <code>20</code> |
| <code>qualification.prohibitedBehaviors</code> | Yes | Array of <code>string</code> | Min items: <code>1</code>; Max items: <code>20</code> |
| <code>qualification.referenceVenueIds</code> | Yes | Array of <code>string</code> | Min items: <code>1</code>; Max items: <code>20</code> |
| <code>qualification.oracleSourceAddresses</code> | Yes | Array of <code>string</code> | Min items: <code>2</code>; Max items: <code>2</code> |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>12</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>201</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>201</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsPreviewDeployment"></a>

## postVaultsPreviewDeployment

`POST /vaults/preview-deployment`

Operation ID: <code>postVaultsPreviewDeployment</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>vaultId</code> | Yes | <code>string</code> | Min length: <code>1</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="getVaultsByVaultId"></a>

## getVaultsByVaultId

`GET /vaults/{vaultId}`

Operation ID: <code>getVaultsByVaultId</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="getVaultsByVaultIdIssuerExitKit"></a>

## getVaultsByVaultIdIssuerExitKit

`GET /vaults/{vaultId}/issuer-exit-kit`

Operation ID: <code>getVaultsByVaultIdIssuerExitKit</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="getVaultsByVaultIdPositions"></a>

## getVaultsByVaultIdPositions

`GET /vaults/{vaultId}/positions`

Operation ID: <code>getVaultsByVaultIdPositions</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="getVaultsByVaultIdInventory"></a>

## getVaultsByVaultIdInventory

`GET /vaults/{vaultId}/inventory`

Operation ID: <code>getVaultsByVaultIdInventory</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="getVaultsByVaultIdDepth"></a>

## getVaultsByVaultIdDepth

`GET /vaults/{vaultId}/depth`

Operation ID: <code>getVaultsByVaultIdDepth</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="getVaultsByVaultIdDepthHistory"></a>

## getVaultsByVaultIdDepthHistory

`GET /vaults/{vaultId}/depth-history`

Operation ID: <code>getVaultsByVaultIdDepthHistory</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="getVaultsByVaultIdPolicy"></a>

## getVaultsByVaultIdPolicy

`GET /vaults/{vaultId}/policy`

Operation ID: <code>getVaultsByVaultIdPolicy</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdDeploymentPreview"></a>

## postVaultsByVaultIdDeploymentPreview

`POST /vaults/{vaultId}/deployment-preview`

Operation ID: <code>postVaultsByVaultIdDeploymentPreview</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdDeploymentHandoff"></a>

## postVaultsByVaultIdDeploymentHandoff

`POST /vaults/{vaultId}/deployment-handoff`

Operation ID: <code>postVaultsByVaultIdDeploymentHandoff</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>amount0</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>amount1</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>minimumReceived0</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>minimumReceived1</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>201</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>201</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdRuntimeDeploymentHandoff"></a>

## postVaultsByVaultIdRuntimeDeploymentHandoff

`POST /vaults/{vaultId}/runtime-deployment-handoff`

Operation ID: <code>postVaultsByVaultIdRuntimeDeploymentHandoff</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>201</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>201</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdDeploymentFinalization"></a>

## postVaultsByVaultIdDeploymentFinalization

`POST /vaults/{vaultId}/deployment-finalization`

Operation ID: <code>postVaultsByVaultIdDeploymentFinalization</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>transactionHash</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{64}$</code> |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdDeploymentHandoffCancelExpired"></a>

## postVaultsByVaultIdDeploymentHandoffCancelExpired

`POST /vaults/{vaultId}/deployment-handoff/cancel-expired`

Operation ID: <code>postVaultsByVaultIdDeploymentHandoffCancelExpired</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdDeploymentRiskReassess"></a>

## postVaultsByVaultIdDeploymentRiskReassess

`POST /vaults/{vaultId}/deployment-risk/reassess`

Operation ID: <code>postVaultsByVaultIdDeploymentRiskReassess</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdLifecycleTransitions"></a>

## postVaultsByVaultIdLifecycleTransitions

`POST /vaults/{vaultId}/lifecycle-transitions`

Operation ID: <code>postVaultsByVaultIdLifecycleTransitions</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>to</code> | Yes | <code>string</code> | Allowed: <code>LEAD</code>, <code>QUALIFIED</code>, <code>DATA&#95;ROOM</code>, <code>SIMULATED</code>, <code>POLICY&#95;DRAFT</code>, <code>TESTNET</code>, <code>SHADOW</code>, <code>FUND&#95;READY</code>, <code>LIVE&#95;CAPPED</code>, <code>LIVE&#95;EXPANDED</code> |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdTestnetMechanicsGates"></a>

## postVaultsByVaultIdTestnetMechanicsGates

`POST /vaults/{vaultId}/testnet-mechanics-gates`

Operation ID: <code>postVaultsByVaultIdTestnetMechanicsGates</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>exerciseWindowStart</code> | Yes | <code>string</code> | Format: <code>date-time</code> |
| <code>exerciseWindowEnd</code> | Yes | <code>string</code> | Format: <code>date-time</code> |
| <code>proofs</code> | Yes | Array of <code>object</code> | Min items: <code>15</code>; Max items: <code>15</code> |
| <code>proofs&#91;&#93;.mechanic</code> | Yes | <code>string</code> | Allowed: <code>VAULT&#95;DEPLOYMENT</code>, <code>SAFE&#95;OWNERSHIP</code>, <code>DEPOSIT</code>, <code>PARTIAL&#95;WITHDRAWAL</code>, <code>FULL&#95;WITHDRAWAL</code>, <code>POSITION&#95;CREATION</code>, <code>POSITION&#95;ADJUSTMENT</code>, <code>FEE&#95;COLLECTION</code>, <code>UNWIND</code>, <code>ORACLE&#95;FAILURE</code>, <code>EXECUTOR&#95;FAILURE</code>, <code>KEY&#95;ROTATION</code>, <code>PAUSE&#95;AND&#95;ISSUER&#95;EXIT</code>, <code>REORG&#95;AND&#95;REPLACEMENT</code>, <code>REPORT&#95;GENERATION</code> |
| <code>proofs&#91;&#93;.status</code> | Yes | Constant <code>PASSED</code> | — |
| <code>proofs&#91;&#93;.artifactKind</code> | Yes | <code>string</code> | Allowed: <code>CHAIN&#95;EXECUTION</code>, <code>SAFE&#95;AUTHORITY</code>, <code>INCIDENT&#95;DRILL</code>, <code>RECONCILIATION&#95;RUN</code>, <code>REPORT&#95;BUNDLE</code> |
| <code>proofs&#91;&#93;.artifactId</code> | Yes | <code>string</code> | Pattern: <code>^&#91;a-zA-Z0-9&#93;&#91;a-zA-Z0-9:&#95;-&#93;{0,159}$</code> |
| <code>proofs&#91;&#93;.evidenceHash</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{64}$</code> |
| <code>proofs&#91;&#93;.transactionHashes</code> | Yes | Array of <code>string</code> | Max items: <code>100</code> |
| <code>proofs&#91;&#93;.observedAt</code> | Yes | <code>string</code> | Format: <code>date-time</code> |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>201</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>201</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdTestnetMechanicsGatesByArtifactIdApproval"></a>

## postVaultsByVaultIdTestnetMechanicsGatesByArtifactIdApproval

`POST /vaults/{vaultId}/testnet-mechanics-gates/{artifactId}/approval`

Operation ID: <code>postVaultsByVaultIdTestnetMechanicsGatesByArtifactIdApproval</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>artifactId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdLiveExpansionGates"></a>

## postVaultsByVaultIdLiveExpansionGates

`POST /vaults/{vaultId}/live-expansion-gates`

Operation ID: <code>postVaultsByVaultIdLiveExpansionGates</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>customerSuccessTrend</code> | Yes | <code>string</code> | Allowed: <code>IMPROVING</code>, <code>STABLE</code>, <code>NEGATIVE&#95;UNDERSTOOD</code> |
| <code>customerSuccessEvidenceHash</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{64}$</code> |
| <code>strategyNetResultUnderstandingHash</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{64}$</code> |
| <code>proposedCapitalCapAtomic</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>201</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>201</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdLiveExpansionGatesByArtifactIdApproval"></a>

## postVaultsByVaultIdLiveExpansionGatesByArtifactIdApproval

`POST /vaults/{vaultId}/live-expansion-gates/{artifactId}/approval`

Operation ID: <code>postVaultsByVaultIdLiveExpansionGatesByArtifactIdApproval</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>artifactId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdCapitalTopUpHandoffs"></a>

## postVaultsByVaultIdCapitalTopUpHandoffs

`POST /vaults/{vaultId}/capital-top-up-handoffs`

Operation ID: <code>postVaultsByVaultIdCapitalTopUpHandoffs</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>amount0</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>amount1</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>minimumReceived0</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>minimumReceived1</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>201</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>201</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdCapitalTopUpHandoffsByHandoffIdFinalization"></a>

## postVaultsByVaultIdCapitalTopUpHandoffsByHandoffIdFinalization

`POST /vaults/{vaultId}/capital-top-up-handoffs/{handoffId}/finalization`

Operation ID: <code>postVaultsByVaultIdCapitalTopUpHandoffsByHandoffIdFinalization</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>handoffId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>transactionHash</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{64}$</code> |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdCapitalTopUpFinalizationsByFinalizationIdReassessment"></a>

## postVaultsByVaultIdCapitalTopUpFinalizationsByFinalizationIdReassessment

`POST /vaults/{vaultId}/capital-top-up-finalizations/{finalizationId}/reassessment`

Operation ID: <code>postVaultsByVaultIdCapitalTopUpFinalizationsByFinalizationIdReassessment</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>finalizationId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdControlHandoffs"></a>

## postVaultsByVaultIdControlHandoffs

`POST /vaults/{vaultId}/control-handoffs`

Operation ID: <code>postVaultsByVaultIdControlHandoffs</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>action</code> | Yes | <code>string</code> | Allowed: <code>PAUSE</code>, <code>RESUME</code>, <code>SCHEDULE&#95;AUTOMATION</code>, <code>ACTIVATE&#95;AUTOMATION</code>, <code>DISABLE&#95;AUTOMATION</code>, <code>PARTIAL&#95;WITHDRAW</code>, <code>ENTER&#95;EXITING</code>, <code>FINALIZE&#95;EXIT</code> |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |
| <code>resumeLifecycle</code> | No | <code>string</code> | Allowed: <code>TESTNET</code>, <code>SHADOW</code>, <code>FUND&#95;READY</code>, <code>LIVE&#95;CAPPED</code>, <code>LIVE&#95;EXPANDED</code> |
| <code>exitMinimums</code> | No | Array of <code>object</code> | Max items: <code>64</code> |
| <code>exitMinimums&#91;&#93;.positionId</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>exitMinimums&#91;&#93;.amount0Min</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>exitMinimums&#91;&#93;.amount1Min</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>withdrawalAmounts</code> | No | <code>object</code> | Additional properties rejected |
| <code>withdrawalAmounts.amount0</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>withdrawalAmounts.amount1</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>201</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>201</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdControlHandoffsByHandoffIdFinalization"></a>

## postVaultsByVaultIdControlHandoffsByHandoffIdFinalization

`POST /vaults/{vaultId}/control-handoffs/{handoffId}/finalization`

Operation ID: <code>postVaultsByVaultIdControlHandoffsByHandoffIdFinalization</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>handoffId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>transactionHash</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{64}$</code> |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdPolicyDrafts"></a>

## postVaultsByVaultIdPolicyDrafts

`POST /vaults/{vaultId}/policy-drafts`

Operation ID: <code>postVaultsByVaultIdPolicyDrafts</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>policy</code> | Yes | <code>object</code> | Additional properties rejected |
| <code>policy.id</code> | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>policy.version</code> | Yes | <code>integer</code> | Exclusive minimum: <code>0</code> |
| <code>policy.strategy</code> | Yes | <code>string</code> | Allowed: <code>BOOTSTRAP</code>, <code>MAINTAIN</code>, <code>DIVERSIFY</code> |
| <code>policy.strategyVersion</code> | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>policy.configHash</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{64}$</code> |
| <code>policy.validAfter</code> | Yes | <code>string</code> | Format: <code>date-time</code> |
| <code>policy.validUntil</code> | Yes | <code>string</code> | Format: <code>date-time</code> |
| <code>policy.cooldownSeconds</code> | Yes | <code>integer</code> | Minimum: <code>0</code>; Maximum: <code>4294967295</code> |
| <code>policy.maxPositions</code> | Yes | <code>integer</code> | Maximum: <code>32</code>; Exclusive minimum: <code>0</code> |
| <code>policy.maxOracleDeviationPips</code> | Yes | <code>integer</code> | Minimum: <code>0</code>; Maximum: <code>100000</code> |
| <code>policy.maxTwapDeviationPips</code> | Yes | <code>integer</code> | Minimum: <code>0</code>; Maximum: <code>100000</code> |
| <code>policy.minOracleConfidencePips</code> | Yes | <code>integer</code> | Minimum: <code>800000</code>; Maximum: <code>1000000</code> |
| <code>policy.minOracleObservationAgeSeconds</code> | Yes | <code>integer</code> | Minimum: <code>1</code>; Maximum: <code>3600</code> |
| <code>policy.maxSwapSlippagePips</code> | Yes | <code>integer</code> | Minimum: <code>0</code>; Maximum: <code>100000</code> |
| <code>policy.maxDailyTurnoverPips</code> | Yes | <code>integer</code> | Minimum: <code>0</code>; Maximum: <code>500000</code> |
| <code>policy.minActiveLiquidityPips</code> | Yes | <code>integer</code> | Minimum: <code>0</code>; Maximum: <code>1000000</code> |
| <code>policy.minQuoteReservePips</code> | Yes | <code>integer</code> | Minimum: <code>0</code>; Maximum: <code>1000000</code> |
| <code>policy.maxSwapPerAction</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>policy.maxSwapPerDay</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>policy.maxGasReimbursement</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>policy.maxRealizedLossPerDay</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>policy.maxCapitalPerPosition</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>policy.maxActionsPerDay</code> | Yes | <code>integer</code> | Maximum: <code>10000</code>; Exclusive minimum: <code>0</code> |
| <code>policy.minimumTick</code> | Yes | <code>integer</code> | Minimum: <code>-887272</code>; Maximum: <code>887272</code> |
| <code>policy.maximumTick</code> | Yes | <code>integer</code> | Minimum: <code>-887272</code>; Maximum: <code>887272</code> |
| <code>policy.maximumPositionWidthTicks</code> | Yes | <code>integer</code> | Maximum: <code>16777215</code>; Exclusive minimum: <code>0</code> |
| <code>policy.minimumPositionWidthTicks</code> | Yes | <code>integer</code> | Maximum: <code>16777215</code>; Exclusive minimum: <code>0</code> |
| <code>policy.allowedPools</code> | Yes | Array of <code>string</code> | Min items: <code>1</code>; Max items: <code>32</code> |
| <code>policy.allowedRecipients</code> | Yes | Array of <code>string</code> | Min items: <code>1</code>; Max items: <code>32</code> |
| <code>policy.executor</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{40}$</code> |
| <code>policy.guardian</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{40}$</code> |
| <code>policy.oracleGuard</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{40}$</code> |
| <code>policy.quoteProfile</code> | Yes | <code>string</code> | Allowed: <code>USDT</code>, <code>WBOT</code> |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |
| <code>sourceSimulationId</code> | No | <code>string</code> | Min length: <code>1</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>201</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>201</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="getVaultsByVaultIdPolicyDrafts"></a>

## getVaultsByVaultIdPolicyDrafts

`GET /vaults/{vaultId}/policy-drafts`

Operation ID: <code>getVaultsByVaultIdPolicyDrafts</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdPolicyDraftsByPolicyIdApprove"></a>

## postVaultsByVaultIdPolicyDraftsByPolicyIdApprove

`POST /vaults/{vaultId}/policy-drafts/{policyId}/approve`

Operation ID: <code>postVaultsByVaultIdPolicyDraftsByPolicyIdApprove</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>policyId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdPolicyDraftsByPolicyIdHandoffs"></a>

## postVaultsByVaultIdPolicyDraftsByPolicyIdHandoffs

`POST /vaults/{vaultId}/policy-drafts/{policyId}/handoffs`

Operation ID: <code>postVaultsByVaultIdPolicyDraftsByPolicyIdHandoffs</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>policyId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>phase</code> | Yes | <code>string</code> | Allowed: <code>PROPOSE</code>, <code>ACTIVATE</code> |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>201</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>201</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdPolicyHandoffsByHandoffIdFinalization"></a>

## postVaultsByVaultIdPolicyHandoffsByHandoffIdFinalization

`POST /vaults/{vaultId}/policy-handoffs/{handoffId}/finalization`

Operation ID: <code>postVaultsByVaultIdPolicyHandoffsByHandoffIdFinalization</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>handoffId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>transactionHash</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{64}$</code> |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="getVaultsByVaultIdProposals"></a>

## getVaultsByVaultIdProposals

`GET /vaults/{vaultId}/proposals`

Operation ID: <code>getVaultsByVaultIdProposals</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | [ProposalRecord](/api-reference/v1/schemas/proposal-record/) | — |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdProposals"></a>

## postVaultsByVaultIdProposals

`POST /vaults/{vaultId}/proposals`

Operation ID: <code>postVaultsByVaultIdProposals</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>trigger</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |
| <code>simulationId</code> | No | <code>string</code> | Min length: <code>1</code> |
| <code>action</code> | No | Exactly one of: <code>object</code>; <code>object</code> | Discriminator: <code>kind</code> |
| <code>action.oneOf&#91;1&#93;.kind</code> | Yes | Constant <code>WRAP&#95;BOT</code> | — |
| <code>action.oneOf&#91;1&#93;.amount</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>action.oneOf&#91;2&#93;.kind</code> | Yes | Constant <code>UNWRAP&#95;WBOT</code> | — |
| <code>action.oneOf&#91;2&#93;.amount</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>action.oneOf&#91;2&#93;.recipient</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{40}$</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>201</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>201</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | [ProposalRecord](/api-reference/v1/schemas/proposal-record/) | — |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdProposalsByProposalIdApprove"></a>

## postVaultsByVaultIdProposalsByProposalIdApprove

`POST /vaults/{vaultId}/proposals/{proposalId}/approve`

Operation ID: <code>postVaultsByVaultIdProposalsByProposalIdApprove</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>proposalId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | [ProposalRecord](/api-reference/v1/schemas/proposal-record/) | — |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdProposalsByProposalIdSafeBundle"></a>

## postVaultsByVaultIdProposalsByProposalIdSafeBundle

`POST /vaults/{vaultId}/proposals/{proposalId}/safe-bundle`

Operation ID: <code>postVaultsByVaultIdProposalsByProposalIdSafeBundle</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>proposalId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | [ProposalRecord](/api-reference/v1/schemas/proposal-record/) | — |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="getVaultsByVaultIdExecutions"></a>

## getVaultsByVaultIdExecutions

`GET /vaults/{vaultId}/executions`

Operation ID: <code>getVaultsByVaultIdExecutions</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdCommercialTerms"></a>

## postVaultsByVaultIdCommercialTerms

`POST /vaults/{vaultId}/commercial-terms`

Operation ID: <code>postVaultsByVaultIdCommercialTerms</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>schedule</code> | Yes | <code>object</code> | Additional properties rejected |
| <code>schedule.setupFeeQuoteAtomic</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>schedule.serviceFeeQuoteAtomic</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>schedule.serviceFeeCadence</code> | Yes | <code>string</code> | Allowed: <code>DAILY</code>, <code>WEEKLY</code> |
| <code>schedule.performanceFeePips</code> | Yes | <code>integer</code> | Minimum: <code>0</code>; Maximum: <code>300000</code> |
| <code>schedule.performanceFeeCapQuoteAtomic</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>schedule.gasReimbursement</code> | Yes | <code>string</code> | Allowed: <code>NONE</code>, <code>ACTUAL&#95;FINALIZED&#95;RECEIPT&#95;GAS</code> |
| <code>schedule.gasReimbursementCapQuoteAtomic</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>schedule.passThroughCostCapQuoteAtomic</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>schedule.totalFeeCapQuoteAtomic</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>schedule.paymentRecipient</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{40}$</code> |
| <code>benchmark</code> | Yes | <code>object</code> | Additional properties rejected |
| <code>benchmark.version</code> | Yes | Constant <code>klineo-commercial-benchmark-v1</code> | — |
| <code>benchmark.kind</code> | Yes | <code>string</code> | Allowed: <code>HOLD&#95;OPENING&#95;INVENTORY</code>, <code>PASSIVE&#95;FULL&#95;RANGE</code> |
| <code>benchmark.highWaterMark</code> | Yes | Constant <code>CUMULATIVE&#95;ALPHA&#95;PER&#95;SIGNED&#95;TERMS</code> | — |
| <code>benchmark.negativeCarry</code> | Yes | Constant <code>true</code> | — |
| <code>benchmark.reset</code> | Yes | Constant <code>NEW&#95;SIGNED&#95;TERMS&#95;ONLY</code> | — |
| <code>validAfter</code> | Yes | <code>string</code> | Format: <code>date-time</code> |
| <code>validUntil</code> | Yes | <code>string</code> | Format: <code>date-time</code> |
| <code>preparationReason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>201</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>201</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdCommercialTermsByTermsIdAcceptance"></a>

## postVaultsByVaultIdCommercialTermsByTermsIdAcceptance

`POST /vaults/{vaultId}/commercial-terms/{termsId}/acceptance`

Operation ID: <code>postVaultsByVaultIdCommercialTermsByTermsIdAcceptance</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>termsId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>signature</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;+$</code> |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="getVaultsByVaultIdReportsByPeriod"></a>

## getVaultsByVaultIdReportsByPeriod

`GET /vaults/{vaultId}/reports/{period}`

Operation ID: <code>getVaultsByVaultIdReportsByPeriod</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>period</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdDeploy"></a>

## postVaultsByVaultIdDeploy

`POST /vaults/{vaultId}/deploy`

Operation ID: <code>postVaultsByVaultIdDeploy</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

Exactly one of: <code>object</code>; <code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>oneOf&#91;1&#93;.amount0</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>oneOf&#91;1&#93;.amount1</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>oneOf&#91;1&#93;.minimumReceived0</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>oneOf&#91;1&#93;.minimumReceived1</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>oneOf&#91;1&#93;.reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |
| <code>oneOf&#91;2&#93;.reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>201</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>201</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdFundingIntents"></a>

## postVaultsByVaultIdFundingIntents

`POST /vaults/{vaultId}/funding-intents`

Operation ID: <code>postVaultsByVaultIdFundingIntents</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>amount0</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>amount1</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>minimumReceived0</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>minimumReceived1</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>201</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>201</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdPause"></a>

## postVaultsByVaultIdPause

`POST /vaults/{vaultId}/pause`

Operation ID: <code>postVaultsByVaultIdPause</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>action</code> | No | <code>string</code> | Allowed: <code>PAUSE</code> |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |
| <code>resumeLifecycle</code> | No | <code>string</code> | Allowed: <code>TESTNET</code>, <code>SHADOW</code>, <code>FUND&#95;READY</code>, <code>LIVE&#95;CAPPED</code>, <code>LIVE&#95;EXPANDED</code> |
| <code>exitMinimums</code> | No | Array of <code>object</code> | Max items: <code>64</code> |
| <code>exitMinimums&#91;&#93;.positionId</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>exitMinimums&#91;&#93;.amount0Min</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>exitMinimums&#91;&#93;.amount1Min</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>withdrawalAmounts</code> | No | <code>object</code> | Additional properties rejected |
| <code>withdrawalAmounts.amount0</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>withdrawalAmounts.amount1</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>201</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>201</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdExitPreview"></a>

## postVaultsByVaultIdExitPreview

`POST /vaults/{vaultId}/exit-preview`

Operation ID: <code>postVaultsByVaultIdExitPreview</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdExit"></a>

## postVaultsByVaultIdExit

`POST /vaults/{vaultId}/exit`

Operation ID: <code>postVaultsByVaultIdExit</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>action</code> | No | <code>string</code> | Allowed: <code>PARTIAL&#95;WITHDRAW</code>, <code>ENTER&#95;EXITING</code>, <code>FINALIZE&#95;EXIT</code> |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |
| <code>resumeLifecycle</code> | No | <code>string</code> | Allowed: <code>TESTNET</code>, <code>SHADOW</code>, <code>FUND&#95;READY</code>, <code>LIVE&#95;CAPPED</code>, <code>LIVE&#95;EXPANDED</code> |
| <code>exitMinimums</code> | No | Array of <code>object</code> | Max items: <code>64</code> |
| <code>exitMinimums&#91;&#93;.positionId</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>exitMinimums&#91;&#93;.amount0Min</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>exitMinimums&#91;&#93;.amount1Min</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>withdrawalAmounts</code> | No | <code>object</code> | Additional properties rejected |
| <code>withdrawalAmounts.amount0</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>withdrawalAmounts.amount1</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>201</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>201</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="getVaultsByVaultIdBalances"></a>

## getVaultsByVaultIdBalances

`GET /vaults/{vaultId}/balances`

Operation ID: <code>getVaultsByVaultIdBalances</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdStrategyEvaluations"></a>

## postVaultsByVaultIdStrategyEvaluations

`POST /vaults/{vaultId}/strategy-evaluations`

Operation ID: <code>postVaultsByVaultIdStrategyEvaluations</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>trigger</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |
| <code>simulationId</code> | No | <code>string</code> | Min length: <code>1</code> |
| <code>action</code> | No | Exactly one of: <code>object</code>; <code>object</code> | Discriminator: <code>kind</code> |
| <code>action.oneOf&#91;1&#93;.kind</code> | Yes | Constant <code>WRAP&#95;BOT</code> | — |
| <code>action.oneOf&#91;1&#93;.amount</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>action.oneOf&#91;2&#93;.kind</code> | Yes | Constant <code>UNWRAP&#95;WBOT</code> | — |
| <code>action.oneOf&#91;2&#93;.amount</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>action.oneOf&#91;2&#93;.recipient</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{40}$</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>201</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>201</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | [ProposalRecord](/api-reference/v1/schemas/proposal-record/) | — |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="getVaultsByVaultIdStrategyState"></a>

## getVaultsByVaultIdStrategyState

`GET /vaults/{vaultId}/strategy-state`

Operation ID: <code>getVaultsByVaultIdStrategyState</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="getVaultsByVaultIdPolicies"></a>

## getVaultsByVaultIdPolicies

`GET /vaults/{vaultId}/policies`

Operation ID: <code>getVaultsByVaultIdPolicies</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdPolicies"></a>

## postVaultsByVaultIdPolicies

`POST /vaults/{vaultId}/policies`

Operation ID: <code>postVaultsByVaultIdPolicies</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>policy</code> | Yes | <code>object</code> | Additional properties rejected |
| <code>policy.id</code> | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>policy.version</code> | Yes | <code>integer</code> | Exclusive minimum: <code>0</code> |
| <code>policy.strategy</code> | Yes | <code>string</code> | Allowed: <code>BOOTSTRAP</code>, <code>MAINTAIN</code>, <code>DIVERSIFY</code> |
| <code>policy.strategyVersion</code> | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>policy.configHash</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{64}$</code> |
| <code>policy.validAfter</code> | Yes | <code>string</code> | Format: <code>date-time</code> |
| <code>policy.validUntil</code> | Yes | <code>string</code> | Format: <code>date-time</code> |
| <code>policy.cooldownSeconds</code> | Yes | <code>integer</code> | Minimum: <code>0</code>; Maximum: <code>4294967295</code> |
| <code>policy.maxPositions</code> | Yes | <code>integer</code> | Maximum: <code>32</code>; Exclusive minimum: <code>0</code> |
| <code>policy.maxOracleDeviationPips</code> | Yes | <code>integer</code> | Minimum: <code>0</code>; Maximum: <code>100000</code> |
| <code>policy.maxTwapDeviationPips</code> | Yes | <code>integer</code> | Minimum: <code>0</code>; Maximum: <code>100000</code> |
| <code>policy.minOracleConfidencePips</code> | Yes | <code>integer</code> | Minimum: <code>800000</code>; Maximum: <code>1000000</code> |
| <code>policy.minOracleObservationAgeSeconds</code> | Yes | <code>integer</code> | Minimum: <code>1</code>; Maximum: <code>3600</code> |
| <code>policy.maxSwapSlippagePips</code> | Yes | <code>integer</code> | Minimum: <code>0</code>; Maximum: <code>100000</code> |
| <code>policy.maxDailyTurnoverPips</code> | Yes | <code>integer</code> | Minimum: <code>0</code>; Maximum: <code>500000</code> |
| <code>policy.minActiveLiquidityPips</code> | Yes | <code>integer</code> | Minimum: <code>0</code>; Maximum: <code>1000000</code> |
| <code>policy.minQuoteReservePips</code> | Yes | <code>integer</code> | Minimum: <code>0</code>; Maximum: <code>1000000</code> |
| <code>policy.maxSwapPerAction</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>policy.maxSwapPerDay</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>policy.maxGasReimbursement</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>policy.maxRealizedLossPerDay</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>policy.maxCapitalPerPosition</code> | Yes | <code>string</code> | Pattern: <code>^&#40;0&#124;&#91;1-9&#93;&#91;0-9&#93;&#42;&#41;$</code> |
| <code>policy.maxActionsPerDay</code> | Yes | <code>integer</code> | Maximum: <code>10000</code>; Exclusive minimum: <code>0</code> |
| <code>policy.minimumTick</code> | Yes | <code>integer</code> | Minimum: <code>-887272</code>; Maximum: <code>887272</code> |
| <code>policy.maximumTick</code> | Yes | <code>integer</code> | Minimum: <code>-887272</code>; Maximum: <code>887272</code> |
| <code>policy.maximumPositionWidthTicks</code> | Yes | <code>integer</code> | Maximum: <code>16777215</code>; Exclusive minimum: <code>0</code> |
| <code>policy.minimumPositionWidthTicks</code> | Yes | <code>integer</code> | Maximum: <code>16777215</code>; Exclusive minimum: <code>0</code> |
| <code>policy.allowedPools</code> | Yes | Array of <code>string</code> | Min items: <code>1</code>; Max items: <code>32</code> |
| <code>policy.allowedRecipients</code> | Yes | Array of <code>string</code> | Min items: <code>1</code>; Max items: <code>32</code> |
| <code>policy.executor</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{40}$</code> |
| <code>policy.guardian</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{40}$</code> |
| <code>policy.oracleGuard</code> | Yes | <code>string</code> | Pattern: <code>^0x&#91;0-9a-fA-F&#93;{40}$</code> |
| <code>policy.quoteProfile</code> | Yes | <code>string</code> | Allowed: <code>USDT</code>, <code>WBOT</code> |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |
| <code>sourceSimulationId</code> | No | <code>string</code> | Min length: <code>1</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>201</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>201</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdPoliciesByVersionReview"></a>

## postVaultsByVaultIdPoliciesByVersionReview

`POST /vaults/{vaultId}/policies/{version}/review`

Operation ID: <code>postVaultsByVaultIdPoliciesByVersionReview</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>version</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdPoliciesByVersionApprove"></a>

## postVaultsByVaultIdPoliciesByVersionApprove

`POST /vaults/{vaultId}/policies/{version}/approve`

Operation ID: <code>postVaultsByVaultIdPoliciesByVersionApprove</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>version</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>201</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>201</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdPoliciesByVersionActivate"></a>

## postVaultsByVaultIdPoliciesByVersionActivate

`POST /vaults/{vaultId}/policies/{version}/activate`

Operation ID: <code>postVaultsByVaultIdPoliciesByVersionActivate</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>version</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>201</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>201</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdPoliciesByVersionRevoke"></a>

## postVaultsByVaultIdPoliciesByVersionRevoke

`POST /vaults/{vaultId}/policies/{version}/revoke`

Operation ID: <code>postVaultsByVaultIdPoliciesByVersionRevoke</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>version</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>201</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>201</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="getVaultsByVaultIdMarketQuality"></a>

## getVaultsByVaultIdMarketQuality

`GET /vaults/{vaultId}/market-quality`

Operation ID: <code>getVaultsByVaultIdMarketQuality</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="getVaultsByVaultIdDataHealth"></a>

## getVaultsByVaultIdDataHealth

`GET /vaults/{vaultId}/data-health`

Operation ID: <code>getVaultsByVaultIdDataHealth</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="getVaultsByVaultIdIncidents"></a>

## getVaultsByVaultIdIncidents

`GET /vaults/{vaultId}/incidents`

Operation ID: <code>getVaultsByVaultIdIncidents</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdIncidentsByIncidentIdAcknowledge"></a>

## postVaultsByVaultIdIncidentsByIncidentIdAcknowledge

`POST /vaults/{vaultId}/incidents/{incidentId}/acknowledge`

Operation ID: <code>postVaultsByVaultIdIncidentsByIncidentIdAcknowledge</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>incidentId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>message</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="getVaultsByVaultIdEvidence"></a>

## getVaultsByVaultIdEvidence

`GET /vaults/{vaultId}/evidence`

Operation ID: <code>getVaultsByVaultIdEvidence</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="getVaultsByVaultIdEvents"></a>

## getVaultsByVaultIdEvents

`GET /vaults/{vaultId}/events`

Operation ID: <code>getVaultsByVaultIdEvents</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>200</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>200</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | <code>object</code> | The typed runtime domain record returned by this operation. Additional properties allowed |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

<a id="postVaultsByVaultIdReports"></a>

## postVaultsByVaultIdReports

`POST /vaults/{vaultId}/reports`

Operation ID: <code>postVaultsByVaultIdReports</code>

**Authentication:** <code>&#95;&#95;Host-klineo&#95;session</code> cookie (<code>sessionCookie</code>)

### Parameters

| Name | Location | Required | Type | Description and constraints |
| --- | --- | --- | --- | --- |
| <code>vaultId</code> | path | Yes | <code>string</code> | Min length: <code>1</code> |
| <code>Idempotency-Key</code> | header | Yes | <code>string</code> | Min length: <code>8</code>; Max length: <code>163</code> |
| <code>If-Match</code> | header | Yes | <code>string</code> | One quoted strong entity tag for the exact aggregate version reviewed by the actor. Pattern: <code>^"&#91;^"&#92;&#92;&#92;r&#92;n&#93;+"$</code>; Min length: <code>3</code> |

### Request body

Required: **yes**.

**<code>application/json</code>**

<code>object</code> — Additional properties rejected

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>cadence</code> | Yes | <code>string</code> | Allowed: <code>DAILY</code>, <code>WEEKLY</code> |
| <code>periodEnd</code> | No | <code>string</code> | Format: <code>date-time</code> |
| <code>reason</code> | Yes | <code>string</code> | Min length: <code>3</code>; Max length: <code>500</code> |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

### Responses

| Status | Description | Content type and schema |
| --- | --- | --- |
| <code>202</code> | Successful response | <code>application/json</code>: <code>object</code> |
| <code>default</code> | Structured API error | <code>application/json</code>: [ApiErrorEnvelope](/api-reference/v1/schemas/api-error-envelope/) |

**<code>202</code> <code>application/json</code> body**

<code>object</code>

| Field | Required at this level | Type | Description and constraints |
| --- | --- | --- | --- |
| <code>data</code> | Yes | [BackgroundJob](/api-reference/v1/schemas/background-job/) | — |

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.