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

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

Path Parameters

• tenant_id string required

  The tenant ID.

• site_id string required

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

Responses

• 200
• 400

---

Successful Operation

application/json

• Schema
• Example (from 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 string required

  The ID of the site.

• tenant_id string required

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

{
  "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"
}

Bad Request

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• _error ErrorResponse[]

  Array [

  code string

  message string

  ]

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

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

Loading...