REST API - list
  1. Operations
  2. vstats
  3. endpoints

vstats endpoints: list

Returns information about all the endpoints configured with vStats. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

GET https://{server}/api/stats/endpoints

?name={value}
&push_data_format={value}
&status={value}

Query Parameters:

Name Type Description
bold = required
name string Endpoint name filter. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. When unset the result will not be filtered by endpoint name.
push_data_format string Push data format filter. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. When unset the result will not be filtered by push data format.
status string Endpoint status filter. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. When unset the result will not be filtered by endpoint status.

Response:

HTTP Status Code: 200

Response Body Structure:

[
    {
        "port" : "string",
        "acqspec_count" : "string",
        "name" : "string",
        "push_data_format" : "string",
        "id" : "obj-103",
        "status_reason" : "string",
        "uri" : "string",
        "auth_data" : {
            "basic" : {
                "password" : "secret string",
                "username" : "string"
            },
            "token" : "secret string"
        },
        "status" : "ENABLED"
    },
    {
        "port" : "string",
        "acqspec_count" : "string",
        "name" : "string",
        "push_data_format" : "string",
        "id" : "obj-103",
        "status_reason" : "string",
        "uri" : "string",
        "auth_data" : {
            "basic" : {
                "password" : "secret string",
                "username" : "string"
            },
            "token" : "secret string"
        },
        "status" : "ENABLED"
    }
]

Headers:

None

Type:

Name Type Description
bold = required
- info[] List of endpoint records.
-[].id string Endpoint identifier. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vstats.model.Endpoint. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vstats.model.Endpoint.
-[].uri string Designates the uniform resource identifier of an endpoint. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-[].port string Designates the port of an endpoint. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. If unset, there is no port provided.

Errors:

HTTP Status Code Type Description
500 error if the system reports an error while responding to the request.
400 invalid_argument if any of the specified parameters are invalid.
401 unauthenticated if the user can not be authenticated.
403 unauthorized if the user does not have sufficient privileges.