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

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

Returns a list of all Service Point v4 instances.

Request: GET https://<us|eu>.fleet.bluec.at/user/api/v1/servicePoints
Authorization: Bearer token

Query parameters

Name Description Type Required
name The name of a specific service point. String Optional
serviceName The name of a specific service instance. String Optional

Successful response

200 OK
{
    "data": [
        {
            "id": "test_fsp_1-a9kf321st-abc2bcnab5pq",
            "name": "test_fsp_1",
            "description": "sp1 demo",
            "version": "4.4.0",
            "targetVersion": "4.5.0",
            "lastSeen": 1660667769314,
            "status": "HEALTHY",
            "connectionStatus": "CONNECTED",
            "updateStatus": "OK",
            "hostname": "testfsp1",
            "ipv4CIDRAddress": "1.2.3.22/24",
            "ipv4GatewayAddress": "1.2.3.1",
            "ipv6CIDRAddress": "",
            "ipv6GatewayAddress": "",
            "anycastIPAddresses": [
                {
                    "ipAddress": "192.168.0.99",
                    "interfaceName": "lo:1",
                    "inUseByAppId": "b77f4b15-beda-4095-9f41-26d86e2fcefc",
                    "isUp": true
                }
            ],
            "errorConditions": [],
            "applications": [
                {
                    "id": "12345678-ab12-3c4d-e5fa-593bb8bd604c",
                    "name": "dns-resolver-service",
                    "version": "3.8.0",
                    "status": "HEALTHY",
                    "targetVersion": "3.9.0",
                    "updateStatus": "OK",
                }
            ],
        },
        {
            "id": "sp2-00cc321dd-593bb8bd604c",
            "name": "sp2",
            "description": "sp2 demo",
            "version": "4.4.0",
            "targetVersion": "4.5.0",
            "lastSeen": 0,
            "status": "WAITING_FOR_PROVISIONING",
            "connectionStatus": "NOT_CONNECTED",
            "updateStatus": "OK",
            "hostname": "sp2",
            "ipv4CIDRAddress": "1.2.3.99/24",
            "ipv4GatewayAddress": "1.2.3.1",
            "ipv6CIDRAddress": "",
            "ipv6GatewayAddress": "",
            "anycastIPAddresses": [
                {
                    "ipAddress": "172.31.53.223",
                    "interfaceName": "lo:1",
                    "inUseByAppId": "1531c095-8240-4d68-ada3-40e7d73f064b",
                    "isUp": true
                }
            ],
            "errorConditions": [],
            "applications": [
                {
                    "id": "cb40b217-8c2e-4958-b1ec-36a0c821bee7",
                    "name": "dns-resolver-service",
                    "version": "3.5.1",
                    "status": "HEALTHY",
                    "errorConditions": [
                        "service is not healthy: parclo-logging 1.0.0-build1583",
                        "service is not healthy: dns-gateway-service 2.0.0-build3157"
                    ],
                    "targetVersion": "3.5.3",
                    "updateStatus": "UPDATE_QUEUED",
                }
            ],
        },
    ]
}
Where the fields represent the following:
  • id—the unique ID of the service point
  • name—the name of the service point
  • description—the description of the service point
  • version—the Service Point v4 version that is running on the service point
  • targetVersion—the Service Point v4 version to which the service point is to be updated
  • lastSeen—a timestamp representing the last time the management layer received a status update from the service point. If no timestamp is recorded, the value of this field is 0. The format of the field in a Unix timestamp in milliseconds elapsed since January 1, 1970 (UTC).
  • status—the status of the service point. The status can be one of the following:
    • WAITING_FOR_PROVISIONING
    • HEALTHY
    • UNHEALTHY
    • EXPIRED
  • connectionStatus—the connection status of the service point. The value can be one of the following:
    • CONNECTED
    • NOT_CONNECTED
  • updateStatus—the last reported status of the Service Point v4 update. The status can be one of the following:
    • OK
    • UPDATE_QUEUED
    • UPDATE_RUNNING
    • UPDATE_FAILED
  • hostname—the hostname of the device that the Service Point v4 is provisioned on
  • ipv4CIDRAddress—the IPv4 CIDR address of the service point
  • ipv4GatewayAddress—the IPv4 gateway address of the service point
  • ipv6CIDRAddress—the IPv6 CIDR address of the service point
  • ipv6GatewayAddress—the IPv6 gateway address of the service point
  • anycastIPAddress—a list of Anycast IP addresses. The list includes the following information:
    • ipAddress—the IPv4 or IPv6 address
    • interfaceName—the interface used for Anycast
    • isUseByAppId—the ID of the application using the Anycast IP address
    • isUp—indicates whether the Anycast IP address is up
  • errorConditions—a list of error conditions if the service point is not healthy
  • applications—the applications deployed to the service point. The applications field includes the following information:
    • id—the unique ID of application
    • name—the name of the application
    • version—the version of the application
    • status—the status of the application. The status can be one of the following:
      • HEALTHY
      • UNHEALTHY
      • DEPLOYING
      • DEPLOY_FAILED
      • DELETED
    • errorConditions—a list of error conditions if the application is not healthy
    • targetVersion—the version of the application software to which the application is to be updated
    • updateStatus—the last reported status of the application update. The status can be one of the following:
      • UPDATE_QUEUED
      • UPDATE_IN_PROGRESS
      • DELETE_QUEUED
      • DELETE_IN_PROGRESS
Possible error codes
  • 401 Unauthorized
  • 500 Internal Server Error