GETBearer token

Get private network details

/api/v1/networks/:id

Read an owned local network and up to 100 port snapshots sorted by ID. Missing or other-organization networks return 404. Empty local ports are not verified supplier absence.

Before you call

Read-only local data. No supplier requests, billing or writes are performed. All capabilities are false; matching regions or providers does not prove compatibility or safe attachment.

Request example

cURL

curl "https://tovahub.com/api/v1/networks/507f1f77bcf86cd799439012" \
  -H "Authorization: Bearer $TOVAHUB_TOKEN"

Examples only. No requests are sent from this page.

Illustrative response

JSON

{
  "id": "507f1f77bcf86cd799439011",
  "provider": "contabo",
  "name": "example-network",
  "serviceFrom": null,
  "serviceUntil": null,
  "autoRenew": false,
  "accessState": "unknown",
  "region": "EU",
  "dataCenter": null,
  "capacity": 5,
  "monthlyPrice": "990",
  "currency": "USD",
  "priceUnit": "cent",
  "state": "pending",
  "version": 1,
  "checkedAt": null,
  "testOnly": true,
  "source": "local",
  "verification": "unknown",
  "capabilities": {
    "purchase": false,
    "attach": false,
    "disconnect": false,
    "remove": false,
    "reconnect": false,
    "cancelAddon": false,
    "renew": false,
    "resize": false,
    "delete": false,
    "blockedReason": "Private network supplier actions are not verified. Billing requires verified supplier support; local snapshots do not establish compatibility or safe attachment."
  },
  "portsVerification": "unknown",
  "portsNextCursor": null,
  "ports": [
    {
      "id": "507f1f77bcf86cd799439014",
      "slot": 1,
      "serverId": null,
      "active": true,
      "reservationState": "reserved",
      "connectionState": "unknown",
      "privateIps": null,
      "checkedAt": null,
      "version": 1,
      "testOnly": true
    }
  ],
  "cidr": null,
  "boundServers": 0,
  "occupiedPorts": 0
}

Parameters

idPath · Required

string

Resource ID: 24 hexadecimal characters. Use the platform ID returned by the matching list endpoint, not a supplier instance ID.

afterQuery · Optional

string

Optional 24-hex-character cursor from nextCursor (network list) or portsNextCursor (network detail). Returns IDs greater than this cursor, up to 100 rows; null means no next page.

Response

HTTP status 200

Read an owned local network and up to 100 port snapshots sorted by ID. Missing or other-organization networks return 404. Empty local ports are not verified supplier absence.

idstring

Platform identifier, not a supplier identifier.

providerstring

Stored local snapshot value, not verified live supplier state.

namestring

Stored local snapshot value, not verified live supplier state.

regionstring

Stored local snapshot value, not verified live supplier state.

dataCenterstring | null

Stored local snapshot value, not verified live supplier state.

cidrstring | null

Stored private network CIDR, or null when not observed.

boundServersinteger | null

Count of active bindings to current owned physical servers; null when the count is inconsistent.

occupiedPortsinteger | null

Count of active local reservations including pending and releasing slots; null when occupancy is inconsistent.

capacityinteger

Stored local snapshot value, not verified live supplier state.

statestring

Stored local snapshot value, not verified live supplier state.

versioninteger

Stored local snapshot value, not verified live supplier state.

monthlyPricestring

Integer USD cents as a string, not dollars; a listed price does not enable payment.

serviceFromstring (ISO 8601) | null

Service starts only after verified purchase completion, or null when unknown.

serviceUntilstring (ISO 8601) | null

Platform paid service cutoff, independent of supplier paid dates; null when unknown.

autoRenewboolean

Renewal preference only; it does not prove payment or extension.

accessStatestring

Stored local network access state: active, stopping, stopped, restoring or unknown. It does not verify current supplier connectivity.

currency"USD"

Fixed currency USD, price unit cent and billing period month where present.

priceUnit"cent"

Fixed currency USD, price unit cent and billing period month where present.

checkedAtstring | null

Snapshot check time in ISO 8601, or null when unknown. A timestamp is not a live verification.

testOnlyboolean

True marks a test context only, which can include real purchased servers. It does not prove simulation or bypass billing or safety checks.

source"local"

Always local; no live supplier request is made.

verification"unknown" | "snapshot"

snapshot when checkedAt exists, otherwise unknown. Neither value verifies current supplier state.

capabilitiesobject

All nine flags are false: purchase, attach, disconnect, remove, reconnect, cancelAddon, renew, resize and delete. blockedReason explains that supplier support is unverified and billing is unavailable until verified; snapshots do not establish compatibility or safe attachment.

portsobject[]

Read an owned local network and up to 100 port snapshots sorted by ID. Missing or other-organization networks return 404. Empty local ports are not verified supplier absence.

portsVerification"unknown"

Always unknown; an empty local result is not proof of supplier absence.

portsNextCursorstring | null

Optional 24-hex-character cursor from nextCursor (network list) or portsNextCursor (network detail). Returns IDs greater than this cursor, up to 100 rows; null means no next page.

ports[].idstring

Platform identifier, not a supplier identifier.

ports[].slotinteger

Stored local snapshot value, not verified live supplier state.

ports[].serverIdstring | null

Returned only for a current, non-deleted server owned by this organization. Otherwise serverId and checkedAt are null, connectionState is unknown and privateIps is null.

ports[].activeboolean

Stored local snapshot value, not verified live supplier state.

ports[].reservationStatestring

Stored local snapshot value, not verified live supplier state.

ports[].connectionStatestring

Returned only for a current, non-deleted server owned by this organization. Otherwise serverId and checkedAt are null, connectionState is unknown and privateIps is null.

ports[].privateIpsstring[] | null

null when ownership or a check timestamp is missing. An array, including [], is returned only for an owned, non-deleted server with checkedAt; it remains a local snapshot.

ports[].checkedAtstring | null

Returned only for a current, non-deleted server owned by this organization. Otherwise serverId and checkedAt are null, connectionState is unknown and privateIps is null.

ports[].versioninteger

Stored local snapshot value, not verified live supplier state.

ports[].testOnlyboolean

True marks a test context only, which can include real purchased servers. It does not prove simulation or bypass billing or safety checks.

Requests & errors Authentication MCP · get_network

Get private network details

Request example

Parameters#

Response#

Related#

Parameters

Response

Related