getEndpointTags
This method returns details about the endpoint tags within your company.
Parameters
Parameter | Description | Included in request | Type | Values |
|---|---|---|---|---|
| The criterion used to sort the returned endpoint tags. | Optional | String | Possible values:
Default value: |
| The sort order. | Optional | String | Possible values:
Default value: |
These are common parameters, available across all public API methods.
Parameter | Description | Included in request | Type | Value requirements |
|---|---|---|---|---|
| This parameter adds an identifier to the request, linking it to its corresponding response. The target replies with the same value in the response, allowing easy call tracking. | Mandatory | String | No additional requirements. |
| The name of the method you are using to send the request. | Mandatory | String | Must be a valid method name. |
| The version of JSON-RPC used by the request and the response. | Mandatory | String | The only possible value is |
| An object containing the configuration of the request. | Mandatory | Object | No additional requirements. |
Under the | ||||
| The results page number. | Optional | Integer | Default value: |
| The number of results displayed per page. | Optional | Integer | The upper limit is 100 items per page. Default value: |
Return value
Attribute | Type | Description |
|---|---|---|
| Array of Objects | Details about the endpoint tags within your company. For more information about each object in the array, refer to |
Objects
result
Attribute | Type | Description |
|---|---|---|
| String | The name of the endpoint tag. |
| Integer | The type of the endpoint tag. Possible values:
|
| String | The description of the endpoint tag. |
| Object | Details about the company associated with the endpoint tag. The object contains:
|
| String | The date and time when the endpoint tag was created. |
| Object | The rules used to define an Automatic endpoint tag. The object contains:
|
endpointName
Attribute | Type | Description |
|---|---|---|
| Boolean | Indicates whether the rule is active for the endpoint tag definition: |
| String | The endpoint name pattern that endpoints must match to receive this tag. Supports the ImportantIf the |
ip
Attribute | Type | Description |
|---|---|---|
| Boolean | Indicates whether the rule is active for the endpoint tag definition: |
| String | The IP address or CIDR range that endpoints must match to receive this tag. ImportantIf the |
os
Attribute | Type | Description |
|---|---|---|
| Boolean | Indicates whether the rule is active for the endpoint tag definition: |
| Integer | The operating system that endpoints must run to receive this tag. Possible values:
ImportantIf the |
endpointType
Attribute | Type | Description |
|---|---|---|
| Boolean | Indicates whether the rule is active for the endpoint tag definition: |
| Integer | The endpoint type required to receive this tag. Possible values:
ImportantIf the |
Example
Request:
{
"id": "7d2864e9-c67b-48a2-9ba3-0a11d47e83c8",
"jsonrpc": "2.0",
"method": "getEndpointTags",
"params": {
"page": 1,
"perPage": 30,
"orderBy": "name",
"order": "ASC"
}
} Response:
{
"jsonrpc": "2.0",
"result": [
{
"name": "Production Servers",
"type": 0,
"description": "All production server endpoints",
"company": {
"id": "66a0fe708d3a52774522b111",
"name": "Acme Corp"
},
"created": "2026-03-15T09:42:00+00:00"
},
{
"name": "Windows Workstations",
"type": 1,
"description": "Automatic tag for Windows workstations",
"company": {
"id": "66a0fe708d3a52774522b111",
"name": "Acme Corp"
},
"created": "2026-02-10T14:00:00+00:00",
"rules": {
"endpointName": {
"enabled": false,
"rule": "WIN-*"
},
"ip": {
"enabled": false,
"rule": null
},
"os": {
"enabled": true,
"rule": 3
},
"endpointType": {
"enabled": true,
"rule": 0
}
}
}
],
"id": "7d2864e9-c67b-48a2-9ba3-0a11d47e83c8"
}