/user/api/v1/servicePoints/{id} (GET)

Returns information about a specific Service Point v4 that has been registered based on the ID of the service point.

Request: GET https://us.fleet.bluec.at/user/api/v1/servicePoints/{id}
Authorization: Bearer token

Path parameter

Name	Description	Type	Required/Optional
id	The Service Point v4 ID	Integer	Required

Successful response

200 OK
{
    "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",
        }
    ],
}

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

/user/api/v1/servicePoints/{id} (GET) - BlueCat DNS Edge

DNS Edge User Guide (Service Point v4)