/api/v1/fleetInstances (GET) - BlueCat DNS Edge

Returns a list of all Fleet Service Points.

Request: GET https://us.fleet.bluec.at/user/api/v1/fleetInstances
Authorization: Bearer token

Query parameters

Name	Description	Type	Required
name	The name of a specific Fleet Service Point.	String	Optional

Successful response

200 OK
{
    "data": [
        {
            "applications": [
                {
                    "id": "12345678-ab12-3c4d-e5fa-593bb8bd604c",
                    "name": "dns-resolver-service",
                    "status": "HEALTHY",
                    "version": "3.5.4"
                }
            ],
            "connectionStatus": "CONNECTED",
            "errorConditions": [],
            "id": "test_fsp_1-a9kf321st-abc2bcnab5pq",
            "lastSeen": 1660667769314,
            "name": "test_fsp_1",
            "nodes": [
                {
                    "hostname": "testfsp1",
                    "ipv4CIDRAddress": "1.2.3.22/24",
                    "ipv4GatewayAddress": "1.2.3.1",
                    "ipv6CIDRAddress": "",
                    "ipv6GatewayAddress": "",
                    "name": "testfsp1.testlab.net"
                }
            ],
            "status": "HEALTHY",
            "updateStatus": "OK",
            "version": "4.1.1"
        },
        {
            "applications": [],
            "connectionStatus": "NOT_CONNECTED",
            "description": "Test Fleet Service Point",
            "errorConditions": [],
            "id": "test-sp1-7gnmy7wurn6qepz1wxisbw",
            "lastSeen": 1651177939,
            "name": "Test-SP1",
            "nodes": [
                {
                    "hostname": "test-sp1",
                    "ipv4CIDRAddress": "10.244.132.5/24",
                    "ipv4GatewayAddress": "10.244.132.1",
                    "ipv6CIDRAddress": "ffaf:89a:abcd:e12f:123:56ff:fe9b:0001/64",
                    "ipv6GatewayAddress": "",
                    "name": "test-sp1.bluecatnetworks.com"
                }
            ],
            "status": "HEALTHY",
            "updateStatus": "OK",
            "version": "1.0.1"
        }
    ]
}

Where the fields represent the following:

id—the unique ID of the Fleet Service Point
name—the name of the Fleet Service Point
description—the description of the Fleet Service Point
status—the status of the Fleet Service Point. The status can be one of the following:
- WAITING_FOR_PROVISIONING
- HEALTHY
- UNHEALTHY
- EXPIRED
lastSeen—a timestamp representing the last time the management layer received a status update from the Fleet 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).
connectionStatus—the connection status of the Fleet Service Point. The value can be one of the following:
- CONNECTED
- NOT_CONNECTED
version—the version of the Fleet Service Point software that is currently running on the Fleet Service Point.
targetVersion—the version of the Fleet Service Point software to which the Fleet Service Point is to be updated.
updateStatus—the last reported status of the Fleet Service Point update. The status can be one of the following:
- OK
- UPDATE_QUEUED
- UPDATE_RUNNING
- UPDATE_FAILED
errorConditions—a list of error conditions if the Fleet Service Point is not healthy
nodes—nodes that are part of the Fleet Service Point. The nodes section includes the following information:
- id—the unique ID of the node
- name—the name of the node
- hostname—the hostname of the node
- ipv4CIDRAddress—the IPv4 CIDR address of the Fleet Service Point node
- ipv4GatewayAddress—the IPv4 gateway address of the Fleet Service Point node
- ipv6CIDRAddress—the IPv6 CIDR address of the Fleet Service Point node
- ipv6GatewayAddress—the IPv6 gateway address of the Fleet Service Point node
- addresses—a list of IP addresses. The list of IP addresses includes the following information:
  - type—the type of IP address. The type can be one of the following:
    - PRIMARY
    - ANYCAST
    - ALIAS
  - ipAddress—the IPv4 or IPv6 address
  - isUseByAppId—the ID of the application using the Anycast IP address. This field is only included if the type is ANYCAST.
  - isUp—indicates whether the Anycast IP address is up. This field is only included if the type is ANYCAST.
applications—the applications deployed to the Fleet 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
anycastIPAddress—a list of Anycast IP addresses. The list includes the following information:
- ipAddress—the IPv4 or IPv6 address
- isUseByAppId—the ID of the application using the Anycast IP address
- isUp—indicates whether the Anycast IP address is up

Possible error codes

401 Unauthorized
500 Internal Server Error