MCP tool reference

This reference lists the available MCP tools, permissions and input parameters. For current behavior, use your client’s live tool list and responses.

Reading this reference

Permission is the primary required scope. Mutations can require additional permissions for a confirmed secondary effect, such as deleting a site's last attachment or cleaning up its Storage reference.

Each tool lists its top-level inputs. Open the JSON schema for nested structures, enums and exact constraints. Template content is validated by the backend's template parser beyond the generic tool schema.

See transaction confirmations and resource restrictions for those workflows.

Access & wallet

`auth.policy`

Return public MCP auth flows, scopes, safety controls, retention, and confirmation rules.

Permission: publiclocal read

No input parameters.

JSON input schema

json

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`auth.status`

Return whether this MCP session is authenticated.

Permission: publiclocal read

No input parameters.

JSON input schema

json

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`mcp.access.list`

List MCP consents and redacted active sessions for the authenticated owner wallet.

Permission: mcp:readremote read

No input parameters.

JSON input schema

json

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`mcp.access.revoke_consent`

Revoke one MCP consent by id and invalidate matching access/refresh tokens.

Permission: mcp:revokedestructive

Input	Type	Required
`consentId`	`string`	Yes
`confirmConsentId`	`string`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "consentId": {
      "type": "string",
      "minLength": 1
    },
    "confirmConsentId": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "consentId",
    "confirmConsentId"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`mcp.audit.list`

List recent redacted MCP audit events for the authenticated owner wallet.

Permission: mcp:readremote read

Input	Type	Required
`limit`	`integer`	No
`method`	`string`	No
`resultStatus`	`"success" \| "error"`	No
`since`	`string`	No

JSON input schema

json

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "method": {
      "type": "string",
      "minLength": 1
    },
    "resultStatus": {
      "type": "string",
      "enum": [
        "success",
        "error"
      ]
    },
    "since": {
      "type": "string",
      "minLength": 1
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`mcp.audit.summary`

Return owner-scoped aggregate MCP audit metrics without raw headers or request bodies.

Permission: mcp:readremote read

Input	Type	Required
`windowHours`	`integer`	No
`topMethodsLimit`	`integer`	No

JSON input schema

json

{
  "type": "object",
  "properties": {
    "windowHours": {
      "type": "integer",
      "minimum": 1,
      "maximum": 720
    },
    "topMethodsLimit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`wallet.me`

Return the authenticated MCP owner/actor wallet context.

Permission: wallet:readremote read

No input parameters.

JSON input schema

json

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Sites & deployments

`deployments.list`

List retained deployments across the owner's sites.

Permission: deployments:readremote read

No input parameters.

JSON input schema

json

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`media.upload_image`

Upload one PNG, JPEG, GIF, or WebP image to the authenticated owner's template media store.

Permission: media:writewrite

Input	Type	Required
`contentBase64`	`string`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "contentBase64": {
      "type": "string",
      "minLength": 4,
      "maxLength": 11184812
    }
  },
  "required": [
    "contentBase64"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`sites.attach_domain`

Attach an already DNS-linked domain after preflight. Confirm site and full domain exactly. Pass the reviewed expectedConflictSiteId when moving a domain; deleting its source site additionally requires confirmDeleteSourceSiteId and sites:delete. All affected sites must be owned and delegated. Does not sign or change DNS records.

Permission: sites:writedestructive

Input	Type	Required
`site`	`string`	Yes
`domain`	`string`	Yes
`confirmSite`	`string`	Yes
`confirmDomain`	`string`	Yes
`expectedConflictSiteId`	`integer \| null`	No
`confirmDeleteSourceSiteId`	`integer`	No

JSON input schema

json

{
  "type": "object",
  "properties": {
    "site": {
      "type": "string",
      "minLength": 1
    },
    "domain": {
      "type": "string",
      "minLength": 1
    },
    "confirmSite": {
      "type": "string",
      "minLength": 1
    },
    "confirmDomain": {
      "type": "string",
      "minLength": 1
    },
    "expectedConflictSiteId": {
      "anyOf": [
        {
          "type": "integer",
          "exclusiveMinimum": 0,
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        {
          "type": "null"
        }
      ]
    },
    "confirmDeleteSourceSiteId": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "site",
    "domain",
    "confirmSite",
    "confirmDomain"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`sites.delete`

Delete an owned TON Site deployment and served files.

Permission: sites:deletedestructive

Input	Type	Required
`site`	`string`	Yes
`confirmSite`	`string`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "site": {
      "type": "string",
      "minLength": 1
    },
    "confirmSite": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "site",
    "confirmSite"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`sites.get_content`

Read the stored template/content metadata for an owned site.

Permission: sites:readremote read

Input	Type	Required
`site`	`string`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "site": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "site"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`sites.list`

List TON Sites owned by the authorized wallet.

Permission: sites:readremote read

No input parameters.

JSON input schema

json

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`sites.list_domains`

List the domains and current DNS status of an owned site. Accepts a site name or stable site ID and enforces site/domain delegation limits.

Permission: sites:readremote read

Input	Type	Required
`site`	`string`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "site": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "site"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`sites.list_releases`

List retained releases for an owned site.

Permission: sites:readremote read

Input	Type	Required
`site`	`string`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "site": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "site"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`sites.preflight_domain`

Read current ownership, DNS linkage and conflicts before attaching a .ton, .t.me or supported subdomain to an owned site. No mapping or DNS record is changed.

Permission: sites:readremote read

Input	Type	Required
`site`	`string`	Yes
`domain`	`string`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "site": {
      "type": "string",
      "minLength": 1
    },
    "domain": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "site",
    "domain"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`sites.publish_files`

Deploy or update an owned TON Site from explicit file contents.

Permission: sites:writedestructive

Input	Type	Required
`site`	`string`	Yes
`files`	`object[]`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "site": {
      "type": "string",
      "minLength": 1
    },
    "files": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "minLength": 1
          },
          "text": {
            "type": "string"
          },
          "contentBase64": {
            "type": "string"
          }
        },
        "required": [
          "path"
        ],
        "additionalProperties": false
      },
      "minItems": 1
    }
  },
  "required": [
    "site",
    "files"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`sites.publish_template`

Validate, render, and publish a template-based TON Site.

Permission: sites:writedestructive

Input	Type	Required
`site`	`string`	Yes
`template`	`string`	Yes
`content`	`JSON value`	No

JSON input schema

json

{
  "type": "object",
  "properties": {
    "site": {
      "type": "string",
      "minLength": 1
    },
    "template": {
      "type": "string",
      "minLength": 1
    },
    "content": {}
  },
  "required": [
    "site",
    "template"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`sites.rollback`

Rollback an owned TON Site to a retained release.

Permission: sites:rollbackdestructive

Input	Type	Required
`site`	`string`	Yes
`releaseId`	`string`	Yes
`confirmSite`	`string`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "site": {
      "type": "string",
      "minLength": 1
    },
    "releaseId": {
      "type": "string",
      "minLength": 1
    },
    "confirmSite": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "site",
    "releaseId",
    "confirmSite"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`sites.send_link_tx`

Validate indexed ownership and return one HTTPS page where the user reviews and confirms the exact TON DNS site transaction with TON Connect.

Permission: transactions:requestwrite

Input	Type	Required
`site`	`string`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "site": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "site"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`sites.unlink_domain`

Detach a domain after its DNS site record no longer points to this site (or it changed owner). Confirm site and full domain exactly. Removing the last domain deletes the site and requires confirmDeleteSite plus sites:delete; cleanup of a Storage-hosted site also requires storage:delete and bag delegation. Does not sign or change DNS records.

Permission: sites:writedestructive

Input	Type	Required
`site`	`string`	Yes
`domain`	`string`	Yes
`confirmSite`	`string`	Yes
`confirmDomain`	`string`	Yes
`confirmDeleteSite`	`boolean`	No

JSON input schema

json

{
  "type": "object",
  "properties": {
    "site": {
      "type": "string",
      "minLength": 1
    },
    "domain": {
      "type": "string",
      "minLength": 1
    },
    "confirmSite": {
      "type": "string",
      "minLength": 1
    },
    "confirmDomain": {
      "type": "string",
      "minLength": 1
    },
    "confirmDeleteSite": {
      "type": "boolean"
    }
  },
  "required": [
    "site",
    "domain",
    "confirmSite",
    "confirmDomain"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

DNS & Usernames

`dns.lookup`

Lookup public TON DNS status and records for a .ton name.

Permission: dns:readremote read

Input	Type	Required
`name`	`string`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`dns.send_name_tx`

Return one HTTPS page for a validated .ton mint, auction bid, or expired-name release transaction.

Permission: transactions:requestwrite

Input	Type	Required
`domain`	`string`	Yes
`action`	`"mint" \| "bid" \| "release"`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "minLength": 1
    },
    "action": {
      "type": "string",
      "enum": [
        "mint",
        "bid",
        "release"
      ]
    }
  },
  "required": [
    "domain",
    "action"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`dns.send_record_tx`

Revalidate indexed ownership and return one HTTPS page where the user reviews and confirms the exact TON DNS record transaction.

Permission: transactions:requestwrite

Input	Type	Required
`domain`	`string`	Yes
`kind`	`"wallet" \| "site" \| "storage" \| "resolver" \| "text" \| "adnl" \| "other"`	Yes
`valueKind`	`"wallet" \| "site" \| "storage" \| "resolver" \| "text" \| "adnl" \| "other"`	No
`value`	`string \| null`	No
`rawCategory`	`string`	No
`keyName`	`string`	No

JSON input schema

json

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "minLength": 1
    },
    "kind": {
      "type": "string",
      "enum": [
        "wallet",
        "site",
        "storage",
        "resolver",
        "text",
        "adnl",
        "other"
      ]
    },
    "valueKind": {
      "type": "string",
      "enum": [
        "wallet",
        "site",
        "storage",
        "resolver",
        "text",
        "adnl",
        "other"
      ]
    },
    "value": {
      "type": [
        "string",
        "null"
      ]
    },
    "rawCategory": {
      "type": "string"
    },
    "keyName": {
      "type": "string"
    }
  },
  "required": [
    "domain",
    "kind"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`dns.send_renew_tx`

Revalidate one to four owned .ton names and return one HTTPS page for a single TON Connect multi-message confirmation.

Permission: transactions:requestwrite

Input	Type	Required
`domains`	`string[]`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "domains": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "minItems": 1,
      "maxItems": 4
    }
  },
  "required": [
    "domains"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`dns.send_transfer_tx`

Revalidate ownership of a root .ton name or .t.me Username and return one HTTPS page to confirm its NFT transfer to newOwner. The user signs in their wallet.

Permission: transactions:requestdestructive

Input	Type	Required
`domain`	`string`	Yes
`newOwner`	`string`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "minLength": 1
    },
    "newOwner": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "domain",
    "newOwner"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`domains.list`

List .ton domains owned by the authorized wallet.

Permission: dns:readremote read

No input parameters.

JSON input schema

json

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`domains.list_usernames`

List .t.me Telegram Usernames owned by the authorized wallet, filtered by its domain delegation.

Permission: dns:readremote read

No input parameters.

JSON input schema

json

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`domains.records`

Read DNS records for an owned .ton domain or .t.me Telegram Username.

Permission: dns:readremote read

Input	Type	Required
`domain`	`string`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "domain"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Subdomains

`subdomains.collection_action_tx`

Revalidate current collection or parent rights and return one HTTPS management transaction confirmation page.

Permission: transactions:requestdestructive

Input	Type	Required
`collectionAddress`	`string`	Yes
`action`	`"withdraw_fees" \| "set_access" \| "set_allowlist" \| "set_label_reserved" \| "transfer_admin" \| "link_resolver" \| "unlink_resolver" \| "enforce_resolver" \| "fill_parent" \| "claim" \| "claim_revenue" \| "convert_locked" \| "retry_parent_return"`	Yes
`accessMode`	`"public" \| "allowlist" \| "admin_only"`	No
`wallet`	`string`	No
`allowed`	`boolean`	No
`label`	`string`	No
`reserved`	`boolean`	No
`newAdmin`	`string`	No

JSON input schema

json

{
  "type": "object",
  "properties": {
    "collectionAddress": {
      "type": "string",
      "minLength": 1
    },
    "action": {
      "type": "string",
      "enum": [
        "withdraw_fees",
        "set_access",
        "set_allowlist",
        "set_label_reserved",
        "transfer_admin",
        "link_resolver",
        "unlink_resolver",
        "enforce_resolver",
        "fill_parent",
        "claim",
        "claim_revenue",
        "convert_locked",
        "retry_parent_return"
      ]
    },
    "accessMode": {
      "type": "string",
      "enum": [
        "public",
        "allowlist",
        "admin_only"
      ]
    },
    "wallet": {
      "type": "string"
    },
    "allowed": {
      "type": "boolean"
    },
    "label": {
      "type": "string"
    },
    "reserved": {
      "type": "boolean"
    },
    "newAdmin": {
      "type": "string"
    }
  },
  "required": [
    "collectionAddress",
    "action"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`subdomains.control`

Read fresh collection authorization and parent-return state for the authenticated wallet.

Permission: subdomains:readremote read

Input	Type	Required
`collectionAddress`	`string`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "collectionAddress": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "collectionAddress"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`subdomains.create_collection_tx`

Revalidate parent ownership, create collection metadata, and return one HTTPS transaction confirmation page.

Permission: transactions:requestwrite

Input	Type	Required
`parentAddress`	`string`	Yes
`mode`	`"locked" \| "linked"`	Yes
`priceGrid`	`string[]`	Yes
`minChars`	`integer`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "parentAddress": {
      "type": "string",
      "minLength": 1
    },
    "mode": {
      "type": "string",
      "enum": [
        "locked",
        "linked"
      ]
    },
    "priceGrid": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^\\d+$"
      },
      "minItems": 11,
      "maxItems": 11
    },
    "minChars": {
      "type": "integer",
      "minimum": 1,
      "maximum": 4
    }
  },
  "required": [
    "parentAddress",
    "mode",
    "priceGrid",
    "minChars"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`subdomains.get_collection`

Read a fresh collection snapshot when the authenticated wallet holds collection or parent rights.

Permission: subdomains:readremote read

Input	Type	Required
`collectionAddress`	`string`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "collectionAddress": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "collectionAddress"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`subdomains.get_item`

Read a Subdomain NFT item owned by the authenticated wallet.

Permission: subdomains:readremote read

Input	Type	Required
`itemAddress`	`string`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "itemAddress": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "itemAddress"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`subdomains.list_collections`

List TON Subdomain collections controlled by the authenticated wallet.

Permission: subdomains:readremote read

Input	Type	Required
`limit`	`integer`	No
`cursor`	`string`	No

JSON input schema

json

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "cursor": {
      "type": "string",
      "minLength": 1
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`subdomains.list_items`

List TON Subdomain NFT items owned by the authenticated wallet.

Permission: subdomains:readremote read

Input	Type	Required
`limit`	`integer`	No
`cursor`	`string`	No

JSON input schema

json

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "cursor": {
      "type": "string",
      "minLength": 1
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`subdomains.mint_tx`

Revalidate availability and access, build metadata, and return one HTTPS mint or pending-mint confirmation page.

Permission: transactions:requestwrite

Input	Type	Required
`collectionAddress`	`string`	Yes
`parent`	`string`	Yes
`label`	`string`	Yes
`setWalletToMinter`	`boolean`	No

JSON input schema

json

{
  "type": "object",
  "properties": {
    "collectionAddress": {
      "type": "string",
      "minLength": 1
    },
    "parent": {
      "type": "string",
      "minLength": 1
    },
    "label": {
      "type": "string",
      "minLength": 1
    },
    "setWalletToMinter": {
      "type": "boolean"
    }
  },
  "required": [
    "collectionAddress",
    "parent",
    "label"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`subdomains.recovery_tx`

Re-derive an owned collection and return one HTTPS page for its deployment or resolver recovery transaction.

Permission: transactions:requestwrite

Input	Type	Required
`parentAddress`	`string`	Yes
`mode`	`"locked" \| "linked"`	Yes
`action`	`"retry_deployment" \| "link_resolver" \| "enforce_resolver"`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "parentAddress": {
      "type": "string",
      "minLength": 1
    },
    "mode": {
      "type": "string",
      "enum": [
        "locked",
        "linked"
      ]
    },
    "action": {
      "type": "string",
      "enum": [
        "retry_deployment",
        "link_resolver",
        "enforce_resolver"
      ]
    }
  },
  "required": [
    "parentAddress",
    "mode",
    "action"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`subdomains.transfer_item_tx`

Revalidate current NFT ownership and return one HTTPS Subdomain item transfer confirmation page.

Permission: transactions:requestdestructive

Input	Type	Required
`itemAddress`	`string`	Yes
`newOwner`	`string`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "itemAddress": {
      "type": "string",
      "minLength": 1
    },
    "newOwner": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "itemAddress",
    "newOwner"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

TON Storage

`storage.bag_details`

Read metadata and live state for an owned TON Storage bag.

Permission: storage:readremote read

Input	Type	Required
`bagId`	`string`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "bagId": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "bagId"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`storage.create_bag`

Create and seed a new TON Storage bag from explicit file contents.

Permission: storage:writewrite

Input	Type	Required
`name`	`string`	No
`files`	`object[]`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "files": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "path": {
            "type": "string",
            "minLength": 1
          },
          "text": {
            "type": "string"
          },
          "contentBase64": {
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "minItems": 1
    }
  },
  "required": [
    "files"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`storage.delete_bag`

Delete an owned TON Storage bag reference and remove platform-seeded bytes when safe.

Permission: storage:deletedestructive

Input	Type	Required
`bagId`	`string`	Yes
`confirmBagId`	`string`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "bagId": {
      "type": "string",
      "minLength": 1
    },
    "confirmBagId": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "bagId",
    "confirmBagId"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`storage.list_bags`

List TON Storage bags owned by the authorized wallet.

Permission: storage:readremote read

No input parameters.

JSON input schema

json

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`storage.pin_bag`

Pin/import an existing public TON Storage bag by bag id.

Permission: storage:writewrite

Input	Type	Required
`bagId`	`string`	Yes
`name`	`string`	No

JSON input schema

json

{
  "type": "object",
  "properties": {
    "bagId": {
      "type": "string",
      "minLength": 1
    },
    "name": {
      "type": "string"
    }
  },
  "required": [
    "bagId"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`storage.provider_funding_preview`

Calculate exact integer funding and coverage from a live provider session.

Permission: storage:readremote read

Input	Type	Required
`bagId`	`string`	Yes
`sessionId`	`string`	Yes
`targetCoverageSeconds`	`integer \| null`	Yes
`proofSpanSeconds`	`integer`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "bagId": {
      "type": "string",
      "minLength": 1
    },
    "sessionId": {
      "type": "string",
      "minLength": 1
    },
    "targetCoverageSeconds": {
      "anyOf": [
        {
          "type": "integer",
          "exclusiveMinimum": 0
        },
        {
          "type": "null"
        }
      ]
    },
    "proofSpanSeconds": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "bagId",
    "sessionId",
    "targetCoverageSeconds",
    "proofSpanSeconds"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`storage.provider_funding_session`

Freeze a short-lived live provider and shared-balance snapshot for an owned bag.

Permission: storage:readremote read

Input	Type	Required
`bagId`	`string`	Yes
`providerPubkeys`	`string[]`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "bagId": {
      "type": "string",
      "minLength": 1
    },
    "providerPubkeys": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 64,
        "maxLength": 64
      },
      "minItems": 1
    }
  },
  "required": [
    "bagId",
    "providerPubkeys"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`storage.provider_operation`

Read and reconcile one paid TON Storage provider operation.

Permission: storage:readremote read

Input	Type	Required
`providerOperationId`	`string`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "providerOperationId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "providerOperationId"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`storage.provider_quote`

Create the signed backend quote that will be revalidated before a provider confirmation link is returned.

Permission: storage:readremote read

Input	Type	Required
`bagId`	`string`	Yes
`sessionId`	`string`	Yes
`targetCoverageSeconds`	`integer \| null`	Yes
`proofSpanSeconds`	`integer`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "bagId": {
      "type": "string",
      "minLength": 1
    },
    "sessionId": {
      "type": "string",
      "minLength": 1
    },
    "targetCoverageSeconds": {
      "anyOf": [
        {
          "type": "integer",
          "exclusiveMinimum": 0
        },
        {
          "type": "null"
        }
      ]
    },
    "proofSpanSeconds": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "bagId",
    "sessionId",
    "targetCoverageSeconds",
    "proofSpanSeconds"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`storage.providers`

List backend-verified providers compatible with an owned TON Storage bag.

Permission: storage:readremote read

Input	Type	Required
`bagId`	`string`	Yes
`sort`	`"recommended" \| "cheapest" \| "uptime" \| "capacity"`	No

JSON input schema

json

{
  "type": "object",
  "properties": {
    "bagId": {
      "type": "string",
      "minLength": 1
    },
    "sort": {
      "type": "string",
      "enum": [
        "recommended",
        "cheapest",
        "uptime",
        "capacity"
      ]
    }
  },
  "required": [
    "bagId"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`storage.send_bag_link_tx`

Validate bag and domain ownership, then return one HTTPS page for the exact TON Storage DNS site transaction.

Permission: transactions:requestwrite

Input	Type	Required
`bagId`	`string`	Yes
`domain`	`string`	Yes

JSON input schema

json

{
  "type": "object",
  "properties": {
    "bagId": {
      "type": "string",
      "minLength": 1
    },
    "domain": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "bagId",
    "domain"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

`storage.send_provider_tx`

Revalidate the live contract, providers, shared balance, and exact amount before returning one HTTPS pin, top-up, stop, or withdraw confirmation page.

Permission: transactions:requestdestructive

Input	Type	Required
`action`	`"pin" \| "top_up" \| "stop" \| "withdraw"`	Yes
`bagId`	`string`	Yes
`quoteId`	`string`	No
`targetCoverageSeconds`	`integer`	No
`providerPubkey`	`string`	No
`acknowledgeOtherProviders`	`boolean`	No

JSON input schema

json

{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "enum": [
        "pin",
        "top_up",
        "stop",
        "withdraw"
      ]
    },
    "bagId": {
      "type": "string",
      "minLength": 1
    },
    "quoteId": {
      "type": "string",
      "minLength": 1
    },
    "targetCoverageSeconds": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "providerPubkey": {
      "type": "string",
      "minLength": 64,
      "maxLength": 64
    },
    "acknowledgeOtherProviders": {
      "type": "boolean"
    }
  },
  "required": [
    "action",
    "bagId"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}