/v1/api/servicePoints (GET) - BlueCat Edge - Service Point v3.x.x

BlueCat Edge User Guide
Locale
English
Product name
BlueCat Edge
Version
Service Point v3.x.x

Returns information about all currently registered service points

Request: GET https://api-<BlueCat.edge.url>/v1/api/servicePoints
Authorization: Bearer token

Successful response

200 OK
Content-Type: application/JSON
[   
     {
        "id": "7793fcc1-21d9-40d2-a382-3df72276b501",
        "name": "Toronto-7793fcc1",
        "siteId": "7cc208a1-47de-4a8b-9534-b2a5bd6f9d74"
        "lastSync": 1539182415,
        "connectionState": "CONNECTED",
        "connectionStateLastChanged": 1539713281000,
        "decommissioned": true,
        "ipAddresses": [
            "1.2.3.4/32",
            "5.6.7.8/24"
        ],
        "lookbackIps": [
            "1.1.1.1/32",
            "2.2.2.2/32"
        ],
        "hostManager": "BLUECAT",
        "version": "1.2.3",
        "updateInitiatedTimestamp": 1539180118,
        "updateStatus": "COMPLETE"
    },
    {
        "id": "7793fcc2-21d9-40d2-a382-3df72276b502",
        "name": "Toronto-7793fcc2",
        "siteId": "7cc208a1-47de-4a8b-9534-b2a5bd6f9d74"
        "lastSync": 1539182416,
        "connectionState": "CONNECTED",
        "connectionStateLastChanged": 1539713282000,
        "decommissioned": true,
        "ipAddresses": [],
        "lookbackIps": [],
        "hostManager": "BLUECAT",
        "version": "1.9.9",
        "updateInitiatedTimestamp": 1539124132,
        "updateStatus": "FAILED"
    },
    {
        "id": "7793fcc3-21d9-40d2-a382-3df72276b503",
        "name": "Vancouver-7793fcc3",
        "siteId": "7cc208a1-47de-4a8b-9534-b2a5bd6f9d74"
        "lastSync": 1539182420,
        "connectionState": "CONNECTED",
        "connectionStateLastChanged": 1539713283000,
        "decommissioned": false,
        "ipAddresses": [
            "4.5.6.7/32",
            "9.8.7.6/32"
        ],
        "lookbackIps": [
            "1.1.1.1/32",
            "2.2.2.2/32"
        ],
        "hostManager": "BLUECAT",
        "version": "2.0.0",
        "updateInitiatedTimestamp": 1539181258,
        "updateStatus": "UPDATE_IN_PROGRESS"
    },
...
]
Where the parameters represent the following:
  • id—the ID of the service point.
  • name—the name of the service point.
  • siteId—the ID of the site to which the service point is registered.
  • lastSync—the timestamp of the last received diagnostics update from the service point or the last time the service point polled for policy changes (in milliseconds).
  • connectionState—the connection state of the service point.
  • connectionStateLastChanged—the timestamp at which the service point was detected to have changed states (in milliseconds).
  • decommissioned—indicates whether the service point has been decommissioned.
  • ipAddresses—the IP addresses of the service interfaces.
    Note: Only 10 service IP addresses are returned.
  • loopbackIps—the loopback IP addresses that are explicitly configured.
    Note: Only 255 loopback IP addresses are returned.
  • hostManager—the host manager of the service point.
  • version—the version of the service point software that is currently running on the service point.
  • updateInitiatedTimestamp—the timestamp at which the last service point update was initiated (in milliseconds).
  • updateStatus—the last reported status of the service point update. The status can be one of the following:
    • CERTIFICATE_UPDATE_COMPLETED
    • CERTIFICATE_UPDATE_FAILED
    • CERTIFICATE_UPDATE_IN_PROGRESS
    • COMPLETED
    • FAILED
    • ROLLBACK_COMPLETED
    • ROLLBACK_FAILED
    • ROLLBACK_IN_PROGRESS
    • ROLLBACK_STARTED
    • STARTING_CERTIFICATE_UPDATE
    • STARTING_UPDATE
    • TIMED_OUT
      Attention: A service point returns the TIMED_OUT status when it could not return its update progress to the Site within 15 minutes of it starting the service point update. If at least one service point returns the TIMED_OUT state, the updateStatus of the Site from which it was deployed will return FAILED. The service point update status will continue to display the TIMED_OUT status until the next attempted update.
      If your service point returns the TIMED_OUT status:
      • Review the version field of the service point. If the version field of the service point matches the version field of the site, the update applied successfully but the updateStatus was not updated correctly, and no further action is required.
      • If the version field of the service point does not match the version field of the site, retry the service point update. For more information, refer to /v3/api/sites (PATCH).
      • If the connectionState of the service point is Disconnected, review the Cloud access requirements and connection between the service point and the BlueCat Edge Cloud to ensure that the service point can communicate with the BlueCat Edge Cloud. Once the service point connectionState returns CONNECTED, you can retry the service point update.

      If the issue persists and you can't successfully update the service point, contact BlueCat Customer Care for assistance.

    • UPDATE_CANCELLED
    • UPDATE_IN_PROGRESS
    • UPDATE_PLANNED
    Note: If a service point fails to update and returns an update status of ROLLBACK_FAILED, ROLLBACK_COMPLETED, TIMED_OUT, or FAILED, you can retry the service point update. For more information, refer to /v3/api/sites (PATCH).
Possible error codes
  • 401 Unauthorized
  • 500 Internal Server Error