REST API - create

vstats endpoints: create

Creates a new endpoint record. 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

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

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

Body Parameters:

Name	Type	Description
bold = required
-	create_spec	Specification to configure a new endpoint with vStats.
-.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, no port will be provided.
-.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.
-.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 means no authentication is needed for the endpoint.
-.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.

Response:

HTTP Status Code: 201

Response Body Structure:

"obj-103"

Headers:

None

Type:

Name	Type	Description
bold = required
-	string	Identifier of the newly created endpoint configuration.

Errors:

HTTP Status Code	Type	Description
500	error	if the system reports an error while responding to the request.
400	invalid_argument	if `endpoint` contain any errors.
401	unauthenticated	if the user can not be authenticated.
403	unauthorized	if the user does not have sufficient privileges.