Skip to main content

setEndpointLabel

This method sets a new label to an endpoint.

Parameters

Parameter

Type

Optional

Description

endpointId

String

No

The endpoint ID

label

String

No

A string representing the label. The maximum allowed length is 64 characters. Enter an empty string to reset a previously set label.

Return value

This method returns a Boolean which is True, when the label was successfully set.

Example

Request:

  {
       "params": {
           "endpointId": "5a30e7730041d70cc09f244b",
           "label": "label with url http://test.com?a=12&b=wow"
       },
       "jsonrpc": "2.0",
       "method": "setEndpointLabel",
       "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f"
  }

Response:

  {
      "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
      "jsonrpc":"2.0",
      "result": true
  }
In this section: