list_plans

The published catalogue with live prices and which payment methods each plan accepts. Prices are never hardcoded; read them here.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "properties": {}
}

order_lease

Place an order. The trial plan is free and activates immediately; paid plans return payment details and stay pending until settled. No account or card is needed to order. A second trial for the same billing email is refused — order a paid plan instead, which needs no approval.

Parameters4

plan	string	required	Slug from list_plans.
organization_name	string	required
country	string	required	ISO 3166-1 alpha-2.
billing_email	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "plan": {
      "type": "string",
      "description": "Slug from list_plans."
    },
    "organization_name": {
      "type": "string"
    },
    "country": {
      "type": "string",
      "description": "ISO 3166-1 alpha-2."
    },
    "billing_email": {
      "type": "string"
    }
  },
  "required": [
    "plan",
    "organization_name",
    "country",
    "billing_email"
  ]
}

lease_status

Everything about one lease: whether it is active, which addresses it holds, its tunnels and when it renews.

Parameters1

access_token

string

required

Returned by order_lease. The only credential for a lease.

Raw schema

{
  "type": "object",
  "properties": {
    "access_token": {
      "type": "string",
      "description": "Returned by order_lease. The only credential for a lease."
    }
  },
  "required": [
    "access_token"
  ]
}

create_tunnel

Provision a peer and return its WireGuard configuration. Source routing sends only traffic from the leased address through us and leaves the machine's default route alone — but it is written with wg-quick PostUp rules, so it runs on Linux under wg-quick and nowhere else. A graphical or mobile client reads it, finds no routes to install and fails to connect without logging anything. Choose full tunnel for those: it works everywhere but sends all of the machine's traffic through us.

Parameters4

access_token	string	required	Returned by order_lease. The only credential for a lease.
routing_mode	string	optional	Defaults to source.
transport	string	optional	Defaults to wireguard. Use amneziawg where deep packet inspection blocks a plain WireGuard handshake; it needs an AmneziaWG client rather than wg-quick.
label	string	optional	For the customer's own reference.

Raw schema

{
  "type": "object",
  "properties": {
    "access_token": {
      "type": "string",
      "description": "Returned by order_lease. The only credential for a lease."
    },
    "routing_mode": {
      "type": "string",
      "enum": [
        "source",
        "full"
      ],
      "description": "Defaults to source."
    },
    "transport": {
      "type": "string",
      "enum": [
        "wireguard",
        "amneziawg"
      ],
      "description": "Defaults to wireguard. Use amneziawg where deep packet inspection blocks a plain WireGuard handshake; it needs an AmneziaWG client rather than wg-quick."
    },
    "label": {
      "type": "string",
      "description": "For the customer's own reference."
    }
  },
  "required": [
    "access_token"
  ]
}

revoke_tunnel

Retire a peer and hand its slot back to the plan's allowance. An agent that provisions a tunnel per short-lived worker and never revokes one exhausts the allowance and then cannot bring the next machine up. Revoking the peer that holds the public address stops inbound connections to it and cannot be undone by promoting another — only by bringing a new machine up.

Parameters2

access_token	string	required	Returned by order_lease. The only credential for a lease.
tunnel_id	integer	required	The id lease_status reports for the tunnel.

Raw schema

{
  "type": "object",
  "properties": {
    "access_token": {
      "type": "string",
      "description": "Returned by order_lease. The only credential for a lease."
    },
    "tunnel_id": {
      "type": "integer",
      "description": "The id lease_status reports for the tunnel."
    }
  },
  "required": [
    "access_token",
    "tunnel_id"
  ]
}

renew_lease

Raise an invoice for another term and keep the same addresses. This is how a trial becomes a paying customer: the address does not change, so whatever the customer's partner has already allowlisted goes on working. A trial cannot renew into itself, so name the plan to move to — called without one it returns the plans that can be moved to. Pressing it twice quotes the same reference rather than raising a second invoice.

Parameters2

access_token	string	required	Returned by order_lease. The only credential for a lease.
plan	string	optional	Slug from list_plans. Defaults to the plan the lease is already on; required to leave a trial.

Raw schema

{
  "type": "object",
  "properties": {
    "access_token": {
      "type": "string",
      "description": "Returned by order_lease. The only credential for a lease."
    },
    "plan": {
      "type": "string",
      "description": "Slug from list_plans. Defaults to the plan the lease is already on; required to leave a trial."
    }
  },
  "required": [
    "access_token"
  ]
}

set_autorenew

Stop this lease charging the customer's card again, or start it again. Only a card subscription can be stopped — USDT and bank transfers are payments the customer sends us, so there is nothing of ours to cancel. Stopping is not a cancellation: the lease runs to the end of the period already paid for, and the same call turns it back on.

Parameters2

access_token	string	required	Returned by order_lease. The only credential for a lease.
enabled	boolean	required	false stops the next charge, true resumes it.

Raw schema

{
  "type": "object",
  "properties": {
    "access_token": {
      "type": "string",
      "description": "Returned by order_lease. The only credential for a lease."
    },
    "enabled": {
      "type": "boolean",
      "description": "false stops the next charge, true resumes it."
    }
  },
  "required": [
    "access_token",
    "enabled"
  ]
}

set_reverse_dns

Publish a PTR record for an address on the lease. Live within a second; an empty hostname removes it.

Parameters3

access_token	string	required	Returned by order_lease. The only credential for a lease.
address	string	required
hostname	string	required	Empty removes the record.

Raw schema

{
  "type": "object",
  "properties": {
    "access_token": {
      "type": "string",
      "description": "Returned by order_lease. The only credential for a lease."
    },
    "address": {
      "type": "string"
    },
    "hostname": {
      "type": "string",
      "description": "Empty removes the record."
    }
  },
  "required": [
    "access_token",
    "address",
    "hostname"
  ]
}

AnchoredIP

🛠️ Key Features

🚀 Use Cases

⚠️ Limitations

list_plans

order_lease

lease_status

create_tunnel

revoke_tunnel

renew_lease

set_autorenew

set_reverse_dns

Install

Remote endpoint