Retrieve a config

GET

/v1/config/{id}/

const url = 'https://example.com/v1/config/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/config/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/ \
  --header 'Authorization: Bearer <token>'

Return a single configuration entry by its ID.

Authorizations

jwtAuth
basicAuth

Parameters

Path Parameters

required

string format: uuid

A UUID string identifying this config.

Responses

200

application/json

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

object

required

string format: uuid

type

required

1 - Number of Servers
2 - Number of Monitors
3 - Number of Recording Rules
4 - Number of metrics for Recording Rules
5 - Log Size Limit (Bytes)
10 - Number of metrics per Agent Type
1010 - Docker Integration
1020 - AWS Integration
1030 - SNMP Integration
1040 - vSphere Integration
1050 - Log Integration
1051 - Log Retention Days
1060 - Custom Dashboard
1070 - Live Process Monitoring
1071 - Live Process Resolution (Seconds)
1080 - Weekly Report
1081 - Monthly Report
1090 - Public Status Page Integration
1100 - Forecast Linear Integration
1101 - Forecast Anomaly Integration
1200 - Metrics Display Limit
1201 - Metrics Retention Days
1300 - Events Display Limit
1301 - Events Retention Days
1400 - Number of Custom Metrics
1500 - Agent Requests Per Minute
1501 - Agent Requests Per Hour
1600 - User Requests Per Minute
1601 - User Requests Per Hour
1700 - Recording Rules Max Time
5000 - Active Integrations
10000 - Agent Metrics Allowlist
11000 - Agent Metrics Resolution

integer

>= -2147483648 <= 2147483647

Allowed values: 1 2 3 4 5 10 1010 1020 1030 1040 1050 1051 1060 1070 1071 1080 1081 1090 1100 1101 1200 1201 1300 1301 1400 1500 1501 1600 1601 1700 5000 10000 11000

account

string format: uuid

nullable

agent_type

string format: uuid

nullable

actual_count

required

integer

nullable

value

nullable

Example

{
  "type": 1
}