Skip to main content

Data Owner / Degraded Detection Config

Reference for the data_owner/degraded_detection_config endpoints of the Surfmeter API.

Surfmeter API – Data Owner / Degraded Detection Config v1

The Surfmeter API lets you manage clients, users, capabilities, measurements, and organization-wide settings programmatically.


Servers​

Description URL
https://surfmeter-server.{host}/client_admin_api/v1 https://surfmeter-server.{host}/client_admin_api/v1

Data Owner / Degraded Detection Config​


GET /data_owner/degraded_detection_config​

Input parameters

Parameter In Type Default Nullable Description
ApiKeyAuth header string N/A No API key used on every request. Create keys in the Surfmeter Dashboard under Keys → Surfmeter API Keys.

Response 200 OK


PUT /data_owner/degraded_detection_config​

Input parameters

Parameter In Type Default Nullable Description
ApiKeyAuth header string N/A No API key used on every request. Create keys in the Surfmeter Dashboard under Keys → Surfmeter API Keys.

Request body

{
"cpu_detection_enabled": true,
"memory_detection_enabled": true,
"disk_detection_enabled": true,
"cpu_warning_percent": 0,
"cpu_critical_percent": 0,
"memory_warning_percent": 0,
"memory_critical_percent": 0,
"disk_warning_percent": 0,
"disk_critical_percent": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body
{
"type": "object",
"additionalProperties": false,
"properties": {
"cpu_detection_enabled": {
"type": "boolean",
"nullable": true
},
"memory_detection_enabled": {
"type": "boolean",
"nullable": true
},
"disk_detection_enabled": {
"type": "boolean",
"nullable": true
},
"cpu_warning_percent": {
"type": "integer",
"nullable": true
},
"cpu_critical_percent": {
"type": "integer",
"nullable": true
},
"memory_warning_percent": {
"type": "integer",
"nullable": true
},
"memory_critical_percent": {
"type": "integer",
"nullable": true
},
"disk_warning_percent": {
"type": "integer",
"nullable": true
},
"disk_critical_percent": {
"type": "integer",
"nullable": true
}
}
}

Response 200 OK


Schemas​

DegradedDetectionConfigUpdateData​

Name Type
cpu_critical_percent integer| null
cpu_detection_enabled boolean| null
cpu_warning_percent integer| null
disk_critical_percent integer| null
disk_detection_enabled boolean| null
disk_warning_percent integer| null
memory_critical_percent integer| null
memory_detection_enabled boolean| null
memory_warning_percent integer| null

Security schemes​

<tr>
<td>ApiKeyAuth</td>
<td>apiKey</td>
<td></td>
<td>API key used on every request. Create keys in the Surfmeter Dashboard

under Keys → Surfmeter API Keys.

</tbody>
Name Type Scheme Description