Settings

The /Settings resource collection represents all VE Service and Collector settings.

Get VE Service Settings

The HTTP GET request to the /settings/GetManagerSettings endpoint retrieves a list of settings that apply to the VE Service.

SecurityuserAuth

Responses

200

401

Unauthorized

500

Internal Server Error

get/api/v1/settings/GetManagerSettings

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

[{"type": "Boolean",
"defaultValue": "False",
"parentValue": null,
"validateRegex": null,
"name": "ServiceProviderMode",
"value": "False"
},
{"type": "Number",
"defaultValue": "300",
"parentValue": null,
"validateRegex": "^\\d+$",
"name": "NetTimeout",
"value": "300"
},
{"type": "Number",
"defaultValue": "60",
"parentValue": null,
"validateRegex": "^\\d+$",
"name": "MaxLatencySpikesInSeconds",
"value": "60"
}
]

Save VE Service Settings

The HTTP POST request to the /settings/SaveManagerSettings endpoint saves the settings that apply to the VE Service.

SecurityuserAuth

Request

Request Body schema: application/json

required

Array of objects or null (SettingValue)

Names and values of the saved settings.

Responses

204

No Content

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/api/v1/settings/SaveManagerSettings

Request samples

application/json

{"settings": [{"name": "ServiceProviderMode",
"value": "True"
}
]
}

Response samples

application/json

{"message": "string"
}

Get Collector Settings

The HTTP POST request to the /settings/GetCollectorSettings/{id} endpoint retrieves a list of effective settings of a specific Collector. The response contains values that apply to the Collector after inherited settings are resolved.

SecurityuserAuth

Request

path Parameters

required

string <uuid>

Unique identifier assigned to a Collector.

Responses

200

401

Unauthorized

500

Internal Server Error

get/api/v1/settings/GetCollectorSettings/{id}

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"isInherited": false,
"settings": [{"type": "Number",
"defaultValue": "300",
"parentValue": "300",
"validateRegex": "^\\d+$",
"name": "CollectionInterval",
"value": "300"
},
{"type": "Boolean",
"defaultValue": "True",
"parentValue": "True",
"validateRegex": null,
"name": "EnablePerformanceCollection",
"value": "True"
}
]
}

Save Collector Settings

The HTTP POST request to the /settings/SaveCollectorSettings endpoint saves the settings of a Collector with the specified ID. Alternatively, you can also mark settings as isInherited. In this case, they will not be stored for the Collector explicitly.

SecurityuserAuth

Request

Request Body schema: application/json

id required	string or null ID assigned to a Collector or group.
isInherited required	boolean Defines whether to inherit settings from the parent level instead of using custom values.
required	Array of objects or null (SettingValue) Names and values of the saved settings.

Responses

204

No Content

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/api/v1/settings/SaveCollectorSettings

Request samples

application/json

{"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"isInherited": false,
"settings": [{"name": "CollectionInterval",
"value": "600"
}
]
}

Response samples

application/json

{"message": "string"
}

Get Collector Group Settings

The HTTP GET request to the /settings/GetGroupSettings/{name} endpoint retrieves the effective settings of a Collector group with the specified name. The response contains values that apply to the Collector after inherited settings are resolved.

SecurityuserAuth

Request

path Parameters

name

required

string

Name of the Collector group.

Responses

200

401

Unauthorized

500

Internal Server Error

get/api/v1/settings/GetGroupSettings/{name}

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"isInherited": false,
"settings": [{"type": "Number",
"defaultValue": "300",
"parentValue": "300",
"validateRegex": "^\\d+$",
"name": "CollectionInterval",
"value": "300"
},
{"type": "Boolean",
"defaultValue": "True",
"parentValue": "True",
"validateRegex": null,
"name": "EnablePerformanceCollection",
"value": "True"
}
]
}

Save Collector Group Settings

The HTTP POST request to the /settings/SaveGroupSettings endpoint saves the settings of a Collector group with the specified name. Alternatively, you can also mark settings as isInherited. In this case, they will not be stored for the Collector explicitly.

SecurityuserAuth

Request

Request Body schema: application/json

id required	string or null ID assigned to a Collector or group.
isInherited required	boolean Defines whether to inherit settings from the parent level instead of using custom values.
required	Array of objects or null (SettingValue) Names and values of the saved settings.

Responses

204

No Content

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/api/v1/settings/SaveGroupSettings

Request samples

application/json

{"id": "Default Group",
"isInherited": true,
"settings": [{"name": "CollectionInterval",
"value": "300"
}
]
}

Response samples

application/json

{"message": "string"
}

Get Global Default Settings

The HTTP GET request to the /settings/GetGlobalSettings endpoint retrieves the global default settings that apply to every Collector and group in case there are no settings that override them.

SecurityuserAuth

Responses

200

401

Unauthorized

500

Internal Server Error

get/api/v1/settings/GetGlobalSettings

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"isInherited": false,
"settings": [{"type": "Number",
"defaultValue": "300",
"parentValue": "300",
"validateRegex": "^\\d+$",
"name": "CollectionInterval",
"value": "300"
},
{"type": "Boolean",
"defaultValue": "True",
"parentValue": "True",
"validateRegex": null,
"name": "EnablePerformanceCollection",
"value": "True"
}
]
}

Save Global Default Settings

The HTTP POST request to the /settings/SaveGlobalSettings endpoint saves the global default settings that apply to every Collector and group in case there are no settings that override them.

SecurityuserAuth

Request

Request Body schema: application/json

required

Array of objects or null (SettingValue)

Names and values of the saved settings.

Responses

204

No Content

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/api/v1/settings/SaveGlobalSettings

Request samples

application/json

{"settings": [{"name": "ServiceProviderMode",
"value": "True"
}
]
}

Response samples

application/json

{"message": "string"
}