API docs by Redocly

VMonitor-api Documentation (1.0)

Download OpenAPI specification:Download

VMonitor-api Documentation

Alarm Endpoint

Alarm Endpoint

getListAlarm

query Parameters
name
string

name

page
integer <int32>

page

severity
string

severity

size
integer <int32>

size

status
string

status

type-alarm
string

type-alarm

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/alarms/list',
  qs: {
    name: 'SOME_STRING_VALUE',
    page: 'SOME_INTEGER_VALUE',
    severity: 'SOME_STRING_VALUE',
    size: 'SOME_INTEGER_VALUE',
    status: 'SOME_STRING_VALUE',
    'type-alarm': 'SOME_STRING_VALUE'
  },
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

createAlarmLog

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

condition
string
description
string
object
groupByField
string
inAlarm
string
logProjectId
string
logSearchQuery
string
metricAggKey
string
metricAggType
string
name
string
ok
string
projectName
string
queryString
string
reason
string
severity
string
thresholdType
string
thresholdValue
integer <int32>
timeFrame
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "condition": "string",
  • "description": "string",
  • "filter": {
    },
  • "groupByField": "string",
  • "inAlarm": "string",
  • "logProjectId": "string",
  • "logSearchQuery": "string",
  • "metricAggKey": "string",
  • "metricAggType": "string",
  • "name": "string",
  • "ok": "string",
  • "projectName": "string",
  • "queryString": "string",
  • "reason": "string",
  • "severity": "string",
  • "thresholdType": "string",
  • "thresholdValue": 0,
  • "timeFrame": 0
}

getAlarmButlerHistoryById

path Parameters
alarmId
required
string

alarmId

query Parameters
end
string

end

len
string

len

order
string

order

page
string

page

start
string

start

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/alarms/logs/butler/{alarmId}/histories',
  qs: {
    end: 'SOME_STRING_VALUE',
    len: 'SOME_STRING_VALUE',
    order: 'SOME_STRING_VALUE',
    page: 'SOME_STRING_VALUE',
    start: 'SOME_STRING_VALUE'
  },
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getAlarmButlerStatusById

path Parameters
alarmId
required
string

alarmId

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/alarms/logs/butler/{alarmId}/status',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

editAlarmLog

path Parameters
alarmId
required
string

alarmId

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

condition
string
description
string
object
groupByField
string
id
string
inAlarm
string
logProjectId
string
logSearchQuery
string
metricAggKey
string
metricAggType
string
name
string
ok
string
projectName
string
queryString
string
reason
string
severity
string
thresholdType
string
thresholdValue
integer <int32>
timeFrame
integer <int32>
zone
string

Responses

Request samples

Content type
application/json
{
  • "condition": "string",
  • "description": "string",
  • "filter": {
    },
  • "groupByField": "string",
  • "id": "string",
  • "inAlarm": "string",
  • "logProjectId": "string",
  • "logSearchQuery": "string",
  • "metricAggKey": "string",
  • "metricAggType": "string",
  • "name": "string",
  • "ok": "string",
  • "projectName": "string",
  • "queryString": "string",
  • "reason": "string",
  • "severity": "string",
  • "thresholdType": "string",
  • "thresholdValue": 0,
  • "timeFrame": 0,
  • "zone": "string"
}

deleteAlarmLog

path Parameters
alarm_id
required
string

alarm_id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/alarms/logs/{alarm_id}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getByMappingId

path Parameters
mappingId
required
string

mappingId

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/alarms/mapping/{mappingId}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

createAlarmMetric

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

checkTime
integer <int32>
condition
string
description
string
inAlarm
string
interval
integer <int64>
object
metricGroupBy
string
metricName
string
metricPeriod
integer <int32>
metricProduct
string
metricStatistic
string
name
string
ok
string
resendEnabled
boolean
resendPeriod
integer <int64>
resendStatus
string
resendTimes
integer <int32>
severity
string
thresholdMethod
string
thresholdValue
number <float>
undetermined
string

Responses

Request samples

Content type
application/json
{
  • "checkTime": 0,
  • "condition": "string",
  • "description": "string",
  • "inAlarm": "string",
  • "interval": 0,
  • "metricFilter": {
    },
  • "metricGroupBy": "string",
  • "metricName": "string",
  • "metricPeriod": 0,
  • "metricProduct": "string",
  • "metricStatistic": "string",
  • "name": "string",
  • "ok": "string",
  • "resendEnabled": true,
  • "resendPeriod": 0,
  • "resendStatus": "string",
  • "resendTimes": 0,
  • "severity": "string",
  • "thresholdMethod": "string",
  • "thresholdValue": 0.1,
  • "undetermined": "string"
}

getAlarmMetricDefinitionById

path Parameters
alarmId
required
string

alarmId

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/alarms/metrics/mona/{alarmId}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getAlarmMetricHistoryById

path Parameters
alarmId
required
string

alarmId

query Parameters
end_time
string

end_time

interval
string

interval

start_time
string

start_time

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/alarms/metrics/mona/{alarmId}/histories',
  qs: {
    end_time: 'SOME_STRING_VALUE',
    interval: 'SOME_STRING_VALUE',
    start_time: 'SOME_STRING_VALUE'
  },
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

deleteAlarmInMonasca

path Parameters
alarm_id
required
string

alarm_id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/alarms/metrics/sub-alarms/{alarm_id}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

editAlarmMetric

path Parameters
alarmId
required
string

alarmId

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

checkTime
integer <int32>
condition
string
description
string
id
string
inAlarm
string
interval
integer <int64>
metricPeriod
integer <int32>
metricProduct
string
name
string
ok
string
resendEnabled
boolean
resendPeriod
integer <int64>
resendStatus
string
resendTimes
integer <int32>
severity
string
thresholdMethod
string
thresholdValue
number <float>
undetermined
string

Responses

Request samples

Content type
application/json
{
  • "checkTime": 0,
  • "condition": "string",
  • "description": "string",
  • "id": "string",
  • "inAlarm": "string",
  • "interval": 0,
  • "metricPeriod": 0,
  • "metricProduct": "string",
  • "name": "string",
  • "ok": "string",
  • "resendEnabled": true,
  • "resendPeriod": 0,
  • "resendStatus": "string",
  • "resendTimes": 0,
  • "severity": "string",
  • "thresholdMethod": "string",
  • "thresholdValue": 0.1,
  • "undetermined": "string"
}

deleteAlarmMetric

path Parameters
alarm_id
required
string

alarm_id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/alarms/metrics/{alarm_id}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getAlarmSyntheticMetricDefinitionById

path Parameters
alarmId
required
string

alarmId

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/alarms/synthetic/metrics/mona/{alarmId}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getAlarmSyntheticMetricHistoryById

path Parameters
alarmId
required
string

alarmId

query Parameters
end_time
string

end_time

interval
string

interval

start_time
string

start_time

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/alarms/synthetic/metrics/mona/{alarmId}/histories',
  qs: {
    end_time: 'SOME_STRING_VALUE',
    interval: 'SOME_STRING_VALUE',
    start_time: 'SOME_STRING_VALUE'
  },
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getAlarmById

path Parameters
alarmId
required
string

alarmId

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/alarms/{alarmId}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Api Key Endpoint

Api Key Endpoint

createMetricApiKey

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

description
string
name
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string"
}

getListMetricApiKey

query Parameters
name
string

name

page
integer <int32>

page

size
integer <int32>

size

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/apikeys/metric/list',
  qs: {
    name: 'SOME_STRING_VALUE',
    page: 'SOME_INTEGER_VALUE',
    size: 'SOME_INTEGER_VALUE'
  },
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

deleteAlarmMetric

path Parameters
key
required
string

key

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/apikeys/metric/{key}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Change Alarm Endpoint

Change Alarm Endpoint

createChangeAlarmMetric

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

checkTime
integer <int32>
condition
string
description
string
inAlarm
string
interval
integer <int64>
object
metricGroupBy
string
metricName
string
metricPeriod
integer <int32>
metricProduct
string
metricStatistic
string
name
string
ok
string
severity
string
thresholdMethod
string
thresholdValue
number <float>
timeshift
integer <int32>
undetermined
string

Responses

Request samples

Content type
application/json
{
  • "checkTime": 0,
  • "condition": "string",
  • "description": "string",
  • "inAlarm": "string",
  • "interval": 0,
  • "metricFilter": {
    },
  • "metricGroupBy": "string",
  • "metricName": "string",
  • "metricPeriod": 0,
  • "metricProduct": "string",
  • "metricStatistic": "string",
  • "name": "string",
  • "ok": "string",
  • "severity": "string",
  • "thresholdMethod": "string",
  • "thresholdValue": 0.1,
  • "timeshift": 0,
  • "undetermined": "string"
}

getAlarmMetricDefinitionById

path Parameters
alarmId
required
string

alarmId

query Parameters
end_time
required
integer <int64>

end_time

start_time
required
integer <int64>

start_time

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/alarms/change-method/{alarmId}',
  qs: {end_time: 'SOME_INTEGER_VALUE', start_time: 'SOME_INTEGER_VALUE'},
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getAlarmMetricHistoryById

path Parameters
alarmId
required
string

alarmId

query Parameters
end_time
required
string

end_time

interval
string

interval

start_time
required
string

start_time

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/alarms/change-method/{alarmId}/histories',
  qs: {
    end_time: 'SOME_STRING_VALUE',
    interval: 'SOME_STRING_VALUE',
    start_time: 'SOME_STRING_VALUE'
  },
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

deleteAlarmMetricHistoryById

path Parameters
alarmId
required
string

alarmId

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/alarms/change-method/{alarmId}/histories',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

updateChangeAlarmMetric

path Parameters
alarm_id
required
string

alarm_id

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

checkTime
integer <int32>
condition
string
description
string
id
string
inAlarm
string
interval
integer <int64>
metricPeriod
integer <int32>
metricProduct
string
name
string
ok
string
severity
string
thresholdMethod
string
thresholdValue
number <float>
timeshift
integer <int32>
undetermined
string

Responses

Request samples

Content type
application/json
{
  • "checkTime": 0,
  • "condition": "string",
  • "description": "string",
  • "id": "string",
  • "inAlarm": "string",
  • "interval": 0,
  • "metricPeriod": 0,
  • "metricProduct": "string",
  • "name": "string",
  • "ok": "string",
  • "severity": "string",
  • "thresholdMethod": "string",
  • "thresholdValue": 0.1,
  • "timeshift": 0,
  • "undetermined": "string"
}

deleteChangeAlarmMetric

path Parameters
alarm_id
required
string

alarm_id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/alarms/change-method/{alarm_id}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Dashboard Endpoint

Dashboard Endpoint

getList

query Parameters
filter
string

filter

page
integer <int32>

page

searching-field
string

searching-field

searching-text
string

searching-text

size
integer <int32>

size

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/dashboards',
  qs: {
    filter: 'SOME_STRING_VALUE',
    page: 'SOME_INTEGER_VALUE',
    'searching-field': 'SOME_STRING_VALUE',
    'searching-text': 'SOME_STRING_VALUE',
    size: 'SOME_INTEGER_VALUE'
  },
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

create

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

endTime
string <date-time>
extra
object
name
string
period
integer <int32>
startTime
string <date-time>
userAction
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "endTime": "2019-08-24T14:15:22Z",
  • "extra": { },
  • "name": "string",
  • "period": 0,
  • "startTime": "2019-08-24T14:15:22Z",
  • "userAction": 0
}

editDashboard

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

darkMode
boolean
favorite
boolean
id
string
name
string
refreshActive
boolean
refreshInterval
integer <int32>
timeRange
string
timeRangeType
string
viewSelectedId
string

Responses

Request samples

Content type
application/json
{
  • "darkMode": true,
  • "favorite": true,
  • "id": "string",
  • "name": "string",
  • "refreshActive": true,
  • "refreshInterval": 0,
  • "timeRange": "string",
  • "timeRangeType": "string",
  • "viewSelectedId": "string"
}

cloneDashboard

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

id
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

createDashboardDefault

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

appName
string
endTime
string <date-time>
extra
object
hostName
string
logProjectId
string
os
string
period
integer <int32>
startTime
string <date-time>
userAction
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "appName": "string",
  • "endTime": "2019-08-24T14:15:22Z",
  • "extra": { },
  • "hostName": "string",
  • "logProjectId": "string",
  • "os": "string",
  • "period": 0,
  • "startTime": "2019-08-24T14:15:22Z",
  • "userAction": 0
}

createDashboardDefaultInfrastructure

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

extra
object
product
string
resourceId
string
resourceName
string

Responses

Request samples

Content type
application/json
{
  • "extra": { },
  • "product": "string",
  • "resourceId": "string",
  • "resourceName": "string"
}

favoriteDashboard

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

favorite
boolean
id
string

Responses

Request samples

Content type
application/json
{
  • "favorite": true,
  • "id": "string"
}

getDashboardByName

path Parameters
name
required
string

name

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/dashboards/name/{name}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

deleteDashboardByResourceId

path Parameters
resourceId
required
string

resourceId

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/dashboards/name/{resourceId}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

rename

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

id
string
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

deleteDashboard

path Parameters
dashboard_id
required
string

dashboard_id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/dashboards/{dashboard_id}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getDashboardById

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/dashboards/{id}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Infrastructure Endpoint

Infrastructure Endpoint

getListHost

query Parameters
page
integer <int32>

page

searching_text
string

searching_text

size
integer <int32>

size

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/hosts',
  qs: {
    page: 'SOME_INTEGER_VALUE',
    searching_text: 'SOME_STRING_VALUE',
    size: 'SOME_INTEGER_VALUE'
  },
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getHostById

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/hosts/{id}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

deleteHostById

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/hosts/{id}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

disableHostById

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'PUT',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/hosts/{id}/disabled',
  headers: {
    accept: 'application/json',
    'content-type': '*/*',
    Authorization: 'SOME_STRING_VALUE'
  }
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

enableHostById

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'PUT',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/hosts/{id}/enabled',
  headers: {
    accept: 'application/json',
    'content-type': '*/*',
    Authorization: 'SOME_STRING_VALUE'
  }
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getMoreInfoHostById

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/hosts/{id}/metric',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getListVasHost

query Parameters
name
string

name

page
integer <int32>

page

size
integer <int32>

size

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/vas/hosts',
  qs: {
    name: 'SOME_STRING_VALUE',
    page: 'SOME_INTEGER_VALUE',
    size: 'SOME_INTEGER_VALUE'
  },
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

updateVasHost

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

deleteVasHostById

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/vas/hosts/{id}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getMoreInfoVasHostById

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/vas/hosts/{id}/metric',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getListVbackupHost

query Parameters
name
string

name

page
integer <int32>

page

size
integer <int32>

size

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/vbackup/hosts',
  qs: {
    name: 'SOME_STRING_VALUE',
    page: 'SOME_INTEGER_VALUE',
    size: 'SOME_INTEGER_VALUE'
  },
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

updateVbackupHost

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

deleteVbackupHostById

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/vbackup/hosts/{id}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getMoreInfoVbackupHostById

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/vbackup/hosts/{id}/metric',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getListVbandwidthHost

query Parameters
name
string

name

page
integer <int32>

page

size
integer <int32>

size

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/vbandwidth/hosts',
  qs: {
    name: 'SOME_STRING_VALUE',
    page: 'SOME_INTEGER_VALUE',
    size: 'SOME_INTEGER_VALUE'
  },
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

updateVbandwidthHost

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

deleteVbandwidthHostById

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/vbandwidth/hosts/{id}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getMoreInfoVbandwidthHostById

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/vbandwidth/hosts/{id}/metric',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getListVdbHost

query Parameters
name
string

name

page
integer <int32>

page

size
integer <int32>

size

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/vdb/hosts',
  qs: {
    name: 'SOME_STRING_VALUE',
    page: 'SOME_INTEGER_VALUE',
    size: 'SOME_INTEGER_VALUE'
  },
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

updateVdbHost

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

deleteVdbHostById

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/vdb/hosts/{id}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getMoreInfoVdbHostById

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/vdb/hosts/{id}/metric',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getListVlbHost

query Parameters
name
string

name

page
integer <int32>

page

size
integer <int32>

size

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/vlb/hosts',
  qs: {
    name: 'SOME_STRING_VALUE',
    page: 'SOME_INTEGER_VALUE',
    size: 'SOME_INTEGER_VALUE'
  },
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

updateVlbHost

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

deleteVlbHostById

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/vlb/hosts/{id}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getMoreInfoVlbHostById

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/vlb/hosts/{id}/metric',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getListVserverHost

query Parameters
name
string

name

page
integer <int32>

page

size
integer <int32>

size

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/vserver/hosts',
  qs: {
    name: 'SOME_STRING_VALUE',
    page: 'SOME_INTEGER_VALUE',
    size: 'SOME_INTEGER_VALUE'
  },
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

updateVserverHost

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

deleteVserverHostById

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/vserver/hosts/{id}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getMoreInfoVserverHostById

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/vserver/hosts/{id}/metric',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getListVstorageHost

query Parameters
name
string

name

page
integer <int32>

page

size
integer <int32>

size

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/vstorage/hosts',
  qs: {
    name: 'SOME_STRING_VALUE',
    page: 'SOME_INTEGER_VALUE',
    size: 'SOME_INTEGER_VALUE'
  },
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

updateVstorageHost

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

deleteVstorageHostById

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/vstorage/hosts/{id}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getMoreInfoVstorageHostById

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/infrastructure/vstorage/hosts/{id}/metric',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Integration Endpoint

Integration Endpoint

installIntegration

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

appInstallRequest

logProjectId
string

Responses

Request samples

Content type
application/json
{
  • "logProjectId": "string"
}

getList

query Parameters
page
integer <int32>

page

size
integer <int32>

size

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/integrations/list',
  qs: {page: 'SOME_INTEGER_VALUE', size: 'SOME_INTEGER_VALUE'},
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

uninstallIntegration

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'PUT',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/integrations/uninstall/{id}',
  headers: {
    accept: 'application/json',
    'content-type': '*/*',
    Authorization: 'SOME_STRING_VALUE'
  }
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getIntegrationById

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/integrations/{id}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

deleteIntegration

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/integrations/{id}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Metric Endpoint

Metric Endpoint

getMetricDimensions

query Parameters
dimensions
string

dimensions

end_time
string

end_time

name
required
string

name

start_time
string

start_time

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/metrics/dimensions',
  qs: {
    dimensions: 'SOME_STRING_VALUE',
    end_time: 'SOME_STRING_VALUE',
    name: 'SOME_STRING_VALUE',
    start_time: 'SOME_STRING_VALUE'
  },
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

listMetricDimensionNames

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/metrics/dimensions-names',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

listMetricDimensionValues

query Parameters
dimension_name
required
string

dimension_name

dimensions
string

dimensions

end_time
string

end_time

start_time
string

start_time

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/metrics/dimensions-values',
  qs: {
    dimension_name: 'SOME_STRING_VALUE',
    dimensions: 'SOME_STRING_VALUE',
    end_time: 'SOME_STRING_VALUE',
    start_time: 'SOME_STRING_VALUE'
  },
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getMetricNames

query Parameters
end_time
string

end_time

start_time
string

start_time

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/metrics/metric-name',
  qs: {end_time: 'SOME_STRING_VALUE', start_time: 'SOME_STRING_VALUE'},
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Metric Unit Endpoint

Metric Unit Endpoint

getList

query Parameters
page
integer <int32>

page

size
integer <int32>

size

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/metricUnits/list',
  qs: {page: 'SOME_INTEGER_VALUE', size: 'SOME_INTEGER_VALUE'},
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Metric Unit Mapping Endpoint

Metric Unit Mapping Endpoint

getList

query Parameters
isDefault
boolean

isDefault

name
string

name

page
integer <int32>

page

size
integer <int32>

size

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/metric-unit-mappings/list',
  qs: {
    isDefault: 'SOME_BOOLEAN_VALUE',
    name: 'SOME_STRING_VALUE',
    page: 'SOME_INTEGER_VALUE',
    size: 'SOME_INTEGER_VALUE'
  },
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Metric Unit Mapping User Endpoint

Metric Unit Mapping User Endpoint

createUnitMapping

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

description
string
metricName
string
unit
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "metricName": "string",
  • "unit": "string"
}

deleteUnitMapping

path Parameters
id
required
string

id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/metric-unit-mapping-users/{id}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Statistic Endpoint

Statistic Endpoint

getStatistics

query Parameters
alarm
string

alarm

dimensions
string

dimensions

end_time
string

end_time

group_by
string

group_by

limit
string

limit

name
string

name

period
string

period

start_time
string

start_time

statistics
string

statistics

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/statistics',
  qs: {
    alarm: 'SOME_STRING_VALUE',
    dimensions: 'SOME_STRING_VALUE',
    end_time: 'SOME_STRING_VALUE',
    group_by: 'SOME_STRING_VALUE',
    limit: 'SOME_STRING_VALUE',
    name: 'SOME_STRING_VALUE',
    period: 'SOME_STRING_VALUE',
    start_time: 'SOME_STRING_VALUE',
    statistics: 'SOME_STRING_VALUE'
  },
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

getStatisticsV2

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

data
object
type
string

Responses

Request samples

Content type
application/json
{
  • "data": { },
  • "type": "string"
}

getStatisticsSynthetic

query Parameters
alarm
string

alarm

dimensions
string

dimensions

end_time
string

end_time

group_by
string

group_by

name
string

name

period
string

period

start_time
string

start_time

statistics
string

statistics

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/statistics/synthetics',
  qs: {
    alarm: 'SOME_STRING_VALUE',
    dimensions: 'SOME_STRING_VALUE',
    end_time: 'SOME_STRING_VALUE',
    group_by: 'SOME_STRING_VALUE',
    name: 'SOME_STRING_VALUE',
    period: 'SOME_STRING_VALUE',
    start_time: 'SOME_STRING_VALUE',
    statistics: 'SOME_STRING_VALUE'
  },
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Variable Endpoint

Variable Endpoint

list

path Parameters
dashboard_id
required
string

dashboard_id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/dashboards/{dashboard_id}/variables',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

updateList

path Parameters
dashboard_id
required
string

dashboard_id

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

request

Array of objects (VariableDto)

Responses

Request samples

Content type
application/json
{
  • "variables": [
    ]
}

get

path Parameters
dashboard_id
required
string

dashboard_id

variable_id
required
string

variable_id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/dashboards/{dashboard_id}/variables/{variable_id}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

View Endpoint

View Endpoint

list

path Parameters
dashboard_id
required
string

dashboard_id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/dashboards/{dashboard_id}/views',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

create

path Parameters
dashboard_id
required
string

dashboard_id

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

request

filters
string
name
string
query
string
timeRange
string
object

Responses

Request samples

Content type
application/json
{
  • "filters": "string",
  • "name": "string",
  • "query": "string",
  • "timeRange": "string",
  • "variables": {
    }
}

get

path Parameters
dashboard_id
required
string

dashboard_id

view_id
required
string

view_id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/dashboards/{dashboard_id}/views/{view_id}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

update

path Parameters
dashboard_id
required
string

dashboard_id

view_id
required
string

view_id

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

request

filters
string
query
string
timeRange
string
Array of objects (VariableRequest)

Responses

Request samples

Content type
application/json
{
  • "filters": "string",
  • "query": "string",
  • "timeRange": "string",
  • "variables": [
    ]
}

delete

path Parameters
dashboard_id
required
string

dashboard_id

view_id
required
string

view_id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/dashboards/{dashboard_id}/views/{view_id}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Widget Endpoint

Widget Endpoint

editLayoutWidget

path Parameters
widget_id
required
string

widget_id

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

endTime
string <date-time>
extra
object
id
string
layout
string
period
integer <int32>
startTime
string <date-time>
userAction
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "endTime": "2019-08-24T14:15:22Z",
  • "extra": { },
  • "id": "string",
  • "layout": "string",
  • "period": 0,
  • "startTime": "2019-08-24T14:15:22Z",
  • "userAction": 0
}

getWidgetById

path Parameters
widget_id
required
string

widget_id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'GET',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/dashboards/{dashboard_id}/widgets/{widget_id}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

editWidget

path Parameters
widget_id
required
string

widget_id

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

chartExtra
string
connectNulls
boolean
endTime
string <date-time>
extra
object
fixedTimeRange
string
id
string
Array of objects (LogGraphForUpdateWidget)
Array of objects (MetricGraphForUpdateWidget)
name
string
period
integer <int32>
periodWidget
integer <int32>
position
string
showDataLabel
boolean
smooth
boolean
startTime
string <date-time>
type
string
typeChart
string
userAction
integer <int64>
yAxisLabel
string
yAxisMax
integer <int64>
yAxisMin
integer <int64>
yAxisScaleType
string
yAxisType
string

Responses

Request samples

Content type
application/json
{
  • "chartExtra": "string",
  • "connectNulls": true,
  • "endTime": "2019-08-24T14:15:22Z",
  • "extra": { },
  • "fixedTimeRange": "string",
  • "id": "string",
  • "logGraphs": [
    ],
  • "metricGraphs": [
    ],
  • "name": "string",
  • "period": 0,
  • "periodWidget": 0,
  • "position": "string",
  • "showDataLabel": true,
  • "smooth": true,
  • "startTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "typeChart": "string",
  • "userAction": 0,
  • "yAxisLabel": "string",
  • "yAxisMax": 0,
  • "yAxisMin": 0,
  • "yAxisScaleType": "string",
  • "yAxisType": "string"
}

deleteWidget

path Parameters
widget_id
required
string

widget_id

header Parameters
Authorization
required
string

Access Token

Responses

Request samples 

const request = require('request');

const options = {
  method: 'DELETE',
  url: 'https://vmonitorapis.vngcloud.vn/vmonitor-api/api/v1/dashboards/{dashboard_id}/widgets/{widget_id}',
  headers: {'content-type': '*/*', Authorization: 'SOME_STRING_VALUE'}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Widget Version 2 Endpoint

Widget V 2 Endpoint

createWidgetV2

path Parameters
dashboard_id
required
string

dashboard_id

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

chartExtra
string
connectNulls
boolean
dashboardId
string
description
string
endTime
string <date-time>
extra
object
fixedTimeRange
string
object
layout
string
name
string
period
integer <int32>
periodWidget
integer <int32>
position
string
showDataLabel
boolean
smooth
boolean
startTime
string <date-time>
topListChart
object (JsonNode)
type
string
typeChart
string
userAction
integer <int64>
yAxisLabel
string
yAxisMax
integer <int64>
yAxisMin
integer <int64>
yAxisScaleType
string
yAxisType
string

Responses

Request samples

Content type
application/json
{
  • "chartExtra": "string",
  • "connectNulls": true,
  • "dashboardId": "string",
  • "description": "string",
  • "endTime": "2019-08-24T14:15:22Z",
  • "extra": { },
  • "fixedTimeRange": "string",
  • "graphs": {
    },
  • "layout": "string",
  • "name": "string",
  • "period": 0,
  • "periodWidget": 0,
  • "position": "string",
  • "showDataLabel": true,
  • "smooth": true,
  • "startTime": "2019-08-24T14:15:22Z",
  • "topListChart": { },
  • "type": "string",
  • "typeChart": "string",
  • "userAction": 0,
  • "yAxisLabel": "string",
  • "yAxisMax": 0,
  • "yAxisMin": 0,
  • "yAxisScaleType": "string",
  • "yAxisType": "string"
}

editWidget

path Parameters
widget_id
required
string

widget_id

header Parameters
Authorization
required
string

Access Token

Request Body schema: application/json
required

req

chartExtra
string
connectNulls
boolean
description
string
fixedTimeRange
string
object
id
string
name
string
periodWidget
integer <int32>
position
string
showDataLabel
boolean
smooth
boolean
topListChart
object (JsonNode)
type
string
typeChart
string
yAxisLabel
string
yAxisMax
integer <int64>
yAxisMin
integer <int64>
yAxisScaleType
string
yAxisType
string

Responses

Request samples

Content type
application/json
{
  • "chartExtra": "string",
  • "connectNulls": true,
  • "description": "string",
  • "fixedTimeRange": "string",
  • "graphs": {
    },
  • "id": "string",
  • "name": "string",
  • "periodWidget": 0,
  • "position": "string",
  • "showDataLabel": true,
  • "smooth": true,
  • "topListChart": { },
  • "type": "string",
  • "typeChart": "string",
  • "yAxisLabel": "string",
  • "yAxisMax": 0,
  • "yAxisMin": 0,
  • "yAxisScaleType": "string",
  • "yAxisType": "string"
}