Deploy, pay for and manage apps on Flux Cloud, the decentralized cloud. Prices in USD.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Turns images, ports, resources and a term into a complete, correctly formatted v8 specification, with public ports auto-picked and data replication enabled. Returns the spec plus local validation errors and warnings.
Unique app name: letters, digits, inner hyphens. Not starting with "flux" or "zel".
Flux ID that will own the app. Defaults to the configured or passed key.
Term in network months (88000 blocks each). Default 1.
Copies on distinct nodes. Default 3.
Exact term in blocks; overrides months.
WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key.
WIF private key of the Flux address that pays. Fund it with only what you intend to spend.
Turns images, ports, resources and a term into a complete, correctly formatted v8 specification, with public ports auto-picked and data replication enabled. Returns the spec plus local validation errors and warnings.
| Argument | Type | Description |
|---|---|---|
| name* | string | Unique app name: letters, digits, inner hyphens. Not starting with "flux" or "zel". |
| nodes | array | |
| owner | string | Flux ID that will own the app. Defaults to the configured or passed key. |
| months | number | Term in network months (88000 blocks each). Default 1. |
| contacts | array | |
| staticip | boolean | |
| instances | integer | Copies on distinct nodes. Default 3. |
| components* | array | |
| description | string | |
| geolocation | array | |
| expireBlocks | integer | Exact term in blocks; overrides months. |
| fluxIdPrivateKey | string | WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key. |
| paymentPrivateKey | string | WIF private key of the Flux address that pays. Fund it with only what you intend to spend. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"components"
],
"properties": {
"name": {
"type": "string",
"maxLength": 63,
"minLength": 1,
"description": "Unique app name: letters, digits, inner hyphens. Not starting with \"flux\" or \"zel\"."
},
"nodes": {
"type": "array",
"items": {
"type": "string"
}
},
"owner": {
"type": "string",
"description": "Flux ID that will own the app. Defaults to the configured or passed key."
},
"months": {
"type": "number",
"maximum": 12,
"description": "Term in network months (88000 blocks each). Default 1.",
"exclusiveMinimum": 0
},
"contacts": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 5
},
"staticip": {
"type": "boolean"
},
"instances": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Copies on distinct nodes. Default 3."
},
"components": {
"type": "array",
"items": {
"type": "object",
"required": [
"image",
"cpu",
"ram",
"hdd"
],
"properties": {
"cpu": {
"type": "number",
"description": "Cores, 0.1 to 15 in 0.1 steps."
},
"env": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"hdd": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "GB."
},
"ram": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "MB, multiple of 100."
},
"name": {
"type": "string",
"maxLength": 63
},
"image": {
"type": "string",
"description": "Docker image with an explicit tag."
},
"ports": {
"type": "array",
"items": {
"type": "object",
"required": [
"containerPort"
],
"properties": {
"port": {
"type": "integer",
"maximum": 65535,
"minimum": 1,
"description": "Public port; auto-picked from 31000-39999 when omitted."
},
"domain": {
"type": "string"
},
"containerPort": {
"type": "integer",
"maximum": 65535,
"minimum": 1
}
}
}
},
"commands": {
"type": "array",
"items": {
"type": "string"
}
},
"dataPath": {
"type": "string",
"description": "Path inside the container to persist. Default \"/data\"."
},
"repoauth": {
"type": "string"
},
"description": {
"type": "string",
"maxLength": 256
},
"replicateData": {
"type": "boolean",
"description": "Replicate the data path across instances. Default true."
}
}
},
"maxItems": 10,
"minItems": 1
},
"description": {
"type": "string",
"maxLength": 256
},
"geolocation": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 10
},
"expireBlocks": {
"type": "integer",
"maximum": 1056000,
"minimum": 1,
"description": "Exact term in blocks; overrides months."
},
"fluxIdPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key."
},
"paymentPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux address that pays. Fund it with only what you intend to spend."
}
}
}Ends an app early by updating its term so it expires within about an hour. The network then uninstalls it everywhere. With confirm=true this signs and pays the (usually minimal) update; without it, returns the plan.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| confirm | boolean | |
| fluxIdPrivateKey | string | WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key. |
| paymentPrivateKey | string | WIF private key of the Flux address that pays. Fund it with only what you intend to spend. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"confirm": {
"type": "boolean",
"default": false
},
"fluxIdPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key."
},
"paymentPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux address that pays. Fund it with only what you intend to spend."
}
}
}restart: restarts containers. redeploy: pulls the image again and recreates containers (hard=true also wipes data). remove: uninstalls from nodes; the registration stays and the network re-spawns it elsewhere, so use flux_cancel_app to stop paying. Scope is one node (nodeIp) or every node running the app (global). Requires the owner key.
| Argument | Type | Description |
|---|---|---|
| hard | boolean | For redeploy: also delete the app data. |
| name* | string | |
| scope | string | |
| action* | string | |
| nodeIp | string | Required for scope=node; also the node the global command is sent through. |
| fluxIdPrivateKey | string | WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key. |
| paymentPrivateKey | string | WIF private key of the Flux address that pays. Fund it with only what you intend to spend. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"action"
],
"properties": {
"hard": {
"type": "boolean",
"default": false,
"description": "For redeploy: also delete the app data."
},
"name": {
"type": "string"
},
"scope": {
"enum": [
"node",
"global"
],
"type": "string",
"default": "global"
},
"action": {
"enum": [
"restart",
"redeploy",
"remove"
],
"type": "string"
},
"nodeIp": {
"type": "string",
"description": "Required for scope=node; also the node the global command is sent through."
},
"fluxIdPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key."
},
"paymentPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux address that pays. Fund it with only what you intend to spend."
}
}
}Validates the specification on a node, quotes it, and with confirm=true signs it with the Flux ID, broadcasts it and pays the quoted FLUX from the payment address. Without confirm it only returns the plan (price, balance, warnings) and spends nothing. Registers a new name or updates an existing app of the same owner. Then call flux_wait_for_app with the returned txid.
| Argument | Type | Description |
|---|---|---|
| spec* | object | |
| confirm | boolean | Set true to actually sign, broadcast and pay. |
| enterprise | object | Make the app private: these components and contacts are encrypted so only the nodes running the app can read them. When set, spec.compose should be [] and spec.enterprise "". |
| fluxIdPrivateKey | string | WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key. |
| paymentPrivateKey | string | WIF private key of the Flux address that pays. Fund it with only what you intend to spend. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"spec"
],
"properties": {
"spec": {
"type": "object",
"required": [
"name",
"description",
"compose"
],
"properties": {
"name": {
"type": "string",
"maxLength": 63,
"minLength": 1
},
"nodes": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"owner": {
"type": "string",
"description": "Flux ID. Defaults to the configured FLUX_ID_PRIVATE_KEY identity."
},
"expire": {
"type": "integer",
"default": 88000,
"maximum": 1056000,
"minimum": 1,
"description": "Term in blocks; 88000 = 1 month."
},
"compose": {
"type": "array",
"items": {
"type": "object",
"required": [
"repotag",
"containerData",
"cpu",
"ram",
"hdd"
],
"properties": {
"cpu": {
"type": "number",
"description": "Cores, 0.1 to 15 in 0.1 steps."
},
"hdd": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "GB, 1 to 820."
},
"ram": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "MB, 100 to 59000 in steps of 100."
},
"name": {
"type": "string",
"maxLength": 63,
"description": "Component name. Defaults to the app name."
},
"ports": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"default": [],
"description": "Public ports. Prefer 31000-39999."
},
"domains": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Custom domain per port, \"\" for none. Parallel to ports."
},
"repotag": {
"type": "string",
"description": "Docker image with an explicit tag, e.g. \"nginx:1.27-alpine\"."
},
"commands": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Container Cmd, max 20 strings."
},
"repoauth": {
"type": "string",
"default": "",
"description": "\"user:token\" for a private registry, else \"\"."
},
"description": {
"type": "string",
"maxLength": 256
},
"containerData": {
"type": "string",
"description": "Persisted path, e.g. \"r:/data\" (r: = replicated across instances)."
},
"containerPorts": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"default": [],
"description": "Ports the container listens on, parallel to ports."
},
"environmentParameters": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "\"KEY=value\" strings, max 20."
}
}
},
"maxItems": 10,
"minItems": 0
},
"version": {
"type": "number",
"const": 8,
"default": 8
},
"contacts": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"staticip": {
"type": "boolean",
"default": false
},
"instances": {
"type": "integer",
"default": 3,
"maximum": 100,
"minimum": 1
},
"enterprise": {
"type": "string",
"default": ""
},
"description": {
"type": "string",
"maxLength": 256,
"minLength": 1
},
"geolocation": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "e.g. [\"acEU\"] allow Europe, [\"a!cAS\"] deny Asia."
}
}
},
"confirm": {
"type": "boolean",
"default": false,
"description": "Set true to actually sign, broadcast and pay."
},
"enterprise": {
"type": "object",
"required": [
"compose"
],
"properties": {
"compose": {
"type": "array",
"items": {
"type": "object",
"required": [
"repotag",
"containerData",
"cpu",
"ram",
"hdd"
],
"properties": {
"cpu": {
"type": "number",
"description": "Cores, 0.1 to 15 in 0.1 steps."
},
"hdd": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "GB, 1 to 820."
},
"ram": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "MB, 100 to 59000 in steps of 100."
},
"name": {
"type": "string",
"maxLength": 63,
"description": "Component name. Defaults to the app name."
},
"ports": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"default": [],
"description": "Public ports. Prefer 31000-39999."
},
"domains": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Custom domain per port, \"\" for none. Parallel to ports."
},
"repotag": {
"type": "string",
"description": "Docker image with an explicit tag, e.g. \"nginx:1.27-alpine\"."
},
"commands": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Container Cmd, max 20 strings."
},
"repoauth": {
"type": "string",
"default": "",
"description": "\"user:token\" for a private registry, else \"\"."
},
"description": {
"type": "string",
"maxLength": 256
},
"containerData": {
"type": "string",
"description": "Persisted path, e.g. \"r:/data\" (r: = replicated across instances)."
},
"containerPorts": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"default": [],
"description": "Ports the container listens on, parallel to ports."
},
"environmentParameters": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "\"KEY=value\" strings, max 20."
}
}
},
"maxItems": 10,
"minItems": 1
},
"contacts": {
"type": "array",
"items": {
"type": "string"
},
"default": []
}
},
"description": "Make the app private: these components and contacts are encrypted so only the nodes running the app can read them. When set, spec.compose should be [] and spec.enterprise \"\"."
},
"fluxIdPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key."
},
"paymentPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux address that pays. Fund it with only what you intend to spend."
}
}
}Creates two fresh private keys (WIF): one for the Flux ID that will own apps, one for the address that pays. The response contains the secrets; store them in the MCP server environment as FLUX_ID_PRIVATE_KEY and FLUX_PAYMENT_PRIVATE_KEY, then restart the server. Nothing is stored or sent anywhere by this tool.
| Argument | Type | Description |
|---|---|---|
| fluxIdPrivateKey | string | WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key. |
| paymentPrivateKey | string | WIF private key of the Flux address that pays. Fund it with only what you intend to spend. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"fluxIdPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key."
},
"paymentPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux address that pays. Fund it with only what you intend to spend."
}
}
}Looks up any app on the network by name and returns its published specification, expiry, running instances, URLs and a reachability check: probes the shared domain (HTTP) and each instance port (TCP and HTTP) and explains what a 503 means, including when it is expected for non-web apps.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| ports | array | Ports to probe on instances; needed for private apps whose ports are encrypted. |
| fluxIdPrivateKey | string | WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key. |
| paymentPrivateKey | string | WIF private key of the Flux address that pays. Fund it with only what you intend to spend. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"ports": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"description": "Ports to probe on instances; needed for private apps whose ports are encrypted."
},
"fluxIdPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key."
},
"paymentPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux address that pays. Fund it with only what you intend to spend."
}
}
}Fetches the last N log lines of an app from one of the nodes running it. Requires the owner key. The component is picked automatically when the app has one (private apps are decrypted with the owner key); otherwise the available names are listed.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| lines | integer | |
| nodeIp | string | ip[:port] of the instance; defaults to the first running one. |
| component | string | Component name for multi-component apps. |
| fluxIdPrivateKey | string | WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key. |
| paymentPrivateKey | string | WIF private key of the Flux address that pays. Fund it with only what you intend to spend. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"lines": {
"type": "integer",
"default": 200,
"maximum": 2000,
"minimum": 1
},
"nodeIp": {
"type": "string",
"description": "ip[:port] of the instance; defaults to the first running one."
},
"component": {
"type": "string",
"description": "Component name for multi-component apps."
},
"fluxIdPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key."
},
"paymentPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux address that pays. Fund it with only what you intend to spend."
}
}
}CPU, memory and network stats of the containers of an app on one node. Requires the owner key.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| nodeIp | string | |
| component | string | Component name for multi-component apps. |
| fluxIdPrivateKey | string | WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key. |
| paymentPrivateKey | string | WIF private key of the Flux address that pays. Fund it with only what you intend to spend. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"nodeIp": {
"type": "string"
},
"component": {
"type": "string",
"description": "Component name for multi-component apps."
},
"fluxIdPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key."
},
"paymentPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux address that pays. Fund it with only what you intend to spend."
}
}
}Returns the Flux ID (app owner address), the payment address and its spendable FLUX balance with its USD value. Explains what to configure if keys are missing. Never returns private keys.
| Argument | Type | Description |
|---|---|---|
| fluxIdPrivateKey | string | WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key. |
| paymentPrivateKey | string | WIF private key of the Flux address that pays. Fund it with only what you intend to spend. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"fluxIdPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key."
},
"paymentPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux address that pays. Fund it with only what you intend to spend."
}
}
}Node counts by tier, current block height, FLUX/USD rate and the deployment payment address.
| Argument | Type | Description |
|---|---|---|
| fluxIdPrivateKey | string | WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key. |
| paymentPrivateKey | string | WIF private key of the Flux address that pays. Fund it with only what you intend to spend. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"fluxIdPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key."
},
"paymentPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux address that pays. Fund it with only what you intend to spend."
}
}
}Returns the current USD rate card, the live FLUX/USD rate, the pay-in-FLUX discount and instant USD estimates for a few reference sizes. Use flux_quote_app for the exact price of a specific app.
| Argument | Type | Description |
|---|---|---|
| fluxIdPrivateKey | string | WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key. |
| paymentPrivateKey | string | WIF private key of the Flux address that pays. Fund it with only what you intend to spend. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"fluxIdPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key."
},
"paymentPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux address that pays. Fund it with only what you intend to spend."
}
}
}Lists every app registered by the owner (or a given Flux ID) with expiry and instance counts.
| Argument | Type | Description |
|---|---|---|
| owner | string | Flux ID to list; defaults to the configured one. |
| nameContains | string | Only apps whose name contains this text. |
| fluxIdPrivateKey | string | WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key. |
| paymentPrivateKey | string | WIF private key of the Flux address that pays. Fund it with only what you intend to spend. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"owner": {
"type": "string",
"description": "Flux ID to list; defaults to the configured one."
},
"nameContains": {
"type": "string",
"description": "Only apps whose name contains this text."
},
"fluxIdPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key."
},
"paymentPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux address that pays. Fund it with only what you intend to spend."
}
}
}Returns the Flux Cloud price for registering the given specification, or for updating it if an app of that name already exists (the unused part of the current term is credited). Price is in USD with the FLUX amount at market rate.
| Argument | Type | Description |
|---|---|---|
| spec* | object | |
| fluxIdPrivateKey | string | WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key. |
| paymentPrivateKey | string | WIF private key of the Flux address that pays. Fund it with only what you intend to spend. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"spec"
],
"properties": {
"spec": {
"type": "object",
"required": [
"name",
"description",
"compose"
],
"properties": {
"name": {
"type": "string",
"maxLength": 63,
"minLength": 1
},
"nodes": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"owner": {
"type": "string",
"description": "Flux ID. Defaults to the configured FLUX_ID_PRIVATE_KEY identity."
},
"expire": {
"type": "integer",
"default": 88000,
"maximum": 1056000,
"minimum": 1,
"description": "Term in blocks; 88000 = 1 month."
},
"compose": {
"type": "array",
"items": {
"type": "object",
"required": [
"repotag",
"containerData",
"cpu",
"ram",
"hdd"
],
"properties": {
"cpu": {
"type": "number",
"description": "Cores, 0.1 to 15 in 0.1 steps."
},
"hdd": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "GB, 1 to 820."
},
"ram": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "MB, 100 to 59000 in steps of 100."
},
"name": {
"type": "string",
"maxLength": 63,
"description": "Component name. Defaults to the app name."
},
"ports": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"default": [],
"description": "Public ports. Prefer 31000-39999."
},
"domains": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Custom domain per port, \"\" for none. Parallel to ports."
},
"repotag": {
"type": "string",
"description": "Docker image with an explicit tag, e.g. \"nginx:1.27-alpine\"."
},
"commands": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Container Cmd, max 20 strings."
},
"repoauth": {
"type": "string",
"default": "",
"description": "\"user:token\" for a private registry, else \"\"."
},
"description": {
"type": "string",
"maxLength": 256
},
"containerData": {
"type": "string",
"description": "Persisted path, e.g. \"r:/data\" (r: = replicated across instances)."
},
"containerPorts": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"default": [],
"description": "Ports the container listens on, parallel to ports."
},
"environmentParameters": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "\"KEY=value\" strings, max 20."
}
}
},
"maxItems": 10,
"minItems": 0
},
"version": {
"type": "number",
"const": 8,
"default": 8
},
"contacts": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"staticip": {
"type": "boolean",
"default": false
},
"instances": {
"type": "integer",
"default": 3,
"maximum": 100,
"minimum": 1
},
"enterprise": {
"type": "string",
"default": ""
},
"description": {
"type": "string",
"maxLength": 256,
"minLength": 1
},
"geolocation": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "e.g. [\"acEU\"] allow Europe, [\"a!cAS\"] deny Asia."
}
}
},
"fluxIdPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key."
},
"paymentPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux address that pays. Fund it with only what you intend to spend."
}
}
}Runs the local rule checks, then asks a FluxOS node to verify the specification exactly as it would at registration (image reachable, architecture, ports, name availability). Returns the node-formatted spec on success.
| Argument | Type | Description |
|---|---|---|
| spec* | object | |
| network | boolean | Also verify on a FluxOS node. |
| fluxIdPrivateKey | string | WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key. |
| paymentPrivateKey | string | WIF private key of the Flux address that pays. Fund it with only what you intend to spend. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"spec"
],
"properties": {
"spec": {
"type": "object",
"required": [
"name",
"description",
"compose"
],
"properties": {
"name": {
"type": "string",
"maxLength": 63,
"minLength": 1
},
"nodes": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"owner": {
"type": "string",
"description": "Flux ID. Defaults to the configured FLUX_ID_PRIVATE_KEY identity."
},
"expire": {
"type": "integer",
"default": 88000,
"maximum": 1056000,
"minimum": 1,
"description": "Term in blocks; 88000 = 1 month."
},
"compose": {
"type": "array",
"items": {
"type": "object",
"required": [
"repotag",
"containerData",
"cpu",
"ram",
"hdd"
],
"properties": {
"cpu": {
"type": "number",
"description": "Cores, 0.1 to 15 in 0.1 steps."
},
"hdd": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "GB, 1 to 820."
},
"ram": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "MB, 100 to 59000 in steps of 100."
},
"name": {
"type": "string",
"maxLength": 63,
"description": "Component name. Defaults to the app name."
},
"ports": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"default": [],
"description": "Public ports. Prefer 31000-39999."
},
"domains": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Custom domain per port, \"\" for none. Parallel to ports."
},
"repotag": {
"type": "string",
"description": "Docker image with an explicit tag, e.g. \"nginx:1.27-alpine\"."
},
"commands": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Container Cmd, max 20 strings."
},
"repoauth": {
"type": "string",
"default": "",
"description": "\"user:token\" for a private registry, else \"\"."
},
"description": {
"type": "string",
"maxLength": 256
},
"containerData": {
"type": "string",
"description": "Persisted path, e.g. \"r:/data\" (r: = replicated across instances)."
},
"containerPorts": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"default": [],
"description": "Ports the container listens on, parallel to ports."
},
"environmentParameters": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "\"KEY=value\" strings, max 20."
}
}
},
"maxItems": 10,
"minItems": 0
},
"version": {
"type": "number",
"const": 8,
"default": 8
},
"contacts": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"staticip": {
"type": "boolean",
"default": false
},
"instances": {
"type": "integer",
"default": 3,
"maximum": 100,
"minimum": 1
},
"enterprise": {
"type": "string",
"default": ""
},
"description": {
"type": "string",
"maxLength": 256,
"minLength": 1
},
"geolocation": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "e.g. [\"acEU\"] allow Europe, [\"a!cAS\"] deny Asia."
}
}
},
"network": {
"type": "boolean",
"default": true,
"description": "Also verify on a FluxOS node."
},
"fluxIdPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key."
},
"paymentPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux address that pays. Fund it with only what you intend to spend."
}
}
}Polls the network for up to timeoutSeconds (default 45 to fit hosts with a 60 s tool timeout, max 600). Returns payment confirmations, whether the spec was accepted, and the running instances with URLs. Safe to call repeatedly until done=true.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| txid | string | Payment txid from flux_deploy_app, to report confirmations. |
| previousHash | string | For updates: the hash of the previous spec, so acceptance means a new hash. |
| timeoutSeconds | integer | |
| fluxIdPrivateKey | string | WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key. |
| paymentPrivateKey | string | WIF private key of the Flux address that pays. Fund it with only what you intend to spend. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"txid": {
"type": "string",
"description": "Payment txid from flux_deploy_app, to report confirmations."
},
"previousHash": {
"type": "string",
"description": "For updates: the hash of the previous spec, so acceptance means a new hash."
},
"timeoutSeconds": {
"type": "integer",
"default": 45,
"maximum": 600,
"minimum": 10
},
"fluxIdPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux ID that owns the app. Use a dedicated key from flux_generate_keys, never a main wallet key."
},
"paymentPrivateKey": {
"type": "string",
"description": "WIF private key of the Flux address that pays. Fund it with only what you intend to spend."
}
}
}