REST API - update

vstats endpoints: update

Updates an existing endpoint configuration. 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

PATCH https://{server}/api/stats/endpoints/{id}

{
    "port" : "string",
    "name" : "string",
    "push_data_format" : "string",
    "uri" : "string",
    "auth_data" : {
        "basic" : {
            "password" : "secret string",
            "username" : "string"
        },
        "token" : "secret string"
    },
    "status" : "ENABLED"
}

Path Parameters

Name	Type	Description
Required
id	string	Endpoint ID.

Body Parameters:

Name	Type	Description
bold = required
-	update_spec	Updated endpoint configuration.
-.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. Optional. If unset the value is unchanged.
-.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 the value is unchanged.
-.name	string	Designates the endpoint name to identify 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 the value is unchanged.
-.auth_data	auth_spec	Designates the authentication details 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 the value is unchanged.
-.auth_data.basic	basic_auth	Basic authentication details of the 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. When unset the `token` field will be used.
-.auth_data.basic.username	string	Username to get access to 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.
-.auth_data.basic.password	secret	Password to get access to 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.
-.auth_data.token	secret	Token based authentication information of the 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. When unset the `basic` field will be used.
-.push_data_format	string	Designates the type of data format supported for stats data at 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 the value is unchanged.
-.status	string	Endpoint status. 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 the value is unchanged.

Response:

HTTP Status Code: 204

Headers:

None

Type:

None

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.
404	not_found	if endpoint configuration could not be located.
401	unauthenticated	if the user can not be authenticated.
403	unauthorized	if the user does not have sufficient privileges.