Manage Endpoint

Manage Endpoint
API to manage (reconnect-with) the endpoint

Manage an endpoint. Possible action is reconnect with the endpoint. Reconnect action can be used to update the certificate of the endpoint.

Request
URI
POST
https://{api_host}/licensing/endpoints/{endpoint-id}
COPY
Path Parameters
string
endpoint-id
Required

Endpoint UUID

Query Parameters
string
action
Required

Action that needs to be taken on the endpoint. Supported action is 'reconnect'

Request Body

Endpoint action details. For reconnect action, only username, password and certificate fields will be used. All other fields will be ignored.

Endpoint of type(s) application/json
Required
This request body class requires all of the following: ManagedResource , InlineEndpoint1 
{
    "_create_user": "string",
    "_create_time": 0,
    "_last_modified_user": "string",
    "_last_modified_time": 0,
    "_revision": 0,
    "_resource_type": "string",
    "_system_owned": false,
    "id": "string",
    "display_name": "string",
    "description": "string",
    "site_ids": [
        "string"
    ],
    "endpoint_type": "string",
    "connection_info": {
        "connection_type": "string",
        "hostname": "string"
    },
    "status": "string"
}
Authentication
This operation uses the following authentication methods.
Responses
204

Requested action on endpoint is successful.

Operation doesn't return any data structure

400

Bad Request

Returns BadRequest of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


401

Unauthorized

Returns Unauthorized of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


403

Forbidden

Returns Forbidden of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


412

Precondition Failed

Returns PreconditionFailed of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


428

Precondition Required

Returns PreconditionRequired of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


429

Too Many Requests

Returns TooManyRequests of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


default

unexpected error

Returns Error of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/licensing/endpoints/{endpoint-id}
On This Page
Licensing Service Operations
POST
Onboard Endpoint
GET
List Endpoints
GET
Get Endpoint
POST
Manage Endpoint
DELETE
Offboard Endpoint