API reference

IP Transit

Public IPv4 addresses and IPv6 prefixes leased to a workspace, every port of them carried over WireGuard (or GRE) to its own host or router, where its virtual machines use them natively. Ready-made configurations for MikroTik, pfSense, OPNsense and Windows.

The locations on sale, the workspace's IP Transit at each, and how it pays

GET/v1/orgs/{org}/transit

API token or dashboard session

The locations on sale, the workspace's IP Transit at each, and how it pays.

Path parameters

orgstringpathrequired
Organisation slug

Responses

200TransitOverview

Fields of TransitOverview

currencystringrequired
What prices are in: the currency of the plans.
locationsTransitLocation[]required
- available_ipv4integerrequired
- base_price_centsintegerrequired
  The cheapest month, one IPv4 address included: the cheapest tier's, or the location's own without tiers.
- citystring | null
- countrystring | null
  ISO code: DE.
- extra_ip_price_centsintegerrequired
  A month, for each IPv4 address beyond the first.
- idstringrequired
  The node, to order it with.
- ipv6booleanrequired
  Whether an IPv6 prefix comes with the order.
- max_ipsintegerrequired
  IPv4 addresses one subscription may have there, the first included.
- max_order_ipv4integerrequired
  IPv4 addresses one order can take: the fewer of max_ips and what is left.
- max_subscriptionsintegerrequired
  How many it may have there: each one is its own tunnel, for its own host.
- orderedbooleanrequired
  The workspace already has IP Transit there.
- port_speed_mbpsintegerrequired
  The machine's port, in Mbit/s.
- regionstring | null
  The region key: de-falkenstein.
- subscription_countintegerrequired
  How many live subscriptions the workspace has there.
- tiersTransitTierOffer[]required
  The speed tiers on sale, in order; empty when the location sells at its base price only.
  - enabledbooleanrequired
    On sale: a tier taken off sale stays with those on it.
  - iduuidrequired
  - namestringrequired
    100 Mbit/s, 1 Gbit/s.
  - notestringrequired
    What the operator says of it.
  - overage_tb_centsintegerrequired
    A TB beyond the allowance; 0 when it throttles instead.
  - price_centsinteger
- traffic_tbinteger | null
  Traffic included a month without tiers, in TB; null for unmetered.
next_charge_atdate-timerequired
When the next month is invoiced, in advance: the first of next month. An order pays until then, prorated.
paymentTransitPaymentrequired
How the workspace can pay for IP Transit.
- balance_centsintegerrequired
  The prepaid balance, which pays first.
- cardbooleanrequired
  A card on file, charged for what the balance does not cover.
- paymentsbooleanrequired
  Card payments are set up: without a card on file, Mollie's page.
- renewing_planbooleanrequired
  A paid plan that renews. IP Transit is paid ahead on invoices of its own, whatever the plan.
subscriptionsTransitSubscription[]required
- available_ipv4integerrequired
  IPv4 addresses left at the location.
- base_price_centsintegerrequired
  A month, the first IPv4 address included, at the price of the day its tier was chosen.
- bridgestringrequired
  The bridge the VMs go on, in bridge mode.
- cancels_atdate-time | null
  When a suspended subscription ends, its addresses released.
- citystring | null
- countrystring | null
- endpointstring | null
vat_notestringrequired
What invoices say of VAT, when there is something to say: reverse charge, out of scope.
vat_rate_bpintegerrequired
The VAT invoices add, in hundredths of a percent: 2000 is 20 %.

curl "https://api.infraflow.app/v1/orgs/acme/transit" \
  -H "Authorization: Bearer $INFRAFLOW_TOKEN"

Response · 200

{
  "currency": "string",
  "locations": [
    {
      "available_ipv4": 1,
      "base_price_cents": 1,
      "city": "string",
      "country": "string",
      "extra_ip_price_cents": 1,
      "id": "string",
      "ipv6": true,
      "max_ips": 1,
      "max_order_ipv4": 1,
      "max_subscriptions": 1,
      "ordered": true,
      "port_speed_mbps": 1,
      "region": "string",
      "subscription_count": 1,
      "tiers": [
        {
          "enabled": true,
          "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55",
          "name": "my-app",
          "note": "string",
          "overage_tb_cents": 1,
          "price_cents": 1,
          "speed_mbps": 1,
          "throttle_mbps": 1,
          "traffic_tb": 1
        }
      ],
      "traffic_tb": 1
    }
  ],
  "next_charge_at": "2026-01-15T09:30:00Z",
  "payment": {
    "balance_cents": 1,
    "card": true,
    "payments": true,
    "renewing_plan": true
  },
  "subscriptions": [
    {
      "available_ipv4": 1,
      "base_price_cents": 1,
      "bridge": "string",
      "cancels_at": "2026-01-15T09:30:00Z",
      "city": "string",
      "country": "string",
      "endpoint": "string",
      "extra_ip_price_cents": 1,
      "has_token": true,
      "health": {
        "broken_since": "2026-01-15T09:30:00Z",
        "checked_at": "2026-01-15T09:30:00Z",
        "issues": [
          {}
        ],
        "state": "ok",
        "traffic": "flows"
      },
      "hosts": [
        {
          "addresses": [],
          "bridge": "string",
          "has_token": true,
          "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55",
          "label": "string",
          "last_handshake_at": "2026-01-15T09:30:00Z",
          "mode": "string",
          "number": 1,
          "primary": true,
          "public_key": "string",
          "status": "waiting_for_setup",
          "token_created_at": "2026-01-15T09:30:00Z"
        }
      ],
      "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55",
      "ips": [
        {
          "address": "string",
          "family": "string",
          "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55",
          "is_base": true,
          "location": "string",
          "monthly_price_cents": 1,
          "rdns": "string",
          "rdns_address": "string",
          "rdns_request": {},
          "started_at": "2026-01-15T09:30:00Z",
          "status": "waiting_for_key",
          "subscription_id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55",
          "tunnel_id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55",
          "vm": {}
        }
      ],
      "label": "string",
      "last_handshake_at": "2026-01-15T09:30:00Z",
      "location_id": "string",
      "max_ips": 1,
      "mode": "string",
      "monthly_cents": 1,
      "number": 1,
      "paid_until": "2026-01-15T09:30:00Z",
      "payment_status": "pending",
      "prepaid": true,
      "rate_mbps": 1,
      "started_at": "2026-01-15T09:30:00Z",
      "status": "waiting_for_setup",
      "suspends_at": "2026-01-15T09:30:00Z",
      "tier": {
        "enabled": true,
        "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55",
        "name": "my-app",
        "note": "string",
        "overage_tb_cents": 1,
        "price_cents": 1,
        "speed_mbps": 1,
        "throttle_mbps": 1,
        "traffic_tb": 1
      },
      "token_created_at": "2026-01-15T09:30:00Z",
      "traffic": {
        "allowance_bytes": 1,
        "month": "string",
        "overage_cents": 1,
        "rx_bytes": 1,
        "state": "unmetered",
        "tx_bytes": 1,
        "used_bytes": 1
      },
      "tunnel_id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55",
      "waiting_payment": {
        "checkout_url": "string",
        "due_cents": 1,
        "expires_at": "2026-01-15T09:30:00Z",
        "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55",
        "kind": "string",
        "status": "string"
      }
    }
  ],
  "vat_note": "string",
  "vat_rate_bp": 1
}

Give an address back

DELETE/v1/orgs/{org}/transit/leases/{id}

API token or dashboard session

Give an address back. Traffic to it stops within a minute; the unused part of its month paid ahead goes back to the balance, VAT included. The base address goes only with the whole subscription.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Responses

204no body
404Problem
409Problem
base_address

Blackhole an address of IP Transit, or lift it: everything sent to it is dropped on the machine, before the tunnel, within 30 seconds

PUT/v1/orgs/{org}/transit/leases/{id}/blackhole

API token or dashboard session

Blackhole an address of IP Transit, or lift it: everything sent to it is dropped on the machine, before the tunnel, within 30 seconds. For a flood that would fill your line. Optionally lifts on its own; one the operator set only the operator lifts.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Request body · application/json

enabledbooleanrequired
true drops everything to the address on the machine, false lifts it.

Move an address to another host of its subscription: the machine routes it to that host's tunnel within a minute, and each host learns of it on its next sync

PUT/v1/orgs/{org}/transit/leases/{id}/host

API token or dashboard session

Move an address to another host of its subscription: the machine routes it to that host's tunnel within a minute, and each host learns of it on its next sync. An address is carried by one host at a time.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Request body · application/json

host_iduuidrequired
The host to carry it, one of its subscription's.

Responses

200

Ask the operator for the reverse DNS (PTR) of a leased address

POST/v1/orgs/{org}/transit/leases/{id}/rdns

API token or dashboard session

Ask the operator for the reverse DNS (PTR) of a leased address.

The request waits for the operator, who sets the record at the provider and approves it, or rejects it with a reason; one request at a time per address. The answer is the address with the request.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Request body · application/json

namestringrequired
mail.example.com. For an IPv6 prefix it names the address the host uses (rdns_address).

Withdraw the pending reverse DNS request of a leased address

DELETE/v1/orgs/{org}/transit/leases/{id}/rdns

API token or dashboard session

Withdraw the pending reverse DNS request of a leased address.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Responses

204no body
404Problem

curl -X DELETE "https://api.infraflow.app/v1/orgs/acme/transit/leases/0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55/rdns" \
  -H "Authorization: Bearer $INFRAFLOW_TOKEN"

Order IP Transit at a location, safely sent again: the same as `POST /transit/subscriptions`, with an `Idempotency-Key` header

POST/v1/orgs/{org}/transit/orders

API token or dashboard session

Order IP Transit at a location, safely sent again: the same as POST /transit/subscriptions, with an Idempotency-Key header.

The first order with a key runs and its answer is kept for a day; the same order sent again with that key gets that answer back (200, with Idempotent-Replayed: true) and the subscription as it is now, without ordering or paying again. The setup command is in the first answer only: make a new one from the subscription if it was lost. An order that failed frees its key. The key belongs to the workspace.

Path parameters

orgstringpathrequired
Organisation slug

Request body · application/json

Where a payment stands, for the page its payer comes back to from Mollie: a payment still open is looked up at Mollie, should its notice be late

GET/v1/orgs/{org}/transit/payments/{id}

API token or dashboard session

Where a payment stands, for the page its payer comes back to from Mollie: a payment still open is looked up at Mollie, should its notice be late.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Responses

200TransitPaymentState
404Problem

Fields of TransitPaymentState

iduuidrequired

What an order, addresses added or a tier change would cost now, VAT included, and how it would be paid

POST/v1/orgs/{org}/transit/quote

API token or dashboard session

What an order, addresses added or a tier change would cost now, VAT included, and how it would be paid.

Path parameters

orgstringpathrequired
Organisation slug

Request body · application/json

ipv4_countinteger | null
locationstring | null
For an order: the location, with tier_id and ipv4_count.
subscription_iduuid | null
For a change: the subscription, with ipv4_count addresses to add or the to move to.

Order IP Transit at a location: a tunnel to its machine and its IPv4 addresses (and an IPv6 prefix when the location offers one), on a tier

POST/v1/orgs/{org}/transit/subscriptions

API token or dashboard session

Order IP Transit at a location: a tunnel to its machine and its IPv4 addresses (and an IPv6 prefix when the location offers one), on a tier.

A workspace may order several at one location, one per host: each has its own tunnel, setup command, addresses, tier and payments.

It is paid ahead: the rest of this month now, prorated to the second, then each month on its first day. The balance pays first, then the card on file; without a card, the answer is pending with the page to pay on, and the addresses wait (reserved, not routed) for 30 minutes at most. Once paid, the answer holds the setup command, shown this once; after a payment on Mollie's page, make one from the subscription.

Path parameters

orgstringpathrequired
Organisation slug

Request body · application/json

One IP Transit subscription of the workspace, as `GET /transit` lists them: its addresses, tier, tunnel, payment and health

GET/v1/orgs/{org}/transit/subscriptions/{id}

API token or dashboard session

One IP Transit subscription of the workspace, as GET /transit lists them: its addresses, tier, tunnel, payment and health.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Responses

200TransitSubscription
404Problem

Fields of TransitSubscription

available_ipv4integer

Name IP Transit at a location, to tell it apart from the workspace's other subscriptions there: `web-1`

PATCH/v1/orgs/{org}/transit/subscriptions/{id}

API token or dashboard session

Name IP Transit at a location, to tell it apart from the workspace's other subscriptions there: web-1. The name shows on the dashboard and on its invoices from then on.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Request body · application/json

labelstring | null
Up to 40 characters; null or blank to drop it.

Responses

200TransitSubscription

Cancel IP Transit at a location: every address of it is released and the tunnel stops within a minute

DELETE/v1/orgs/{org}/transit/subscriptions/{id}

API token or dashboard session

Cancel IP Transit at a location: every address of it is released and the tunnel stops within a minute. The unused part of the month paid ahead goes back to the workspace's balance, VAT included, prorated to the second; a month left unpaid is written off.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Responses

204no body
404Problem

curl -X DELETE "https://api.infraflow.app/v1/orgs/acme/transit/subscriptions/0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55" \
  -H "Authorization: Bearer $INFRAFLOW_TOKEN"

How to set a MikroTik, a pfSense, an OPNsense or a Windows machine up for a subscription, from its addresses and its tunnel

GET/v1/orgs/{org}/transit/subscriptions/{id}/clients

API token or dashboard session

How to set a MikroTik, a pfSense, an OPNsense or a Windows machine up for a subscription, from its addresses and its tunnel. No private key is ever in them: each device makes its own.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Responses

200TransitClients
404Problem

Fields of TransitClients

addressesstring[]

The DDoS protection of a subscription: what happens when one of its addresses is attacked, the thresholds each address is watched against, and the latest attacks

GET/v1/orgs/{org}/transit/subscriptions/{id}/ddos

API token or dashboard session

The DDoS protection of a subscription: what happens when one of its addresses is attacked, the thresholds each address is watched against, and the latest attacks.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Responses

200TransitDdos
404Problem

Fields of TransitDdos

actionTransitDdosAction

Choose what happens when an address of a subscription is attacked: `alert` only tells (through the workspace's notifications), `limit` rate-limits what attacks back under the threshold, `blackhole` drops everything to the address until the attack has been gone for `blackhole_minutes`

PUT/v1/orgs/{org}/transit/subscriptions/{id}/ddos

API token or dashboard session

Choose what happens when an address of a subscription is attacked: alert only tells (through the workspace's notifications), limit rate-limits what attacks back under the threshold, blackhole drops everything to the address until the attack has been gone for blackhole_minutes. The machine applies it within a minute.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Request body · application/json

The firewall of an IP Transit subscription: its rules and blackholed addresses

GET/v1/orgs/{org}/transit/subscriptions/{id}/firewall

API token or dashboard session

The firewall of an IP Transit subscription: its rules and blackholed addresses.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Responses

200TransitFirewall
404Problem

Fields of TransitFirewall

addressesTransitFirewallAddress[]required
The subscription's addresses, a rule or a blackhole may name one.

Replace the firewall rules of an IP Transit subscription: allow or deny by protocol, destination port or range and source network, for one address or all, in order (the first that matches decides, anything else gets through)

PUT/v1/orgs/{org}/transit/subscriptions/{id}/firewall

API token or dashboard session

Replace the firewall rules of an IP Transit subscription: allow or deny by protocol, destination port or range and source network, for one address or all, in order (the first that matches decides, anything else gets through). Applied on the machine before the tunnel, within 30 seconds; answers to connections your addresses opened always get back.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Request body · application/json

rulesTransitFirewallRuleInput[]required
The whole list, in order: it replaces the one there. At most 50.

Who an IP Transit subscription's addresses talk to: the busiest remote addresses and ports, and the traffic by protocol, in and out

GET/v1/orgs/{org}/transit/subscriptions/{id}/flows

API token or dashboard session

Who an IP Transit subscription's addresses talk to: the busiest remote addresses and ports, and the traffic by protocol, in and out. Sampled on the machine every two minutes or so, kept by the hour for a week.

Path and query parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired
rangeTransitFlowRangequery
1h, 24h (the default) or 7d.
addressstring

An IP Transit subscription's history: each month since it started with what it moved, what it was invoiced and what was paid, and every payment with its invoice

GET/v1/orgs/{org}/transit/subscriptions/{id}/history

API token or dashboard session

An IP Transit subscription's history: each month since it started with what it moved, what it was invoiced and what was paid, and every payment with its invoice.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Responses

200TransitHistory
404Problem

Fields of TransitHistory

currencystring

The same months as a CSV file: traffic in bytes and GB, amounts invoiced and paid, and the invoice numbers, the oldest month first

GET/v1/orgs/{org}/transit/subscriptions/{id}/history.csv

API token or dashboard session

The same months as a CSV file: traffic in bytes and GB, amounts invoiced and paid, and the invoice numbers, the oldest month first.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Responses

200no body
The months
404Problem

curl "https://api.infraflow.app/v1/orgs/acme/transit/subscriptions/0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55/history.csv" \
  -H "Authorization: Bearer $INFRAFLOW_TOKEN"

The hosts that carry a subscription's addresses, host #1 first

GET/v1/orgs/{org}/transit/subscriptions/{id}/hosts

API token or dashboard session

The hosts that carry a subscription's addresses, host #1 first.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Responses

200TransitSubscriptionHost[]
404Problem

Fields of TransitSubscriptionHost

addressesstring[]required
The addresses it carries: 5.9.10.8, .

Share a subscription with one more host of the workspace: it gets a setup command of its own and, once set up, its own tunnel to the machine

POST/v1/orgs/{org}/transit/subscriptions/{id}/hosts

API token or dashboard session

Share a subscription with one more host of the workspace: it gets a setup command of its own and, once set up, its own tunnel to the machine. It carries nothing until addresses are moved to it; the tier's speed is shared by all the hosts.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Request body · application/json

labelstring | null
A name to tell it from the others: pve-2.

Responses

Name a host of a subscription, or drop its name

PATCH/v1/orgs/{org}/transit/subscriptions/{id}/hosts/{host}

API token or dashboard session

Name a host of a subscription, or drop its name.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired
hostuuidpathrequired

Request body · application/json

labelstring | null
Up to 40 characters; null or blank drops it.

Responses

200TransitSubscriptionHost

Stop sharing a subscription with a host: the addresses it carried go back to host #1 within a minute, and its tunnel stops

DELETE/v1/orgs/{org}/transit/subscriptions/{id}/hosts/{host}

API token or dashboard session

Stop sharing a subscription with a host: the addresses it carried go back to host #1 within a minute, and its tunnel stops. Host #1 cannot be removed.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired
hostuuidpathrequired

Responses

204no body
404Problem

Make a new setup command for one host of a subscription

POST/v1/orgs/{org}/transit/subscriptions/{id}/hosts/{host}/token

API token or dashboard session

Make a new setup command for one host of a subscription. The one before stops working; the host keeps its tunnel, and learns of changes again once the new command runs on it.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired
hostuuidpathrequired

Responses

201TransitSetup
404Problem

Add IPv4 addresses to IP Transit at a location, at the location's price for one more address a month each

POST/v1/orgs/{org}/transit/subscriptions/{id}/ips

API token or dashboard session

Add IPv4 addresses to IP Transit at a location, at the location's price for one more address a month each. The host picks them up within a minute, without running anything again.

The rest of the month is paid now, prorated, the balance first, then the card on file; without a card, the answer is pending with the page to pay on, and the addresses wait for the payment (30 minutes at most). IP Transit ordered before prepaid transit is charged after the month until its first prepaid month.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Request body · application/json

Pay what IP Transit at a location waits for: its order or a change whose page is still open, or a month that could not be paid (the balance first, then the card on file, or the page to pay on)

POST/v1/orgs/{org}/transit/subscriptions/{id}/pay

API token or dashboard session

Pay what IP Transit at a location waits for: its order or a change whose page is still open, or a month that could not be paid (the balance first, then the card on file, or the page to pay on). A suspended subscription is routed again as soon as it is paid.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Responses

200TransitChange
400Problem
payment_failed

Move IP Transit at a location to another speed tier, from now; the machine applies the new speed within a minute

PUT/v1/orgs/{org}/transit/subscriptions/{id}/tier

API token or dashboard session

Move IP Transit at a location to another speed tier, from now; the machine applies the new speed within a minute.

A dearer tier pays the prorated difference for the rest of the month first (the balance, then the card on file, or the page to pay on: the answer is then pending and the tier changes once paid). A cheaper one applies at once and gives the unused difference back to the balance, VAT included. IP Transit ordered before prepaid transit is charged after the month until its first prepaid month.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Request body · application/json

Make a new setup command for IP Transit at a location

POST/v1/orgs/{org}/transit/subscriptions/{id}/token

API token or dashboard session

Make a new setup command for IP Transit at a location. The one before stops working; a host already set up keeps working with the new token only once the command runs on it again.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Responses

201TransitSetup
404Problem
409Problem
payment_pending: not paid yet

Revoke the setup command of IP Transit at a location

DELETE/v1/orgs/{org}/transit/subscriptions/{id}/token

API token or dashboard session

Revoke the setup command of IP Transit at a location. The tunnel keeps running, but the host no longer learns of address changes until a new command runs on it.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Responses

204no body
404Problem

curl -X DELETE "https://api.infraflow.app/v1/orgs/acme/transit/subscriptions/0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55/token" \
  -H "Authorization: Bearer $INFRAFLOW_TOKEN"

Traffic of an IP Transit subscription, per address or for the whole tunnel: bandwidth in and out, packets per second, and what each address moved this month

GET/v1/orgs/{org}/transit/subscriptions/{id}/traffic

API token or dashboard session

Traffic of an IP Transit subscription, per address or for the whole tunnel: bandwidth in and out, packets per second, and what each address moved this month. Measured on the machine in front of the tunnel, twice a minute.

Path and query parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired
rangeTransitTrafficRangequery
1h (by the minute, the default), 24h (by 5 minutes), 7d (by the hour) or 30d (by 4 hours).

The usage alerts of a subscription

GET/v1/orgs/{org}/transit/subscriptions/{id}/traffic/alert

API token or dashboard session

The usage alerts of a subscription.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Responses

200TransitTrafficAlert
404Problem

Fields of TransitTrafficAlert

monthly_gbinteger | null
Told once a month when what the tunnel moved this month (in and out, as the allowance counts it) reaches this many GB.

Set when to hear `transit.traffic_high` of a subscription: a monthly volume, a sustained rate, or both (`null` for neither drops them)

PUT/v1/orgs/{org}/transit/subscriptions/{id}/traffic/alert

API token or dashboard session

Set when to hear transit.traffic_high of a subscription: a monthly volume, a sustained rate, or both (null for neither drops them). It goes through the workspace's notifications: webhooks, Discord, Slack and the phones that asked for it.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Request body · application/json

monthly_gbinteger | null
1 to 1 000 000 GB; null for no monthly threshold.

The last five minutes of an IP Transit subscription's traffic, every two seconds, per address or for the whole tunnel

GET/v1/orgs/{org}/transit/subscriptions/{id}/traffic/live

API token or dashboard session

The last five minutes of an IP Transit subscription's traffic, every two seconds, per address or for the whole tunnel. Asking tells its machine to read its counters every two seconds for the next minute: a dashboard asks again while it shows the graph.

Path and query parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired
addressstringquery
Only this address of the subscription; every address added up when left out.

Responses

200

Choose how a subscription's tunnel travels: WireGuard (encrypted, through NAT, the default) or GRE (unencrypted, to your router's public IPv4)

PUT/v1/orgs/{org}/transit/subscriptions/{id}/tunnel

API token or dashboard session

Choose how a subscription's tunnel travels: WireGuard (encrypted, through NAT, the default) or GRE (unencrypted, to your router's public IPv4). The machine applies it within 30 seconds, the host within a minute.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Request body · application/json

gre_remotestring | null
The public IPv4 of your router, for GRE. Left out, the one known stays (the device may also tell it with its setup token).
tunnel_type

The config of the workspace's Proxmox VE host for a tunnel, for a manual setup: WireGuard, the routed bridge, policy routing, and each VM's network settings

GET/v1/orgs/{org}/transit/tunnels/{id}/config

API token or dashboard session

The config of the workspace's Proxmox VE host for a tunnel, for a manual setup: WireGuard, the routed bridge, policy routing, and each VM's network settings.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Responses

200ProxmoxConfig
404Problem

Fields of ProxmoxConfig

interfacesstring

Set the public key of the workspace's end of a tunnel, for a manual setup (the setup command registers it by itself)

PUT/v1/orgs/{org}/transit/tunnels/{id}/key

API token or dashboard session

Set the public key of the workspace's end of a tunnel, for a manual setup (the setup command registers it by itself).

The private key stays on the workspace's host: wg genkey | tee ifl-transit.key | wg pubkey.

Path parameters

orgstringpathrequired
Organisation slug
iduuidpathrequired

Request body · application/json

public_keystringrequired
The public key of the workspace's host, from wg pubkey.

Responses

{ "currency": "string", "locations": [ { "available_ipv4": 1, "base_price_cents": 1, "city": "string", "country": "string", "extra_ip_price_cents": 1, "id": "string", "ipv6": true, "max_ips": 1, "max_order_ipv4": 1, "max_subscriptions": 1, "ordered": true, "port_speed_mbps": 1, "region": "string", "subscription_count": 1, "tiers": [ { "enabled": true, "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "name": "my-app", "note": "string", "overage_tb_cents": 1, "price_cents": 1, "speed_mbps": 1, "throttle_mbps": 1, "traffic_tb": 1 } ], "traffic_tb": 1 } ], "next_charge_at": "2026-01-15T09:30:00Z", "payment": { "balance_cents": 1, "card": true, "payments": true, "renewing_plan": true }, "subscriptions": [ { "available_ipv4": 1, "base_price_cents": 1, "bridge": "string", "cancels_at": "2026-01-15T09:30:00Z", "city": "string", "country": "string", "endpoint": "string", "extra_ip_price_cents": 1, "has_token": true, "health": { "broken_since": "2026-01-15T09:30:00Z", "checked_at": "2026-01-15T09:30:00Z", "issues": [ {} ], "state": "ok", "traffic": "flows" }, "hosts": [ { "addresses": [], "bridge": "string", "has_token": true, "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "label": "string", "last_handshake_at": "2026-01-15T09:30:00Z", "mode": "string", "number": 1, "primary": true, "public_key": "string", "status": "waiting_for_setup", "token_created_at": "2026-01-15T09:30:00Z" } ], "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "ips": [ { "address": "string", "family": "string", "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "is_base": true, "location": "string", "monthly_price_cents": 1, "rdns": "string", "rdns_address": "string", "rdns_request": {}, "started_at": "2026-01-15T09:30:00Z", "status": "waiting_for_key", "subscription_id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "tunnel_id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "vm": {} } ], "label": "string", "last_handshake_at": "2026-01-15T09:30:00Z", "location_id": "string", "max_ips": 1, "mode": "string", "monthly_cents": 1, "number": 1, "paid_until": "2026-01-15T09:30:00Z", "payment_status": "pending", "prepaid": true, "rate_mbps": 1, "started_at": "2026-01-15T09:30:00Z", "status": "waiting_for_setup", "suspends_at": "2026-01-15T09:30:00Z", "tier": { "enabled": true, "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "name": "my-app", "note": "string", "overage_tb_cents": 1, "price_cents": 1, "speed_mbps": 1, "throttle_mbps": 1, "traffic_tb": 1 }, "token_created_at": "2026-01-15T09:30:00Z", "traffic": { "allowance_bytes": 1, "month": "string", "overage_cents": 1, "rx_bytes": 1, "state": "unmetered", "tx_bytes": 1, "used_bytes": 1 }, "tunnel_id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "waiting_payment": { "checkout_url": "string", "due_cents": 1, "expires_at": "2026-01-15T09:30:00Z", "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "kind": "string", "status": "string" } } ], "vat_note": "string", "vat_rate_bp": 1 }

curl -X POST "https://api.infraflow.app/v1/orgs/acme/transit/orders" \ -H "Authorization: Bearer $INFRAFLOW_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "ipv4_count": 1, "label": "string", "location": "string", "tier_id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55" }'

{ "checkout_url": "string", "payment_id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "setup": { "command": "string", "token": "ifl_…" }, "status": "active", "subscription": { "available_ipv4": 1, "base_price_cents": 1, "bridge": "string", "cancels_at": "2026-01-15T09:30:00Z", "city": "string", "country": "string", "endpoint": "string", "extra_ip_price_cents": 1, "has_token": true, "health": { "broken_since": "2026-01-15T09:30:00Z", "checked_at": "2026-01-15T09:30:00Z", "issues": [ { "address": "string", "at": "2026-01-15T09:30:00Z", "auto_repaired": true, "code": "123456", "fix": "string", "message": "string", "side": "host" } ], "state": "ok", "traffic": "flows" }, "hosts": [ { "addresses": [ "string" ], "bridge": "string", "has_token": true, "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "label": "string", "last_handshake_at": "2026-01-15T09:30:00Z", "mode": "string", "number": 1, "primary": true, "public_key": "string", "status": "waiting_for_setup", "token_created_at": "2026-01-15T09:30:00Z" } ], "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "ips": [ { "address": "string", "family": "string", "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "is_base": true, "location": "string", "monthly_price_cents": 1, "rdns": "string", "rdns_address": "string", "rdns_request": { "created_at": "2026-01-15T09:30:00Z", "decided_at": "2026-01-15T09:30:00Z", "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "name": "my-app", "reason": "string", "status": "string" }, "started_at": "2026-01-15T09:30:00Z", "status": "waiting_for_key", "subscription_id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "tunnel_id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "vm": { "address": "string", "bridge": "string", "cloud_init": "string", "debian": "string", "dns": [], "gateway": "string", "lease": "string", "netplan": "string", "server": "string", "windows": "string" } } ], "label": "string", "last_handshake_at": "2026-01-15T09:30:00Z", "location_id": "string", "max_ips": 1, "mode": "string", "monthly_cents": 1, "number": 1, "paid_until": "2026-01-15T09:30:00Z", "payment_status": "pending", "prepaid": true, "rate_mbps": 1, "started_at": "2026-01-15T09:30:00Z", "status": "waiting_for_setup", "suspends_at": "2026-01-15T09:30:00Z", "tier": { "enabled": true, "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "name": "my-app", "note": "string", "overage_tb_cents": 1, "price_cents": 1, "speed_mbps": 1, "throttle_mbps": 1, "traffic_tb": 1 }, "token_created_at": "2026-01-15T09:30:00Z", "traffic": { "allowance_bytes": 1, "month": "string", "overage_cents": 1, "rx_bytes": 1, "state": "unmetered", "tx_bytes": 1, "used_bytes": 1 }, "tunnel_id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "waiting_payment": { "checkout_url": "string", "due_cents": 1, "expires_at": "2026-01-15T09:30:00Z", "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "kind": "string", "status": "string" } } }

curl -X POST "https://api.infraflow.app/v1/orgs/acme/transit/subscriptions" \ -H "Authorization: Bearer $INFRAFLOW_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "ipv4_count": 1, "label": "string", "location": "string", "tier_id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55" }'

{ "available_ipv4": 1, "base_price_cents": 1, "bridge": "string", "cancels_at": "2026-01-15T09:30:00Z", "city": "string", "country": "string", "endpoint": "string", "extra_ip_price_cents": 1, "has_token": true, "health": { "broken_since": "2026-01-15T09:30:00Z", "checked_at": "2026-01-15T09:30:00Z", "issues": [ { "address": "string", "at": "2026-01-15T09:30:00Z", "auto_repaired": true, "code": "123456", "fix": "string", "message": "string", "side": "host" } ], "state": "ok", "traffic": "flows" }, "hosts": [ { "addresses": [ "string" ], "bridge": "string", "has_token": true, "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "label": "string", "last_handshake_at": "2026-01-15T09:30:00Z", "mode": "string", "number": 1, "primary": true, "public_key": "string", "status": "waiting_for_setup", "token_created_at": "2026-01-15T09:30:00Z" } ], "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "ips": [ { "address": "string", "family": "string", "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "is_base": true, "location": "string", "monthly_price_cents": 1, "rdns": "string", "rdns_address": "string", "rdns_request": { "created_at": "2026-01-15T09:30:00Z", "decided_at": "2026-01-15T09:30:00Z", "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "name": "my-app", "reason": "string", "status": "string" }, "started_at": "2026-01-15T09:30:00Z", "status": "waiting_for_key", "subscription_id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "tunnel_id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "vm": { "address": "string", "bridge": "string", "cloud_init": "string", "debian": "string", "dns": [ "string" ], "gateway": "string", "lease": "string", "netplan": "string", "server": "string", "windows": "string" } } ], "label": "string", "last_handshake_at": "2026-01-15T09:30:00Z", "location_id": "string", "max_ips": 1, "mode": "string", "monthly_cents": 1, "number": 1, "paid_until": "2026-01-15T09:30:00Z", "payment_status": "pending", "prepaid": true, "rate_mbps": 1, "started_at": "2026-01-15T09:30:00Z", "status": "waiting_for_setup", "suspends_at": "2026-01-15T09:30:00Z", "tier": { "enabled": true, "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "name": "my-app", "note": "string", "overage_tb_cents": 1, "price_cents": 1, "speed_mbps": 1, "throttle_mbps": 1, "traffic_tb": 1 }, "token_created_at": "2026-01-15T09:30:00Z", "traffic": { "allowance_bytes": 1, "month": "string", "overage_cents": 1, "rx_bytes": 1, "state": "unmetered", "tx_bytes": 1, "used_bytes": 1 }, "tunnel_id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "waiting_payment": { "checkout_url": "string", "due_cents": 1, "expires_at": "2026-01-15T09:30:00Z", "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "kind": "string", "status": "string" } }

curl -X PATCH "https://api.infraflow.app/v1/orgs/acme/transit/subscriptions/0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55" \ -H "Authorization: Bearer $INFRAFLOW_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "label": "string" }'

curl -X POST "https://api.infraflow.app/v1/orgs/acme/transit/subscriptions/0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55/ips" \ -H "Authorization: Bearer $INFRAFLOW_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "count": 1 }'

{ "checkout_url": "string", "payment_id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "refund_cents": 1, "status": "active", "subscription": { "available_ipv4": 1, "base_price_cents": 1, "bridge": "string", "cancels_at": "2026-01-15T09:30:00Z", "city": "string", "country": "string", "endpoint": "string", "extra_ip_price_cents": 1, "has_token": true, "health": { "broken_since": "2026-01-15T09:30:00Z", "checked_at": "2026-01-15T09:30:00Z", "issues": [ { "address": "string", "at": "2026-01-15T09:30:00Z", "auto_repaired": true, "code": "123456", "fix": "string", "message": "string", "side": "host" } ], "state": "ok", "traffic": "flows" }, "hosts": [ { "addresses": [ "string" ], "bridge": "string", "has_token": true, "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "label": "string", "last_handshake_at": "2026-01-15T09:30:00Z", "mode": "string", "number": 1, "primary": true, "public_key": "string", "status": "waiting_for_setup", "token_created_at": "2026-01-15T09:30:00Z" } ], "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "ips": [ { "address": "string", "family": "string", "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "is_base": true, "location": "string", "monthly_price_cents": 1, "rdns": "string", "rdns_address": "string", "rdns_request": { "created_at": "2026-01-15T09:30:00Z", "decided_at": "2026-01-15T09:30:00Z", "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "name": "my-app", "reason": "string", "status": "string" }, "started_at": "2026-01-15T09:30:00Z", "status": "waiting_for_key", "subscription_id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "tunnel_id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "vm": { "address": "string", "bridge": "string", "cloud_init": "string", "debian": "string", "dns": [], "gateway": "string", "lease": "string", "netplan": "string", "server": "string", "windows": "string" } } ], "label": "string", "last_handshake_at": "2026-01-15T09:30:00Z", "location_id": "string", "max_ips": 1, "mode": "string", "monthly_cents": 1, "number": 1, "paid_until": "2026-01-15T09:30:00Z", "payment_status": "pending", "prepaid": true, "rate_mbps": 1, "started_at": "2026-01-15T09:30:00Z", "status": "waiting_for_setup", "suspends_at": "2026-01-15T09:30:00Z", "tier": { "enabled": true, "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "name": "my-app", "note": "string", "overage_tb_cents": 1, "price_cents": 1, "speed_mbps": 1, "throttle_mbps": 1, "traffic_tb": 1 }, "token_created_at": "2026-01-15T09:30:00Z", "traffic": { "allowance_bytes": 1, "month": "string", "overage_cents": 1, "rx_bytes": 1, "state": "unmetered", "tx_bytes": 1, "used_bytes": 1 }, "tunnel_id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "waiting_payment": { "checkout_url": "string", "due_cents": 1, "expires_at": "2026-01-15T09:30:00Z", "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "kind": "string", "status": "string" } } }

curl -X PUT "https://api.infraflow.app/v1/orgs/acme/transit/subscriptions/0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55/tier" \ -H "Authorization: Bearer $INFRAFLOW_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "tier_id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55" }'