Retrieve Microsoft SQL Server host

get deprecatedhttps://{region}.api.clumio.com/connections/mssql/hosts/{host_id}

Returns a representation of the specified Microsoft SQL Server host.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

_links

object

URLs to pages related to the resource.

_self

object

The HATEOAS link to this resource.

discovered_endpoints

array of strings

The endpoints discovered post the host connection of the host.

discovered_endpoints

edge_connector_version

string

The Current MSI version of the edge connector installed in the host.

endpoint

string

The user-provided endpoint used to connect the host.

group_id

string

The Clumio-assigned ID of the management group associated with the host.

string

The Clumio-assigned ID of the Host.

last_heartbeat_timestamp

date-time

The timestamp of the last successful heartbeat of this host. Represented in RFC-3339 format.

name

string

Name of the Host.

operational_status

string

The operational status of the Host. Possible values include upgrade_in_progress, upgrade_success, upgrade_failed, delete_in_progress, delete_failed, move_in_progress, move_succeeded and move_failed.

status

string

The connection status of the Host. Possible values include connected, disconnected, connection_pending, and invalid_token.

subgroup_id

string

The Clumio-assigned ID of the subgroup associated with the host.

uuid

string

The Clumio-assigned UUID of the host. This UUID is used for filtering hosts during list operations.

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://us-west-2.api.clumio.com/connections/mssql/hosts/host_id \
3
     --header 'accept: application/api.clumio.mssql-hosts=v1+json'


xxxxxxxxxx
22
 
1
{
2
  "_links": {
3
    "_self": {
4
      "href": "string",
5
      "templated": true,
6
      "type": "string"
7
    }
8
  },
9
  "discovered_endpoints": [
10
    "string"
11
  ],
12
  "edge_connector_version": "string",
13
  "endpoint": "string",
14
  "group_id": "string",
15
  "id": "string",
16
  "last_heartbeat_timestamp": "2025-04-26T19:39:05.494Z",
17
  "name": "string",
18
  "operational_status": "string",
19
  "status": "string",
20
  "subgroup_id": "string",
21
  "uuid": "string"
22
}

200200 HTTP success response

defaultError