ovahub
Ir a la documentación
DocumentaciónReferencia de la APIConsultar detalles de una red privada
GETToken Bearer

Consultar detalles de una red privada

/api/v1/networks/:id

Consulte una red local propia y hasta 100 instantáneas de puertos ordenadas por ID. Las redes inexistentes o de otra organización devuelven 404. Los puertos locales vacíos no confirman ausencia en el proveedor.

Antes de llamar

Solo lectura local, sin solicitudes al proveedor, cobros ni escrituras. Todas las capabilities son false; coincidir en región o proveedor no demuestra compatibilidad ni conexión segura.

Los nombres de campos, los tipos y el código de la API se mantienen iguales en todos los idiomas.

Ejemplo de petición

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

Solo ejemplos. Esta página no envía peticiones.

Respuesta ilustrativa
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
}

Parámetros

idRuta · Obligatorio

string

ID del recurso: 24 caracteres hexadecimales. Use el ID de la plataforma devuelto por el endpoint de listado correspondiente, no el ID de instancia del proveedor.

afterConsulta · Opcional

string

Cursor opcional de 24 caracteres hexadecimales de nextCursor (lista de redes) o portsNextCursor (detalle). Devuelve hasta 100 filas con ID mayor que el cursor; null indica que no hay otra página.

Respuesta

Estado HTTP 200

Consulte una red local propia y hasta 100 instantáneas de puertos ordenadas por ID. Las redes inexistentes o de otra organización devuelven 404. Los puertos locales vacíos no confirman ausencia en el proveedor.

idstring

Identificador de la plataforma, no del proveedor.

providerstring

Valor de la instantánea local almacenada, no un estado del proveedor verificado en vivo.

namestring

Valor de la instantánea local almacenada, no un estado del proveedor verificado en vivo.

regionstring

Valor de la instantánea local almacenada, no un estado del proveedor verificado en vivo.

dataCenterstring | null

Valor de la instantánea local almacenada, no un estado del proveedor verificado en vivo.

cidrstring | null

CIDR privado registrado, o null si no se ha observado.

boundServersinteger | null

Número de conexiones activas a servidores físicos actuales de la organización; null si el recuento es incoherente.

occupiedPortsinteger | null

Reservas locales activas, incluidas las pendientes y en proceso de retirada; null si la ocupación es incoherente.

capacityinteger

Valor de la instantánea local almacenada, no un estado del proveedor verificado en vivo.

statestring

Valor de la instantánea local almacenada, no un estado del proveedor verificado en vivo.

versioninteger

Valor de la instantánea local almacenada, no un estado del proveedor verificado en vivo.

monthlyPricestring

Centavos enteros de USD como cadena, no dólares; un precio publicado no habilita el pago.

serviceFromstring (ISO 8601) | null

El servicio empieza solo tras confirmar la compra; null si se desconoce.

serviceUntilstring (ISO 8601) | null

Fin del servicio pagado en la plataforma, independiente de las fechas pagadas al proveedor; null si se desconoce.

autoRenewboolean

Solo es una preferencia de renovación; no demuestra pago ni ampliación.

accessStatestring

Estado local guardado del acceso a la red: active, stopping, stopped, restoring o unknown. No verifica la conectividad actual del proveedor.

currency"USD"

Moneda fija USD, unidad cent y período month cuando se incluye.

priceUnit"cent"

Moneda fija USD, unidad cent y período month cuando se incluye.

checkedAtstring | null

Fecha de comprobación de la instantánea en ISO 8601, o null si se desconoce. No es una verificación en vivo.

testOnlyboolean

True solo marca un contexto de prueba, que puede incluir servidores reales comprados. No demuestra simulación ni omite cobros o controles de seguridad.

source"local"

Siempre local; no se realiza ninguna consulta en vivo al proveedor.

verification"unknown" | "snapshot"

snapshot si existe checkedAt; de lo contrario, unknown. Ninguno verifica el estado actual del proveedor.

capabilitiesobject

Los nueve indicadores son false: purchase, attach, disconnect, remove, reconnect, cancelAddon, renew, resize y delete. Las capacidades del proveedor aún no están verificadas y no se cobra hasta verificarlas; las instantáneas no prueban compatibilidad ni conexión segura.

portsobject[]

Consulte una red local propia y hasta 100 instantáneas de puertos ordenadas por ID. Las redes inexistentes o de otra organización devuelven 404. Los puertos locales vacíos no confirman ausencia en el proveedor.

portsVerification"unknown"

Siempre unknown; un resultado local vacío no prueba ausencia en el proveedor.

portsNextCursorstring | null

Cursor opcional de 24 caracteres hexadecimales de nextCursor (lista de redes) o portsNextCursor (detalle). Devuelve hasta 100 filas con ID mayor que el cursor; null indica que no hay otra página.

ports[].idstring

Identificador de la plataforma, no del proveedor.

ports[].slotinteger

Valor de la instantánea local almacenada, no un estado del proveedor verificado en vivo.

ports[].serverIdstring | null

Solo se devuelve para un servidor actual no eliminado de esta organización. En otro caso serverId y checkedAt son null, connectionState es unknown y privateIps es null.

ports[].activeboolean

Valor de la instantánea local almacenada, no un estado del proveedor verificado en vivo.

ports[].reservationStatestring

Valor de la instantánea local almacenada, no un estado del proveedor verificado en vivo.

ports[].connectionStatestring

Solo se devuelve para un servidor actual no eliminado de esta organización. En otro caso serverId y checkedAt son null, connectionState es unknown y privateIps es null.

ports[].privateIpsstring[] | null

null si faltan propiedad o fecha de comprobación. Solo un servidor propio no eliminado con checkedAt devuelve un array, incluido []; sigue siendo una instantánea local.

ports[].checkedAtstring | null

Solo se devuelve para un servidor actual no eliminado de esta organización. En otro caso serverId y checkedAt son null, connectionState es unknown y privateIps es null.

ports[].versioninteger

Valor de la instantánea local almacenada, no un estado del proveedor verificado en vivo.

ports[].testOnlyboolean

True solo marca un contexto de prueba, que puede incluir servidores reales comprados. No demuestra simulación ni omite cobros o controles de seguridad.

Relacionado

Peticiones y erroresAutenticaciónMCP · get_network