Get Hub Service Endpoint for Site of Tenant (v2.0)

GET 
/v2.0/api/tenants/:tenant_id/sites/:site_id/hubserviceendpoints

Get the hub service endpoint for a site of a given tenant using the tenant ID and site ID.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

site_id stringrequired

ID of the remote site. More details on the site can be retrieved by querying the sites API.

Responses

200

Successful Operation

application/json

Schema

Schema

active_service_endpoints HubServiceEndpoint[]
The active service endpoints of the site or tenant.
Array [
cir_bw_mbps integer
Cir Bw Mbps
service_endpoint_id string
Service Endpoint Id
]
backup_service_endpoints HubServiceEndpoint[]
The backup service endpoints of the site or tenant.
Array [
cir_bw_mbps integer
Cir Bw Mbps
service_endpoint_id string
Service Endpoint Id
]
id string

The ID of the Hub.

site_id stringrequired

The ID of the site.

tenant_id stringrequired

Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)

Example (from schema)

{
  "active_service_endpoints": [
    {
      "cir_bw_mbps": 0,
      "service_endpoint_id": "string"
    }
  ],
  "backup_service_endpoints": [
    {
      "cir_bw_mbps": 0,
      "service_endpoint_id": "string"
    }
  ],
  "id": "string",
  "site_id": "string",
  "tenant_id": "string"
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
message string
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "SITE_NOT_FOUND"
      }
    ]
  }
}

Loading...