This guide provides a brief description of ServiceWatch service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Status	Not Before
1.2	CURRENT	-
1.1	SUPPORTED	20260831
1.0	DEPRECATED	20260630

OpenAPI URL

https://servicewatch.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environment	region
s	kr-west1
s	kr-east1
g	kr-south1
g	kr-south2
g	kr-south3
e	kr-west1
e	kr-east1

1 - APIs

1.1 - CreateAlert

1.1.1 - 1.2

post /v1/alerts

Description

Create an Alert

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		AlertCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	AlertCreateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/alerts

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "description": "Alert1 Description",
    "dimension": {
        "key": "InstanceId",
        "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
    },
    "dimensions": [],
    "evaluation_count": 3,
    "individual_items": [
        {
            "key": "VolumeID",
            "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
        }
    ],
    "level": "HIGH",
    "lower_bound": 80.0,
    "metric_id": "d91097ac-0387-4e69-adb2-7b8d453b8db5",
    "missing_data_option": "BREACHING",
    "name": "Alert1",
    "namespace_id": "d583a229-9766-4eb8-96c4-ec389902ba3d",
    "operator": "RANGE",
    "period": 300,
    "recipient_ids": [
        "1234da92-634a-4f8c-932e-9d650599ab1b",
        "1234da92-634a-4f8c-932e-9d650599ab1a",
        "1234da92-634a-4f8c-932e-9d650599ab1c"
    ],
    "statistic": "AVG",
    "tags": [
        {
            "key": "key01",
            "value": "value01"
        }
    ],
    "threshold": 80.0,
    "upper_bound": 90.0,
    "violation_count": 2
}

Example HTTP response

Response 201

{
    "created_at": "2026-04-14T15:03:57.917Z",
    "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
    "id": "0ad6da92-634a-4f8c-932e-9d650599ab1e"
}

1.2 - CreateCustomLogEvents

1.2.1 - 1.2

post /v1/log-groups/log-streams/log-events

Description

Create Custom log events

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		CustomLogEventsCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	LogEventsCreateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/log-groups/log-streams/log-events

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "resourceLogs": [
        {
            "resource": {
                "attributes": [
                    {
                        "key": "log_stream_value",
                        "value": {
                            "stringValue": "a1e2f3045678901a2b3c4d5e6f7a8b81"
                        }
                    },
                    {
                        "key": "log_group_value",
                        "value": {
                            "stringValue": "b1e2f3045678901a2b3c4d5e6f7a8b81"
                        }
                    },
                    {
                        "key": "account_id",
                        "value": {
                            "stringValue": "c1e2f3045678901a2b3c4d5e6f7a8b81"
                        }
                    }
                ]
            },
            "scopeLogs": [
                {
                    "logRecords": [
                        {
                            "body": {
                                "stringValue": "level=info otlp test log"
                            },
                            "timeUnixNano": "1762336464000000000"
                        }
                    ]
                }
            ]
        }
    ]
}

Example HTTP response

Response 202

{
    "status": "success"
}

1.2.2 - 1.1

post /v1/log-groups/log-streams/log-events

Description

Create Custom log events

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		CustomLogEventsCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	LogEventsCreateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/log-groups/log-streams/log-events

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.1"

Request body

{
    "resourceLogs": [
        {
            "resource": {
                "attributes": [
                    {
                        "key": "log_stream_value",
                        "value": {
                            "stringValue": "a1e2f3045678901a2b3c4d5e6f7a8b81"
                        }
                    },
                    {
                        "key": "log_group_value",
                        "value": {
                            "stringValue": "b1e2f3045678901a2b3c4d5e6f7a8b81"
                        }
                    },
                    {
                        "key": "account_id",
                        "value": {
                            "stringValue": "c1e2f3045678901a2b3c4d5e6f7a8b81"
                        }
                    }
                ]
            },
            "scopeLogs": [
                {
                    "logRecords": [
                        {
                            "body": {
                                "stringValue": "level=info otlp test log"
                            },
                            "timeUnixNano": "1762336464000000000"
                        }
                    ]
                }
            ]
        }
    ]
}

Example HTTP response

Response 202

{
    "status": "success"
}

1.3 - CreateCustomLogStream

1.3.1 - 1.2

post /v1/log-groups/log-streams/collect/custom

Description

Create a custom log stream

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		LogGroupsLogStreamsCollectCustomRequest

Responses

HTTP Code	Description	Schema
200	OK	LogGroupsLogStreamsCollectCustomResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/log-groups/log-streams/collect/custom

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "log_group_name": "testlg01",
    "log_stream_name": "testls01"
}

Example HTTP response

Response 200

{
    "account_id": "1bcf39b344ac41cbaf0466ff0d2bebad",
    "log_group_value": "fa6169af200b4d5db229aff384b2a028",
    "log_stream_value": "551513c5182b45beb22eadb634cdccfb",
    "requests_per_second": 500
}

1.3.2 - 1.1

post /v1/log-groups/log-streams/collect/custom

Description

Create a custom log stream

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		LogGroupsLogStreamsCollectCustomRequest

Responses

HTTP Code	Description	Schema
200	OK	LogGroupsLogStreamsCollectCustomResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/log-groups/log-streams/collect/custom

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.1"

Request body

{
    "log_group_name": "testlg01",
    "log_stream_name": "testls01"
}

Example HTTP response

Response 200

{
    "account_id": "1bcf39b344ac41cbaf0466ff0d2bebad",
    "log_group_value": "fa6169af200b4d5db229aff384b2a028",
    "log_stream_value": "551513c5182b45beb22eadb634cdccfb",
    "requests_per_second": 500
}

1.4 - CreateCustomMetricMetas

1.4.1 - 1.2

post /v1/metrics/custom/meta

Description

Create Custom Metric Metas

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		MetricCustomMetaRequest

Responses

HTTP Code	Description	Schema
200	OK	MetricCustomMetaResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/metrics/custom/meta

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "metricMetas": [
        {
            "descriptionEn": "filestorage volume total byte",
            "descriptionKo": "파일스토리지 총 바이트 수",
            "dimensions": [
                [
                    "image_id"
                ]
            ],
            "metricName": "Custom_filestorage_volume_total_byte",
            "storageResolution": 60,
            "unit": "Bytes"
        }
    ],
    "namespace": "MyCustom/filestorage"
}

Example HTTP response

Response 200

{
    "account_id": "d79a5194b1a44a858969eb94754d3ba1",
    "max_data_points": "",
    "unit_logs": [
        {
            "code": "Success",
            "message": "[libvirt_domain_info_virtual_cpus] unit is updated from Count to Bytes"
        }
    ]
}

1.4.2 - 1.1

post /v1/metrics/custom/meta

Description

Create Custom Metric Metas

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		MetricCustomMetaRequest

Responses

HTTP Code	Description	Schema
200	OK	MetricCustomMetaResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/metrics/custom/meta

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.1"

Request body

{
    "metricMetas": [
        {
            "descriptionEn": "filestorage volume total byte",
            "descriptionKo": "파일스토리지 총 바이트 수",
            "dimensions": [
                [
                    "image_id"
                ]
            ],
            "metricName": "Custom_filestorage_volume_total_byte",
            "storageResolution": 60,
            "unit": "Bytes"
        }
    ],
    "namespace": "MyCustom/filestorage"
}

Example HTTP response

Response 200

{
    "account_id": "d79a5194b1a44a858969eb94754d3ba1",
    "max_data_points": "",
    "unit_logs": [
        {
            "code": "Success",
            "message": "[libvirt_domain_info_virtual_cpus] unit is updated from Count to Bytes"
        }
    ]
}

1.5 - CreateCustomMetrics

1.5.1 - 1.2

post /v1/metrics/custom

Description

Create Custom Metrics. The request body of this API can receive data in either camelCase or snake_case.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		MetricCustomRequest

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/metrics/custom

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "resource_metrics": [
        {
            "resource": {
                "attributes": [
                    {
                        "key": "",
                        "value": {
                            "array_value": "",
                            "bool_value": "",
                            "byte_value": "",
                            "double_value": "",
                            "int_value": "",
                            "kvlist_value": "",
                            "string_value": ""
                        }
                    }
                ]
            },
            "scope_metrics": [
                {
                    "metrics": [
                        {
                            "description": "The total number of bytes read successfully.",
                            "gauge": {
                                "data_points": [
                                    {
                                        "as_double": 0.75,
                                        "as_int": 10,
                                        "attributes": [
                                            {
                                                "key": "",
                                                "value": {
                                                    "array_value": "",
                                                    "bool_value": "",
                                                    "byte_value": "",
                                                    "double_value": "",
                                                    "int_value": "",
                                                    "kvlist_value": "",
                                                    "string_value": ""
                                                }
                                            }
                                        ],
                                        "start_time_unix_nano": "1753776789854000000",
                                        "time_unix_nano": "1753776789854000000"
                                    }
                                ]
                            },
                            "name": "node_disk_read_bytes_total",
                            "sum": {
                                "aggregation_temporality": "2",
                                "data_points": [
                                    {
                                        "as_double": 0.75,
                                        "as_int": 10,
                                        "attributes": [
                                            {
                                                "key": "",
                                                "value": {
                                                    "array_value": "",
                                                    "bool_value": "",
                                                    "byte_value": "",
                                                    "double_value": "",
                                                    "int_value": "",
                                                    "kvlist_value": "",
                                                    "string_value": ""
                                                }
                                            }
                                        ],
                                        "start_time_unix_nano": "1753776789854000000",
                                        "time_unix_nano": "1753776789854000000"
                                    }
                                ],
                                "is_monotonic": true
                            },
                            "unit": "Bytes"
                        }
                    ],
                    "scope": {
                        "name": "ServiceWatch-Agent",
                        "version": "1.0.0"
                    }
                }
            ]
        }
    ]
}

Example HTTP response

Response 202

1.5.2 - 1.1

post /v1/metrics/custom

Description

Create Custom Metrics. The request body of this API can receive data in either camelCase or snake_case.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		MetricCustomRequest

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/metrics/custom

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.1"

Request body

{
    "resource_metrics": [
        {
            "resource": {
                "attributes": [
                    {
                        "key": "",
                        "value": {
                            "array_value": "",
                            "bool_value": "",
                            "byte_value": "",
                            "double_value": "",
                            "int_value": "",
                            "kvlist_value": "",
                            "string_value": ""
                        }
                    }
                ]
            },
            "scope_metrics": [
                {
                    "metrics": [
                        {
                            "description": "The total number of bytes read successfully.",
                            "gauge": {
                                "data_points": [
                                    {
                                        "as_double": 0.75,
                                        "as_int": 10,
                                        "attributes": [
                                            {
                                                "key": "",
                                                "value": {
                                                    "array_value": "",
                                                    "bool_value": "",
                                                    "byte_value": "",
                                                    "double_value": "",
                                                    "int_value": "",
                                                    "kvlist_value": "",
                                                    "string_value": ""
                                                }
                                            }
                                        ],
                                        "start_time_unix_nano": "1753776789854000000",
                                        "time_unix_nano": "1753776789854000000"
                                    }
                                ]
                            },
                            "name": "node_disk_read_bytes_total",
                            "sum": {
                                "aggregation_temporality": "2",
                                "data_points": [
                                    {
                                        "as_double": 0.75,
                                        "as_int": 10,
                                        "attributes": [
                                            {
                                                "key": "",
                                                "value": {
                                                    "array_value": "",
                                                    "bool_value": "",
                                                    "byte_value": "",
                                                    "double_value": "",
                                                    "int_value": "",
                                                    "kvlist_value": "",
                                                    "string_value": ""
                                                }
                                            }
                                        ],
                                        "start_time_unix_nano": "1753776789854000000",
                                        "time_unix_nano": "1753776789854000000"
                                    }
                                ],
                                "is_monotonic": true
                            },
                            "unit": "Bytes"
                        }
                    ],
                    "scope": {
                        "name": "ServiceWatch-Agent",
                        "version": "1.0.0"
                    }
                }
            ]
        }
    ]
}

Example HTTP response

Response 202

1.6 - CreateDashboard

1.6.1 - 1.2

post /v1/dashboards

Description

Create dashboard

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		DashboardCreationRequest

Responses

HTTP Code	Description	Schema
201	Created	DashboardDetailResponseV1Dot1
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
409	Conflict	None

Example HTTP request

Request path

/v1/dashboards

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "name": "New-Monitoring-Dashboard",
    "widgets": [
        {
            "height": 1,
            "order": 1,
            "properties": {
                "metrics": [
                    {
                        "color": "#ff7f0e",
                        "dimensions": [
                            {
                                "key": "InstanceId",
                                "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
                            }
                        ],
                        "display_name": "EC2-Prod-CPU",
                        "individual_items": [
                            {
                                "key": "BucketId",
                                "value": "b-1234567890abcdef0"
                            }
                        ],
                        "name": "CPUUtilization",
                        "namespace_name": "Virtual Server",
                        "period": 300,
                        "statistic_type": "AVG"
                    }
                ],
                "period": 300,
                "stacked": false,
                "statistic_type": "AVG",
                "title": "Virtual Server | CPU Utilization",
                "view": "line"
            },
            "type": "metric",
            "width": 1
        }
    ]
}

Example HTTP response

Response 201

{
    "alerts": {
        "summary": {
            "high": 1,
            "low": 0,
            "medium": 3
        },
        "widgets": [
            {
                "properties": {
                    "metrics": [
                        {
                            "alerts": [
                                {
                                    "id": "",
                                    "name": ""
                                }
                            ],
                            "color": "#ff7f0e",
                            "dimensions": [
                                {
                                    "key": "InstanceId",
                                    "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
                                }
                            ],
                            "display_name": "EC2-Prod-CPU",
                            "individual_items": [
                                {
                                    "key": "BucketId",
                                    "value": "b-1234567890abcdef0"
                                }
                            ],
                            "name": "CPUUtilization",
                            "namespace_name": "Virtual Server",
                            "period": 300,
                            "statistic_type": "AVG"
                        }
                    ],
                    "period": 300,
                    "stacked": false,
                    "statistic_type": "AVG",
                    "title": "Virtual Server | CPU Utilization",
                    "view": "line"
                }
            }
        ]
    },
    "created_at": "2026-04-14T15:03:58.083Z",
    "created_by": "user-xxxxxxxx",
    "favorite_enabled": true,
    "id": "b48e730a70e74f6aa3d2555000b5c22b",
    "modified_at": "",
    "modified_by": "user-yyyyyyyy",
    "name": "Production-Web-Servers",
    "product_name": "ServiceWatch",
    "resource_id": "c8e41e595ad040a8abe57e2ffc109113",
    "resource_name": "Production-Web-Servers",
    "resource_type": "dashboard",
    "service_code": "virtualserver",
    "share_type": "Private",
    "srn": "srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113",
    "type": "Custom",
    "widgets": [
        {
            "dashboard_id": "b48e730a70e74f6aa3d2555000b5c22b",
            "height": 1,
            "id": "75da70a1a4fb486ab0282cf90693ec3c",
            "order": 1,
            "properties": {
                "metrics": [
                    {
                        "color": "#ff7f0e",
                        "dimensions": [
                            {
                                "key": "InstanceId",
                                "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
                            }
                        ],
                        "display_name": "EC2-Prod-CPU",
                        "name": "CPUUtilization",
                        "namespace_name": "Virtual Server",
                        "period": 300,
                        "statistic_type": "AVG"
                    }
                ],
                "period": 300,
                "stacked": false,
                "statistic_type": "AVG",
                "title": "Virtual Server | CPU Utilization",
                "view": "line"
            },
            "type": "metric",
            "width": 1
        }
    ]
}

1.6.2 - 1.1

post /v1/dashboards

Description

Create dashboard

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		DashboardCreationRequest

Responses

HTTP Code	Description	Schema
201	Created	DashboardDetailResponseV1Dot1
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
409	Conflict	None

Example HTTP request

Request path

/v1/dashboards

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.1"

Request body

{
    "name": "New-Monitoring-Dashboard",
    "widgets": [
        {
            "height": 1,
            "order": 1,
            "properties": {
                "metrics": [
                    {
                        "color": "#ff7f0e",
                        "dimensions": [
                            {
                                "key": "InstanceId",
                                "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
                            }
                        ],
                        "display_name": "EC2-Prod-CPU",
                        "individual_items": [
                            {
                                "key": "BucketId",
                                "value": "b-1234567890abcdef0"
                            }
                        ],
                        "name": "CPUUtilization",
                        "namespace_name": "Virtual Server",
                        "period": 300,
                        "statistic_type": "AVG"
                    }
                ],
                "period": 300,
                "stacked": false,
                "statistic_type": "AVG",
                "title": "Virtual Server | CPU Utilization",
                "view": "line"
            },
            "type": "metric",
            "width": 1
        }
    ]
}

Example HTTP response

Response 201

{
    "alerts": {
        "summary": {
            "high": 1,
            "low": 0,
            "medium": 3
        },
        "widgets": [
            {
                "properties": {
                    "metrics": [
                        {
                            "alerts": [
                                {
                                    "id": "",
                                    "name": ""
                                }
                            ],
                            "color": "#ff7f0e",
                            "dimensions": [
                                {
                                    "key": "InstanceId",
                                    "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
                                }
                            ],
                            "display_name": "EC2-Prod-CPU",
                            "individual_items": [
                                {
                                    "key": "BucketId",
                                    "value": "b-1234567890abcdef0"
                                }
                            ],
                            "name": "CPUUtilization",
                            "namespace_name": "Virtual Server",
                            "period": 300,
                            "statistic_type": "AVG"
                        }
                    ],
                    "period": 300,
                    "stacked": false,
                    "statistic_type": "AVG",
                    "title": "Virtual Server | CPU Utilization",
                    "view": "line"
                }
            }
        ]
    },
    "created_at": "2026-04-14T15:03:57.526Z",
    "created_by": "user-xxxxxxxx",
    "favorite_enabled": true,
    "id": "b48e730a70e74f6aa3d2555000b5c22b",
    "modified_at": "",
    "modified_by": "user-yyyyyyyy",
    "name": "Production-Web-Servers",
    "product_name": "ServiceWatch",
    "resource_id": "c8e41e595ad040a8abe57e2ffc109113",
    "resource_name": "Production-Web-Servers",
    "resource_type": "dashboard",
    "service_code": "virtualserver",
    "share_type": "Private",
    "srn": "srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113",
    "type": "Custom",
    "widgets": [
        {
            "dashboard_id": "b48e730a70e74f6aa3d2555000b5c22b",
            "height": 1,
            "id": "75da70a1a4fb486ab0282cf90693ec3c",
            "order": 1,
            "properties": {
                "metrics": [
                    {
                        "color": "#ff7f0e",
                        "dimensions": [
                            {
                                "key": "InstanceId",
                                "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
                            }
                        ],
                        "display_name": "EC2-Prod-CPU",
                        "name": "CPUUtilization",
                        "namespace_name": "Virtual Server",
                        "period": 300,
                        "statistic_type": "AVG"
                    }
                ],
                "period": 300,
                "stacked": false,
                "statistic_type": "AVG",
                "title": "Virtual Server | CPU Utilization",
                "view": "line"
            },
            "type": "metric",
            "width": 1
        }
    ]
}

1.6.3 - 1.0

post /v1/dashboards

Description

Create dashboard

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
body	body required		DashboardCreationRequest

Responses

HTTP Code	Description	Schema
201	Created	DashboardDetailResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
409	Conflict	None

Example HTTP request

Request path

/v1/dashboards

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.0"

Request body

{
    "name": "New-Monitoring-Dashboard",
    "widgets": [
        {
            "height": 1,
            "order": 1,
            "properties": {
                "metrics": [
                    {
                        "color": "#ff7f0e",
                        "dimensions": [
                            {
                                "key": "InstanceId",
                                "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
                            }
                        ],
                        "display_name": "EC2-Prod-CPU",
                        "individual_items": [
                            {
                                "key": "BucketId",
                                "value": "b-1234567890abcdef0"
                            }
                        ],
                        "name": "CPUUtilization",
                        "namespace_name": "Virtual Server",
                        "period": 300,
                        "statistic_type": "AVG"
                    }
                ],
                "period": 300,
                "stacked": false,
                "statistic_type": "AVG",
                "title": "Virtual Server | CPU Utilization",
                "view": "line"
            },
            "type": "metric",
            "width": 1
        }
    ]
}

Example HTTP response

Response 201

{
    "alerts": {
        "summary": {
            "high": 1,
            "low": 0,
            "medium": 3
        },
        "widgets": [
            {
                "properties": {
                    "metrics": [
                        {
                            "alerts": [
                                {
                                    "id": "",
                                    "name": ""
                                }
                            ],
                            "color": "#ff7f0e",
                            "dimensions": [
                                {
                                    "key": "InstanceId",
                                    "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
                                }
                            ],
                            "display_name": "EC2-Prod-CPU",
                            "individual_items": [
                                {
                                    "key": "BucketId",
                                    "value": "b-1234567890abcdef0"
                                }
                            ],
                            "name": "CPUUtilization",
                            "namespace_name": "Virtual Server",
                            "period": 300,
                            "statistic_type": "AVG"
                        }
                    ],
                    "period": 300,
                    "stacked": false,
                    "statistic_type": "AVG",
                    "title": "Virtual Server | CPU Utilization",
                    "view": "line"
                }
            }
        ]
    },
    "created_at": "2026-04-14T15:03:57.179Z",
    "created_by": "user-xxxxxxxx",
    "favorite_enabled": true,
    "id": "b48e730a70e74f6aa3d2555000b5c22b",
    "modified_at": "",
    "modified_by": "user-yyyyyyyy",
    "name": "Production-Web-Servers",
    "product_name": "ServiceWatch",
    "resource_id": "c8e41e595ad040a8abe57e2ffc109113",
    "resource_name": "Production-Web-Servers",
    "resource_type": "dashboard",
    "share_type": "Private",
    "srn": "srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113",
    "type": "Custom",
    "widgets": [
        {
            "dashboard_id": "b48e730a70e74f6aa3d2555000b5c22b",
            "height": 1,
            "id": "75da70a1a4fb486ab0282cf90693ec3c",
            "order": 1,
            "properties": {
                "metrics": [
                    {
                        "color": "#ff7f0e",
                        "dimensions": [
                            {
                                "key": "InstanceId",
                                "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
                            }
                        ],
                        "display_name": "EC2-Prod-CPU",
                        "individual_items": [
                            {
                                "key": "BucketId",
                                "value": "b-1234567890abcdef0"
                            }
                        ],
                        "name": "CPUUtilization",
                        "namespace_name": "Virtual Server",
                        "period": 300,
                        "statistic_type": "AVG"
                    }
                ],
                "period": 300,
                "stacked": false,
                "statistic_type": "AVG",
                "title": "Virtual Server | CPU Utilization",
                "view": "line"
            },
            "type": "metric",
            "width": 1
        }
    ]
}

1.7 - CreateEventRule

1.7.1 - 1.2

post /v1/event-rules

Description

Create an Event rule.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		EventRuleCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	EventRuleShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/event-rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "description": "Event rule 1 description",
    "event_ids": [
        "014cb88ca2a9420e840d5c9ac16cac89",
        "28520cbbc8c54a3f86f513a9695e6481",
        "29f97b569020491ca63d37e27b2c7fec",
        "3339ebd5839e41c982a81803431f6932",
        "3fb112a5708f44549878c7de7159922d"
    ],
    "name": "Event rule 1",
    "recipient_ids": [
        "947c6a8559434505b28a5e21fff463d0",
        "aa57f19630b347f0b294f189acd098a7",
        "bc086de26abc4ea2b3e1322b14c013f3",
        "4af4507824924a7a9988a7bd3bd09bb7",
        "c0e4f5d4b0cf4dc5b8f6f915602949d5"
    ],
    "resource_type_id": "596bf16709e84e27b7df397bf59b877c",
    "service_id": "2778de83d7e247609445bbd570a4eba9",
    "srn_list": [
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a",
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/1fd94ff609dd40b3a873b306432059df",
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a23783834c7c4fd29b015632811b9a76",
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/704c0b21e1be44ba82a552d751d282d2",
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/63b5ea57e1254dfaa934cd76aaf3aade"
    ],
    "tags": [
        {
            "key": "key01",
            "value": "value01"
        },
        {
            "key": "key02",
            "value": "value02"
        }
    ]
}

Example HTTP response

Response 201

{
    "event_rule": {
        "account_id": "1bcf39b344ac41cbaf0466ff0d2bebad",
        "active_yn": "Y",
        "created_at": "2026-04-14T15:03:58.175Z",
        "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "description": "Event rule 1 description",
        "id": "b73f95c698f540dab18860f72fafd03f",
        "modified_at": "2026-04-14T15:03:58.175Z",
        "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "name": "Event rule 1",
        "resource_type_id": "596bf16709e84e27b7df397bf59b877c",
        "service_id": "2778de83d7e247609445bbd570a4eba9"
    }
}

1.7.2 - 1.1

post /v1/event-rules

Description

Create an Event rule.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		EventRuleCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	EventRuleShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/event-rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.1"

Request body

{
    "description": "Event rule 1 description",
    "event_ids": [
        "014cb88ca2a9420e840d5c9ac16cac89",
        "28520cbbc8c54a3f86f513a9695e6481",
        "29f97b569020491ca63d37e27b2c7fec",
        "3339ebd5839e41c982a81803431f6932",
        "3fb112a5708f44549878c7de7159922d"
    ],
    "name": "Event rule 1",
    "recipient_ids": [
        "947c6a8559434505b28a5e21fff463d0",
        "aa57f19630b347f0b294f189acd098a7",
        "bc086de26abc4ea2b3e1322b14c013f3",
        "4af4507824924a7a9988a7bd3bd09bb7",
        "c0e4f5d4b0cf4dc5b8f6f915602949d5"
    ],
    "resource_type_id": "596bf16709e84e27b7df397bf59b877c",
    "service_id": "2778de83d7e247609445bbd570a4eba9",
    "srn_list": [
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a",
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/1fd94ff609dd40b3a873b306432059df",
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a23783834c7c4fd29b015632811b9a76",
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/704c0b21e1be44ba82a552d751d282d2",
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/63b5ea57e1254dfaa934cd76aaf3aade"
    ],
    "tags": [
        {
            "key": "key01",
            "value": "value01"
        },
        {
            "key": "key02",
            "value": "value02"
        }
    ]
}

Example HTTP response

Response 201

{
    "event_rule": {
        "account_id": "1bcf39b344ac41cbaf0466ff0d2bebad",
        "active_yn": "Y",
        "created_at": "2026-04-14T15:03:57.619Z",
        "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "description": "Event rule 1 description",
        "id": "b73f95c698f540dab18860f72fafd03f",
        "modified_at": "2026-04-14T15:03:57.619Z",
        "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "name": "Event rule 1",
        "resource_type_id": "596bf16709e84e27b7df397bf59b877c",
        "service_id": "2778de83d7e247609445bbd570a4eba9"
    }
}

1.7.3 - 1.0

post /v1/event-rules

Description

Create an Event rule.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
body	body required		EventRuleCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	EventRuleShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/event-rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.0"

Request body

{
    "description": "Event rule 1 description",
    "event_ids": [
        "014cb88ca2a9420e840d5c9ac16cac89",
        "28520cbbc8c54a3f86f513a9695e6481",
        "29f97b569020491ca63d37e27b2c7fec",
        "3339ebd5839e41c982a81803431f6932",
        "3fb112a5708f44549878c7de7159922d"
    ],
    "name": "Event rule 1",
    "recipient_ids": [
        "947c6a8559434505b28a5e21fff463d0",
        "aa57f19630b347f0b294f189acd098a7",
        "bc086de26abc4ea2b3e1322b14c013f3",
        "4af4507824924a7a9988a7bd3bd09bb7",
        "c0e4f5d4b0cf4dc5b8f6f915602949d5"
    ],
    "resource_type_id": "596bf16709e84e27b7df397bf59b877c",
    "service_id": "2778de83d7e247609445bbd570a4eba9",
    "srn_list": [
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a",
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/1fd94ff609dd40b3a873b306432059df",
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a23783834c7c4fd29b015632811b9a76",
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/704c0b21e1be44ba82a552d751d282d2",
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/63b5ea57e1254dfaa934cd76aaf3aade"
    ],
    "tags": [
        {
            "key": "key01",
            "value": "value01"
        },
        {
            "key": "key02",
            "value": "value02"
        }
    ]
}

Example HTTP response

Response 201

{
    "event_rule": {
        "account_id": "1bcf39b344ac41cbaf0466ff0d2bebad",
        "active_yn": "Y",
        "created_at": "2026-04-14T15:03:57.272Z",
        "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "description": "Event rule 1 description",
        "id": "b73f95c698f540dab18860f72fafd03f",
        "modified_at": "2026-04-14T15:03:57.272Z",
        "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "name": "Event rule 1",
        "resource_type_id": "596bf16709e84e27b7df397bf59b877c",
        "service_id": "2778de83d7e247609445bbd570a4eba9"
    }
}

1.8 - CreateLogGroup

1.8.1 - 1.2

post /v1/log-groups

Description

Create a Log group.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		LogGroupCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	LogGroupShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/log-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "name": "testlg01",
    "retention_period": 365,
    "tags": [
        {
            "key": "key01",
            "value": "value01"
        },
        {
            "key": "key02",
            "value": "value02"
        }
    ]
}

Example HTTP response

Response 201

{
    "log_group": {
        "account_id": "1bcf39b344ac41cbaf0466ff0d2bebad",
        "created_at": "2026-04-14T15:03:58.261Z",
        "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "id": "bce52822147744b4afe0187164caa2e8",
        "modified_at": "2026-04-14T15:03:58.261Z",
        "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "name": "testlg01",
        "retention_period": 365,
        "retention_period_name": "1 year",
        "status": "ACTIVE"
    }
}

1.8.2 - 1.1

post /v1/log-groups

Description

Create a Log group.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		LogGroupCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	LogGroupShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/log-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.1"

Request body

{
    "name": "testlg01",
    "retention_period": 365,
    "tags": [
        {
            "key": "key01",
            "value": "value01"
        },
        {
            "key": "key02",
            "value": "value02"
        }
    ]
}

Example HTTP response

Response 201

{
    "log_group": {
        "account_id": "1bcf39b344ac41cbaf0466ff0d2bebad",
        "created_at": "2026-04-14T15:03:57.689Z",
        "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "id": "bce52822147744b4afe0187164caa2e8",
        "modified_at": "2026-04-14T15:03:57.689Z",
        "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "name": "testlg01",
        "retention_period": 365,
        "retention_period_name": "1 year",
        "status": "ACTIVE"
    }
}

1.8.3 - 1.0

post /v1/log-groups

Description

Create a Log group.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
body	body required		LogGroupCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	LogGroupShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/log-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.0"

Request body

{
    "name": "testlg01",
    "retention_period": 365,
    "tags": [
        {
            "key": "key01",
            "value": "value01"
        },
        {
            "key": "key02",
            "value": "value02"
        }
    ]
}

Example HTTP response

Response 201

{
    "log_group": {
        "account_id": "1bcf39b344ac41cbaf0466ff0d2bebad",
        "created_at": "2026-04-14T15:03:57.352Z",
        "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "id": "bce52822147744b4afe0187164caa2e8",
        "modified_at": "2026-04-14T15:03:57.352Z",
        "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "name": "testlg01",
        "retention_period": 365,
        "retention_period_name": "1 year",
        "status": "ACTIVE"
    }
}

1.9 - CreateLogStream

1.9.1 - 1.2

post /v1/log-groups/{log_group_id}/log-streams

Description

Create a Log group log stream.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	log_group_id required	Log group ID Example : `bce52822147744b4afe0187164caa2e8`	string	None
body	body required		LogGroupLogStreamCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	LogStreamShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/log-groups/{log_group_id}/log-streams

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "name": "testls01"
}

Example HTTP response

Response 201

{
    "log_stream": {
        "collect_yn": "Y",
        "created_at": "2026-04-14T15:03:58.365Z",
        "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "id": "b0fc99a46a2c44b8b22739b130853dd8",
        "log_group_id": "bce52822147744b4afe0187164caa2e8",
        "modified_at": "2026-04-14T15:03:58.365Z",
        "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "name": "testls01"
    }
}

1.9.2 - 1.1

post /v1/log-groups/{log_group_id}/log-streams

Description

Create a Log group log stream.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Type	Name	Description	Schema	Default
path	log_group_id required	Log group ID Example : `bce52822147744b4afe0187164caa2e8`	string	None
body	body required		LogGroupLogStreamCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	LogStreamShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/log-groups/{log_group_id}/log-streams

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.1"

Request body

{
    "name": "testls01"
}

Example HTTP response

Response 201

{
    "log_stream": {
        "collect_yn": "Y",
        "created_at": "2026-04-14T15:03:57.777Z",
        "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "id": "b0fc99a46a2c44b8b22739b130853dd8",
        "log_group_id": "bce52822147744b4afe0187164caa2e8",
        "modified_at": "2026-04-14T15:03:57.777Z",
        "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "name": "testls01"
    }
}

1.9.3 - 1.0

post /v1/log-groups/{log_group_id}/log-streams

Description

Create a Log group log stream.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	log_group_id required	Log group ID Example : `bce52822147744b4afe0187164caa2e8`	string	None
body	body required		LogGroupLogStreamCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	LogStreamShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/log-groups/{log_group_id}/log-streams

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.0"

Request body

{
    "name": "testls01"
}

Example HTTP response

Response 201

{
    "log_stream": {
        "collect_yn": "Y",
        "created_at": "2026-04-14T15:03:57.404Z",
        "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "id": "b0fc99a46a2c44b8b22739b130853dd8",
        "log_group_id": "bce52822147744b4afe0187164caa2e8",
        "modified_at": "2026-04-14T15:03:57.404Z",
        "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "name": "testls01"
    }
}

1.10 - DeleteAlerts

1.10.1 - 1.2

delete /v1/alerts

Description

Delete Alerts

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		AlertDeleteRequest

Responses

HTTP Code	Description	Schema
200	OK	AlertDeleteResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/alerts

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "ids": [
        "0ad6da92-634a-4f8c-932e-9d650599ab1e"
    ]
}

Example HTTP response

Response 200

{
    "ids": [
        "0ad6da92-634a-4f8c-932e-9d650599ab1e"
    ]
}

1.11 - DeleteBulkDashboards

1.11.1 - 1.2

delete /v1/dashboards

Description

Delete bulk dashboards

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		DashboardBulkDeleteRequest

Responses

HTTP Code	Description	Schema
200	OK	DashboardBulkDeleteResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/dashboards

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "dashboard_ids": [
        "b48e730a70e74f6aa3d2555000b5c22b",
        "c48e730a70e74f6aa3d2555000b5c22b"
    ]
}

Example HTTP response

Response 200

{
    "dashboard_names": [
        "dash-abc",
        "dash-def"
    ]
}

1.11.2 - 1.1

delete /v1/dashboards

Description

Delete bulk dashboards

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		DashboardBulkDeleteRequest

Responses

HTTP Code	Description	Schema
200	OK	DashboardBulkDeleteResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/dashboards

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.1"

Request body

{
    "dashboard_ids": [
        "b48e730a70e74f6aa3d2555000b5c22b",
        "c48e730a70e74f6aa3d2555000b5c22b"
    ]
}

Example HTTP response

Response 200

{
    "dashboard_names": [
        "dash-abc",
        "dash-def"
    ]
}

1.11.3 - 1.0

delete /v1/dashboards

Description

Delete bulk dashboards

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
body	body required		DashboardBulkDeleteRequest

Responses

HTTP Code	Description	Schema
200	OK	DashboardBulkDeleteResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/dashboards

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.0"

Request body

{
    "dashboard_ids": [
        "b48e730a70e74f6aa3d2555000b5c22b",
        "c48e730a70e74f6aa3d2555000b5c22b"
    ]
}

Example HTTP response

Response 200

{
    "dashboard_names": [
        "dash-abc",
        "dash-def"
    ]
}

1.12 - DeleteEventRules

1.12.1 - 1.2

delete /v1/event-rules

Description

Delete Event rules.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		EventRulesDeleteRequest

Responses

HTTP Code	Description	Schema
200	OK	EventRulesDeleteResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/event-rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "ids": [
        "66d77b4e32d04558b2382b1d14765d86",
        "3abcf524eb3d4457b39ef90eab2c9e48",
        "ec67101ca2364ca28ad1e69b8084492d",
        "f0620e8eb6a843aaaa2714494dfb7dbb",
        "0ecc082aa1e3485bba95419c47e0b741"
    ]
}

Example HTTP response

Response 200

{
    "ids": [
        "66d77b4e32d04558b2382b1d14765d86",
        "3abcf524eb3d4457b39ef90eab2c9e48",
        "ec67101ca2364ca28ad1e69b8084492d",
        "f0620e8eb6a843aaaa2714494dfb7dbb",
        "0ecc082aa1e3485bba95419c47e0b741"
    ]
}

1.12.2 - 1.1

delete /v1/event-rules

Description

Delete Event rules.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		EventRulesDeleteRequest

Responses

HTTP Code	Description	Schema
200	OK	EventRulesDeleteResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/event-rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.1"

Request body

{
    "ids": [
        "66d77b4e32d04558b2382b1d14765d86",
        "3abcf524eb3d4457b39ef90eab2c9e48",
        "ec67101ca2364ca28ad1e69b8084492d",
        "f0620e8eb6a843aaaa2714494dfb7dbb",
        "0ecc082aa1e3485bba95419c47e0b741"
    ]
}

Example HTTP response

Response 200

{
    "ids": [
        "66d77b4e32d04558b2382b1d14765d86",
        "3abcf524eb3d4457b39ef90eab2c9e48",
        "ec67101ca2364ca28ad1e69b8084492d",
        "f0620e8eb6a843aaaa2714494dfb7dbb",
        "0ecc082aa1e3485bba95419c47e0b741"
    ]
}

1.12.3 - 1.0

delete /v1/event-rules

Description

Delete Event rules.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
body	body required		EventRulesDeleteRequest

Responses

HTTP Code	Description	Schema
200	OK	EventRulesDeleteResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/event-rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.0"

Request body

{
    "ids": [
        "66d77b4e32d04558b2382b1d14765d86",
        "3abcf524eb3d4457b39ef90eab2c9e48",
        "ec67101ca2364ca28ad1e69b8084492d",
        "f0620e8eb6a843aaaa2714494dfb7dbb",
        "0ecc082aa1e3485bba95419c47e0b741"
    ]
}

Example HTTP response

Response 200

{
    "ids": [
        "66d77b4e32d04558b2382b1d14765d86",
        "3abcf524eb3d4457b39ef90eab2c9e48",
        "ec67101ca2364ca28ad1e69b8084492d",
        "f0620e8eb6a843aaaa2714494dfb7dbb",
        "0ecc082aa1e3485bba95419c47e0b741"
    ]
}

1.13 - DeleteLogGroups

1.13.1 - 1.2

delete /v1/log-groups

Description

Delete Log groups.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		LogGroupsDeleteRequest

Responses

HTTP Code	Description	Schema
200	OK	LogGroupsDeleteResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/log-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "ids": [
        "602b39cb1d6b4b7fb0f18de43a4c689c",
        "bce52822147744b4afe0187164caa2e8",
        "953978a05b5d4ab8b2fc80bb5d0b8b6e",
        "3eeb8030bfca4e729b8332f6004628a4",
        "4a11695ad4b34539b4cee12db2a14aa9"
    ]
}

Example HTTP response

Response 200

{
    "ids": [
        "602b39cb1d6b4b7fb0f18de43a4c689c",
        "bce52822147744b4afe0187164caa2e8",
        "953978a05b5d4ab8b2fc80bb5d0b8b6e",
        "3eeb8030bfca4e729b8332f6004628a4",
        "4a11695ad4b34539b4cee12db2a14aa9"
    ]
}

1.13.2 - 1.1

delete /v1/log-groups

Description

Delete Log groups.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		LogGroupsDeleteRequest

Responses

HTTP Code	Description	Schema
200	OK	LogGroupsDeleteResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/log-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.1"

Request body

{
    "ids": [
        "602b39cb1d6b4b7fb0f18de43a4c689c",
        "bce52822147744b4afe0187164caa2e8",
        "953978a05b5d4ab8b2fc80bb5d0b8b6e",
        "3eeb8030bfca4e729b8332f6004628a4",
        "4a11695ad4b34539b4cee12db2a14aa9"
    ]
}

Example HTTP response

Response 200

{
    "ids": [
        "602b39cb1d6b4b7fb0f18de43a4c689c",
        "bce52822147744b4afe0187164caa2e8",
        "953978a05b5d4ab8b2fc80bb5d0b8b6e",
        "3eeb8030bfca4e729b8332f6004628a4",
        "4a11695ad4b34539b4cee12db2a14aa9"
    ]
}

1.13.3 - 1.0

delete /v1/log-groups

Description

Delete Log groups.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
body	body required		LogGroupsDeleteRequest

Responses

HTTP Code	Description	Schema
200	OK	LogGroupsDeleteResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/log-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.0"

Request body

{
    "ids": [
        "602b39cb1d6b4b7fb0f18de43a4c689c",
        "bce52822147744b4afe0187164caa2e8",
        "953978a05b5d4ab8b2fc80bb5d0b8b6e",
        "3eeb8030bfca4e729b8332f6004628a4",
        "4a11695ad4b34539b4cee12db2a14aa9"
    ]
}

Example HTTP response

Response 200

{
    "ids": [
        "602b39cb1d6b4b7fb0f18de43a4c689c",
        "bce52822147744b4afe0187164caa2e8",
        "953978a05b5d4ab8b2fc80bb5d0b8b6e",
        "3eeb8030bfca4e729b8332f6004628a4",
        "4a11695ad4b34539b4cee12db2a14aa9"
    ]
}

1.14 - DeleteLogStreams

1.14.1 - 1.2

delete /v1/log-groups/{log_group_id}/log-streams

Description

Delete Log group log streams.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	log_group_id required	Log group ID Example : `bce52822147744b4afe0187164caa2e8`	string	None
body	body required		LogGroupLogStreamsDeleteRequest

Responses

HTTP Code	Description	Schema
200	OK	LogGroupsDeleteResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/log-groups/{log_group_id}/log-streams

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "ids": [
        "b0fc99a46a2c44b8b22739b130853dd8",
        "36dc853661144df687c4c7f158db5553",
        "3f611f40e9f841acbd62639b2779e35e",
        "5bd44e218eeb4f6190048a85599ade44",
        "188842fa2f13484ba6c9e210b817c780"
    ]
}

Example HTTP response

Response 200

{
    "ids": [
        "602b39cb1d6b4b7fb0f18de43a4c689c",
        "bce52822147744b4afe0187164caa2e8",
        "953978a05b5d4ab8b2fc80bb5d0b8b6e",
        "3eeb8030bfca4e729b8332f6004628a4",
        "4a11695ad4b34539b4cee12db2a14aa9"
    ]
}

1.14.2 - 1.1

delete /v1/log-groups/{log_group_id}/log-streams

Description

Delete Log group log streams.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Type	Name	Description	Schema	Default
path	log_group_id required	Log group ID Example : `bce52822147744b4afe0187164caa2e8`	string	None
body	body required		LogGroupLogStreamsDeleteRequest

Responses

HTTP Code	Description	Schema
200	OK	LogGroupsDeleteResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/log-groups/{log_group_id}/log-streams

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.1"

Request body

{
    "ids": [
        "b0fc99a46a2c44b8b22739b130853dd8",
        "36dc853661144df687c4c7f158db5553",
        "3f611f40e9f841acbd62639b2779e35e",
        "5bd44e218eeb4f6190048a85599ade44",
        "188842fa2f13484ba6c9e210b817c780"
    ]
}

Example HTTP response

Response 200

{
    "ids": [
        "602b39cb1d6b4b7fb0f18de43a4c689c",
        "bce52822147744b4afe0187164caa2e8",
        "953978a05b5d4ab8b2fc80bb5d0b8b6e",
        "3eeb8030bfca4e729b8332f6004628a4",
        "4a11695ad4b34539b4cee12db2a14aa9"
    ]
}

1.14.3 - 1.0

delete /v1/log-groups/{log_group_id}/log-streams

Description

Delete Log group log streams.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	log_group_id required	Log group ID Example : `bce52822147744b4afe0187164caa2e8`	string	None
body	body required		LogGroupLogStreamsDeleteRequest

Responses

HTTP Code	Description	Schema
200	OK	LogGroupsDeleteResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/log-groups/{log_group_id}/log-streams

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.0"

Request body

{
    "ids": [
        "b0fc99a46a2c44b8b22739b130853dd8",
        "36dc853661144df687c4c7f158db5553",
        "3f611f40e9f841acbd62639b2779e35e",
        "5bd44e218eeb4f6190048a85599ade44",
        "188842fa2f13484ba6c9e210b817c780"
    ]
}

Example HTTP response

Response 200

{
    "ids": [
        "602b39cb1d6b4b7fb0f18de43a4c689c",
        "bce52822147744b4afe0187164caa2e8",
        "953978a05b5d4ab8b2fc80bb5d0b8b6e",
        "3eeb8030bfca4e729b8332f6004628a4",
        "4a11695ad4b34539b4cee12db2a14aa9"
    ]
}

1.15 - DownloadMetricDataImage

1.15.1 - 1.2

post /v1/metrics/data/download/image

Description

Download metric data image

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		MetricDataImageRequestV1Dot1

Responses

HTTP Code	Description	Schema
200	OK	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/metrics/data/download/image

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "end": 1640995440,
    "height": 400,
    "metrics": [
        {
            "color": "#0000ff",
            "dimensions": [
                {
                    "key": "VolumeID",
                    "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
                }
            ],
            "display_name": "Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]",
            "name": "CPU Usage/Core[Basic]",
            "namespace_name": "Virtual Server",
            "period": 300,
            "statistic_type": "AVG"
        }
    ],
    "period": 300,
    "start": 1640995200,
    "statistic_type": "AVG",
    "timezone": "UTC",
    "title": "Virtual Server Metric Chart",
    "width": 600
}

Example HTTP response

Response 200

1.15.2 - 1.1

post /v1/metrics/data/download/image

Description

Download metric data image

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		MetricDataImageRequestV1Dot1

Responses

HTTP Code	Description	Schema
200	OK	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/metrics/data/download/image

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.1"

Request body

{
    "end": 1640995440,
    "height": 400,
    "metrics": [
        {
            "color": "#0000ff",
            "dimensions": [
                {
                    "key": "VolumeID",
                    "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
                }
            ],
            "display_name": "Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]",
            "name": "CPU Usage/Core[Basic]",
            "namespace_name": "Virtual Server",
            "period": 300,
            "statistic_type": "AVG"
        }
    ],
    "period": 300,
    "start": 1640995200,
    "statistic_type": "AVG",
    "timezone": "UTC",
    "title": "Virtual Server Metric Chart",
    "width": 600
}

Example HTTP response

Response 200

1.15.3 - 1.0

post /v1/metrics/data/download/image

Description

Download metric data image

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
body	body required		MetricDataImageRequest

Responses

HTTP Code	Description	Schema
200	OK	None
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/metrics/data/download/image

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.0"

Request body

{
    "end": 1640995440,
    "height": 400,
    "metrics": [
        {
            "color": "#0000ff",
            "dimensions": [
                {
                    "key": "VolumeID",
                    "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
                }
            ],
            "display_name": "Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]",
            "individual_items": [
                {
                    "key": "VolumeID",
                    "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
                }
            ],
            "name": "CPU Usage/Core[Basic]",
            "namespace_name": "Virtual Server",
            "period": 300,
            "statistic_type": "AVG"
        }
    ],
    "period": 300,
    "start": 1640995200,
    "statistic_type": "AVG",
    "timezone": "UTC",
    "title": "Virtual Server Metric Chart",
    "width": 600
}

Example HTTP response

Response 200

1.16 - ListDashboards

1.16.1 - 1.2

get /v1/dashboards

Description

Get list of dashboards

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `name:asc or modified_at:desc`	any of [string, null]	None
query	name optional	Dashboard’s name Example : `MyProd`	any of [string, null]	None
query	name_like optional	Wildcard Search for Dashboard Names Example : `MyProd`	any of [string, null]	None
query	favorite_enabled optional	Whether it is a favorite dashboard Example : `True`	any of [boolean, null]	None
query	type optional	Dashboard type Example : `Custom`	any of [string, null]	None
query	service_code optional	Associated service code Example : `virtualserver`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	DashboardPageResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/dashboards

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "dashboards": [
        {
            "created_at": "2026-04-14T15:03:58.065Z",
            "favorite_enabled": true,
            "id": "b48e730a70e74f6aa3d2555000b5c22b",
            "modified_at": "2026-04-14T15:03:58.065Z",
            "name": "Production-Web-Servers",
            "type": "Custom"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.16.2 - 1.1

get /v1/dashboards

Description

Get list of dashboards

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `name:asc or modified_at:desc`	any of [string, null]	None
query	name optional	Dashboard’s name Example : `MyProd`	any of [string, null]	None
query	name_like optional	Wildcard Search for Dashboard Names Example : `MyProd`	any of [string, null]	None
query	favorite_enabled optional	Whether it is a favorite dashboard Example : `True`	any of [boolean, null]	None

Responses

HTTP Code	Description	Schema
200	OK	DashboardPageResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/dashboards

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "dashboards": [
        {
            "created_at": "2026-04-14T15:03:57.509Z",
            "favorite_enabled": true,
            "id": "b48e730a70e74f6aa3d2555000b5c22b",
            "modified_at": "2026-04-14T15:03:57.509Z",
            "name": "Production-Web-Servers",
            "type": "Custom"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.16.3 - 1.0

get /v1/dashboards

Description

Get list of dashboards

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `name:asc or modified_at:desc`	any of [string, null]	None
query	name optional	Dashboard’s name Example : `MyProd`	any of [string, null]	None
query	name_like optional	Wildcard Search for Dashboard Names Example : `MyProd`	any of [string, null]	None
query	favorite_enabled optional	Whether it is a favorite dashboard Example : `True`	any of [boolean, null]	None

Responses

HTTP Code	Description	Schema
200	OK	DashboardPageResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/dashboards

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "dashboards": [
        {
            "created_at": "2026-04-14T15:03:57.160Z",
            "favorite_enabled": true,
            "id": "b48e730a70e74f6aa3d2555000b5c22b",
            "modified_at": "2026-04-14T15:03:57.160Z",
            "name": "Production-Web-Servers",
            "type": "Custom"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.17 - ListLogGroups

1.17.1 - 1.2

get /v1/log-groups

Description

Get list of Log groups.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	ids optional	List of Log group IDs Example : `602b39cb1d6b4b7fb0f18de43a4c689c,bce52822147744b4afe0187164caa2e8,953978a05b5d4ab8b2fc80bb5d0b8b6e,3eeb8030bfca4e729b8332f6004628a4,4a11695ad4b34539b4cee12db2a14aa9`	any of [array[string], null]	None
query	name optional	Log group name Example : `testlg01`	any of [string, null]	None
query	retention_periods optional	List of Log group retention periods Example : `-1,7,30,365`	any of [array[integer], null]	None

Responses

HTTP Code	Description	Schema
200	OK	LogGroupPageResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/log-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "log_groups": [
        {
            "account_id": "1bcf39b344ac41cbaf0466ff0d2bebad",
            "created_at": "2026-04-14T15:03:58.244Z",
            "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
            "id": "bce52822147744b4afe0187164caa2e8",
            "modified_at": "2026-04-14T15:03:58.244Z",
            "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
            "name": "testlg01",
            "retention_period": 365,
            "retention_period_name": "1 year",
            "status": "ACTIVE"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.17.2 - 1.1

get /v1/log-groups

Description

Get list of Log groups.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	ids optional	List of Log group IDs Example : `602b39cb1d6b4b7fb0f18de43a4c689c,bce52822147744b4afe0187164caa2e8,953978a05b5d4ab8b2fc80bb5d0b8b6e,3eeb8030bfca4e729b8332f6004628a4,4a11695ad4b34539b4cee12db2a14aa9`	any of [array[string], null]	None
query	name optional	Log group name Example : `testlg01`	any of [string, null]	None
query	retention_periods optional	List of Log group retention periods Example : `-1,7,30,365`	any of [array[integer], null]	None

Responses

HTTP Code	Description	Schema
200	OK	LogGroupPageResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/log-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "log_groups": [
        {
            "account_id": "1bcf39b344ac41cbaf0466ff0d2bebad",
            "created_at": "2026-04-14T15:03:57.672Z",
            "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
            "id": "bce52822147744b4afe0187164caa2e8",
            "modified_at": "2026-04-14T15:03:57.672Z",
            "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
            "name": "testlg01",
            "retention_period": 365,
            "retention_period_name": "1 year",
            "status": "ACTIVE"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.17.3 - 1.0

get /v1/log-groups

Description

Get list of Log groups.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	ids optional	List of Log group IDs Example : `602b39cb1d6b4b7fb0f18de43a4c689c,bce52822147744b4afe0187164caa2e8,953978a05b5d4ab8b2fc80bb5d0b8b6e,3eeb8030bfca4e729b8332f6004628a4,4a11695ad4b34539b4cee12db2a14aa9`	any of [array[string], null]	None
query	name optional	Log group name Example : `testlg01`	any of [string, null]	None
query	retention_periods optional	List of Log group retention periods Example : `-1,7,30,365`	any of [array[integer], null]	None

Responses

HTTP Code	Description	Schema
200	OK	LogGroupPageResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/log-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "log_groups": [
        {
            "account_id": "1bcf39b344ac41cbaf0466ff0d2bebad",
            "created_at": "2026-04-14T15:03:57.334Z",
            "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
            "id": "bce52822147744b4afe0187164caa2e8",
            "modified_at": "2026-04-14T15:03:57.334Z",
            "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
            "name": "testlg01",
            "retention_period": 365,
            "retention_period_name": "1 year",
            "status": "ACTIVE"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.18 - ListMetricData

1.18.1 - 1.2

post /v1/metrics/data

Description

Get metric data list

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		MetricDataRequestV1Dot1

Responses

HTTP Code	Description	Schema
200	OK	MetricDataResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/metrics/data

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "end": 1640995440,
    "metrics": [
        {
            "dimensions": [
                {
                    "key": "VolumeID",
                    "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
                }
            ],
            "display_name": "Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]",
            "name": "CPU Usage/Core[Basic]",
            "namespace_name": "Virtual Server",
            "period": 300,
            "statistic_type": "AVG"
        }
    ],
    "period": 300,
    "start": 1640995200,
    "statistic_type": "AVG"
}

Example HTTP response

Response 200

{
    "metrics": [
        {
            "display_name": "Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]",
            "status": "",
            "values": "[[1640995200, \"45.5\"]]"
        }
    ]
}

1.18.2 - 1.1

post /v1/metrics/data

Description

Get metric data list

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		MetricDataRequestV1Dot1

Responses

HTTP Code	Description	Schema
200	OK	MetricDataResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/metrics/data

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.1"

Request body

{
    "end": 1640995440,
    "metrics": [
        {
            "dimensions": [
                {
                    "key": "VolumeID",
                    "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
                }
            ],
            "display_name": "Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]",
            "name": "CPU Usage/Core[Basic]",
            "namespace_name": "Virtual Server",
            "period": 300,
            "statistic_type": "AVG"
        }
    ],
    "period": 300,
    "start": 1640995200,
    "statistic_type": "AVG"
}

Example HTTP response

Response 200

{
    "metrics": [
        {
            "display_name": "Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]",
            "status": "",
            "values": "[[1640995200, \"45.5\"]]"
        }
    ]
}

1.18.3 - 1.0

post /v1/metrics/data

Description

Get metric data list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
body	body required		MetricDataRequest

Responses

HTTP Code	Description	Schema
200	OK	MetricDataResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/metrics/data

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.0"

Request body

{
    "end": 1640995440,
    "metrics": [
        {
            "dimensions": [
                {
                    "key": "VolumeID",
                    "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
                }
            ],
            "display_name": "Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]",
            "individual_items": [
                {
                    "key": "VolumeID",
                    "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
                }
            ],
            "name": "CPU Usage/Core[Basic]",
            "namespace_name": "Virtual Server",
            "period": 300,
            "statistic_type": "AVG"
        }
    ],
    "period": 300,
    "start": 1640995200,
    "statistic_type": "AVG"
}

Example HTTP response

Response 200

{
    "metrics": [
        {
            "display_name": "Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]",
            "status": "",
            "values": "[[1640995200, \"45.5\"]]"
        }
    ]
}

1.19 - ListMetricInfos

1.19.1 - 1.2

post /v1/metrics

Description

Get metric list

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		MetricSearchRequestV1Dot1

Responses

HTTP Code	Description	Schema
200	OK	MetricsResponseV1Dot1
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/metrics

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "metric_name": "CPU Usage/Core[Basic]",
    "namespaces": [
        {
            "dimensions": "[[\"resource_id\"]]",
            "name": "Virtual Server"
        }
    ],
    "resource_id": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502",
    "resource_name": "VirtualServer01",
    "tags": [
        {
            "key": "key01",
            "value": "value01"
        }
    ]
}

Example HTTP response

Response 200

{
    "count": 1,
    "namespaces": [
        {
            "dimensions": [
                {
                    "columns": [
                        {
                            "key": "name",
                            "name_en": "지표명",
                            "name_ko": "지표명"
                        }
                    ],
                    "keys": "InstanceId",
                    "metrics": [
                        {
                            "alerts": [
                                {
                                    "id": "0ad6da92-634a-4f8c-932e-9d650599ab1e",
                                    "name": "Alert1"
                                }
                            ],
                            "default_collection_interval": "5m",
                            "detailed_collection_interval": "1m",
                            "dimensions": [
                                {
                                    "key": "VolumeID",
                                    "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
                                }
                            ],
                            "id": "d91097ac-0387-4e69-adb2-7b8d453b8db5",
                            "name": "CPU Usage/Core[Basic]",
                            "named_dimensions": [
                                {
                                    "key": "VolumeID",
                                    "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
                                }
                            ],
                            "namespace_id": "d583a229-9766-4eb8-96c4-ec389902ba3d",
                            "namespace_name": "Virtual Server",
                            "primary": true,
                            "recommended_stat_types": "[\"AVG\", \"MAX\"]",
                            "tags": [
                                {
                                    "key": "key01",
                                    "value": "value01"
                                }
                            ],
                            "unit": "BYTE"
                        }
                    ]
                }
            ],
            "id": "d583a229-9766-4eb8-96c4-ec389902ba3d",
            "name": "Virtual Server",
            "service_name": ""
        }
    ]
}

1.19.2 - 1.1

post /v1/metrics

Description

Get metric list

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		MetricSearchRequestV1Dot1

Responses

HTTP Code	Description	Schema
200	OK	MetricsResponseV1Dot1
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/metrics

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.1"

Request body

{
    "metric_name": "CPU Usage/Core[Basic]",
    "namespaces": [
        {
            "dimensions": "[[\"resource_id\"]]",
            "name": "Virtual Server"
        }
    ],
    "resource_id": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502",
    "resource_name": "VirtualServer01",
    "tags": [
        {
            "key": "key01",
            "value": "value01"
        }
    ]
}

Example HTTP response

Response 200

{
    "count": 1,
    "namespaces": [
        {
            "dimensions": [
                {
                    "columns": [
                        {
                            "key": "name",
                            "name_en": "지표명",
                            "name_ko": "지표명"
                        }
                    ],
                    "keys": "InstanceId",
                    "metrics": [
                        {
                            "alerts": [
                                {
                                    "id": "0ad6da92-634a-4f8c-932e-9d650599ab1e",
                                    "name": "Alert1"
                                }
                            ],
                            "default_collection_interval": "5m",
                            "detailed_collection_interval": "1m",
                            "dimensions": [
                                {
                                    "key": "VolumeID",
                                    "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
                                }
                            ],
                            "id": "d91097ac-0387-4e69-adb2-7b8d453b8db5",
                            "name": "CPU Usage/Core[Basic]",
                            "named_dimensions": [
                                {
                                    "key": "VolumeID",
                                    "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
                                }
                            ],
                            "namespace_id": "d583a229-9766-4eb8-96c4-ec389902ba3d",
                            "namespace_name": "Virtual Server",
                            "primary": true,
                            "recommended_stat_types": "[\"AVG\", \"MAX\"]",
                            "tags": [
                                {
                                    "key": "key01",
                                    "value": "value01"
                                }
                            ],
                            "unit": "BYTE"
                        }
                    ]
                }
            ],
            "id": "d583a229-9766-4eb8-96c4-ec389902ba3d",
            "name": "Virtual Server",
            "service_name": ""
        }
    ]
}

1.19.3 - 1.0

post /v1/metrics

Description

Get metric list

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
body	body required		MetricSearchRequest

Responses

HTTP Code	Description	Schema
200	OK	MetricsResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/metrics

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.0"

Request body

{
    "metric_name": "CPU Usage/Core[Basic]",
    "namespaces": [
        {
            "dimensions": "[\"resource_id\"]",
            "name": "Virtual Server"
        }
    ],
    "resource_id": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502",
    "resource_name": "VirtualServer01",
    "tags": [
        {
            "key": "key01",
            "value": "value01"
        }
    ]
}

Example HTTP response

Response 200

{
    "count": 1,
    "namespaces": [
        {
            "dimensions": [
                {
                    "columns": [
                        {
                            "key": "name",
                            "name_en": "지표명",
                            "name_ko": "지표명"
                        }
                    ],
                    "key": "InstanceId",
                    "metrics": [
                        {
                            "alerts": [
                                {
                                    "id": "0ad6da92-634a-4f8c-932e-9d650599ab1e",
                                    "name": "Alert1"
                                }
                            ],
                            "default_collection_interval": "5m",
                            "detailed_collection_interval": "1m",
                            "dimensions": [
                                {
                                    "key": "VolumeID",
                                    "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
                                }
                            ],
                            "id": "d91097ac-0387-4e69-adb2-7b8d453b8db5",
                            "individual_items": [
                                {
                                    "key": "VolumeID",
                                    "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
                                }
                            ],
                            "name": "CPU Usage/Core[Basic]",
                            "named_dimensions": [
                                {
                                    "key": "VolumeID",
                                    "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
                                }
                            ],
                            "namespace_id": "d583a229-9766-4eb8-96c4-ec389902ba3d",
                            "namespace_name": "Virtual Server",
                            "primary": true,
                            "recommended_stat_types": "[\"AVG\", \"MAX\"]",
                            "tags": [
                                {
                                    "key": "key01",
                                    "value": "value01"
                                }
                            ],
                            "unit": "BYTE"
                        }
                    ]
                }
            ],
            "id": "d583a229-9766-4eb8-96c4-ec389902ba3d",
            "name": "Virtual Server",
            "service_name": ""
        }
    ]
}

1.20 - SetAlert

1.20.1 - 1.2

patch /v1/alerts/{id}

Description

Set the Alert

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	id required	Alert ID Example : `0ad6da92-634a-4f8c-932e-9d650599ab1e`	string	None
body	body required		AlertSetRequest

Responses

HTTP Code	Description	Schema
200	OK	AlertSetResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/alerts/{id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "dimension": {
        "key": "InstanceId",
        "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
    },
    "dimensions": [],
    "evaluation_count": 3,
    "individual_items": [
        {
            "key": "VolumeID",
            "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
        }
    ],
    "level": "HIGH",
    "lower_bound": 80.0,
    "metric_id": "d91097ac-0387-4e69-adb2-7b8d453b8db5",
    "missing_data_option": "BREACHING",
    "namespace_id": "d583a229-9766-4eb8-96c4-ec389902ba3d",
    "operator": "RANGE",
    "period": 300,
    "statistic": "AVG",
    "threshold": 80.0,
    "upper_bound": 90.0,
    "violation_count": 2
}

Example HTTP response

Response 200

{
    "dimension": {
        "key": "InstanceId",
        "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
    },
    "dimensions": [
        {
            "key": "InstanceId",
            "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
        }
    ],
    "id": "0ad6da92-634a-4f8c-932e-9d650599ab1e",
    "individual_items": [
        {
            "key": "VolumeID",
            "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
        }
    ],
    "level": "HIGH",
    "lower_bound": 80.0,
    "metric_id": "d91097ac-0387-4e69-adb2-7b8d453b8db5",
    "missing_data_option": "BREACHING",
    "modified_at": "2026-03-13T02:34:40.010698",
    "namespace_id": "d583a229-9766-4eb8-96c4-ec389902ba3d",
    "operator": "RANGE",
    "period": 300,
    "statistic": "AVG",
    "threshold": 80.0,
    "upper_bound": 90.0
}

1.21 - SetAlertActivated

1.21.1 - 1.2

patch /v1/alerts/{id}/activated

Description

Set the Alert Activated

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	id required	Alert ID Example : `0ad6da92-634a-4f8c-932e-9d650599ab1e`	string	None
body	body required		AlertActivatedSetRequest

Responses

HTTP Code	Description	Schema
200	OK	AlertActivatedSetResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/alerts/{id}/activated

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "activated_yn": "Y"
}

Example HTTP response

Response 200

{
    "activated_yn": "Y",
    "id": "0ad6da92-634a-4f8c-932e-9d650599ab1e",
    "modified_at": "2026-03-13T02:34:40.008404"
}

1.22 - SetAlertDescription

1.22.1 - 1.2

patch /v1/alerts/{id}/description

Description

Set the Alert Description

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	id required	Alert ID Example : `0ad6da92-634a-4f8c-932e-9d650599ab1e`	string	None
body	body required		AlertDescriptionSetRequest

Responses

HTTP Code	Description	Schema
200	OK	AlertDescriptionSetResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/alerts/{id}/description

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "description": "Alert1 Description"
}

Example HTTP response

Response 200

{
    "description": "Alert1 Description",
    "id": "0ad6da92-634a-4f8c-932e-9d650599ab1e",
    "modified_at": "2026-03-13T02:34:40.006634"
}

1.23 - SetDashboard

1.23.1 - 1.2

put /v1/dashboards/{dashboard_id}

Description

Set dashboard

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	dashboard_id required	Dashboard’s unique ID Example : `b48e730a70e74f6aa3d2555000b5c22b`	string	None
body	body required		DashboardUpdateRequest

Responses

HTTP Code	Description	Schema
200	OK	DashboardDetailResponseV1Dot1
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/dashboards/{dashboard_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "name": "Renamed-Dashboard",
    "widgets": [
        {
            "height": 1,
            "order": 1,
            "properties": {
                "metrics": [
                    {
                        "color": "#ff7f0e",
                        "dimensions": [
                            {
                                "key": "InstanceId",
                                "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
                            }
                        ],
                        "display_name": "EC2-Prod-CPU",
                        "individual_items": [
                            {
                                "key": "BucketId",
                                "value": "b-1234567890abcdef0"
                            }
                        ],
                        "name": "CPUUtilization",
                        "namespace_name": "Virtual Server",
                        "period": 300,
                        "statistic_type": "AVG"
                    }
                ],
                "period": 300,
                "stacked": false,
                "statistic_type": "AVG",
                "title": "Virtual Server | CPU Utilization",
                "view": "line"
            },
            "type": "metric",
            "width": 1
        }
    ]
}

Example HTTP response

Response 200

{
    "alerts": {
        "summary": {
            "high": 1,
            "low": 0,
            "medium": 3
        },
        "widgets": [
            {
                "properties": {
                    "metrics": [
                        {
                            "alerts": [
                                {
                                    "id": "",
                                    "name": ""
                                }
                            ],
                            "color": "#ff7f0e",
                            "dimensions": [
                                {
                                    "key": "InstanceId",
                                    "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
                                }
                            ],
                            "display_name": "EC2-Prod-CPU",
                            "individual_items": [
                                {
                                    "key": "BucketId",
                                    "value": "b-1234567890abcdef0"
                                }
                            ],
                            "name": "CPUUtilization",
                            "namespace_name": "Virtual Server",
                            "period": 300,
                            "statistic_type": "AVG"
                        }
                    ],
                    "period": 300,
                    "stacked": false,
                    "statistic_type": "AVG",
                    "title": "Virtual Server | CPU Utilization",
                    "view": "line"
                }
            }
        ]
    },
    "created_at": "2026-04-14T15:03:58.140Z",
    "created_by": "user-xxxxxxxx",
    "favorite_enabled": true,
    "id": "b48e730a70e74f6aa3d2555000b5c22b",
    "modified_at": "",
    "modified_by": "user-yyyyyyyy",
    "name": "Production-Web-Servers",
    "product_name": "ServiceWatch",
    "resource_id": "c8e41e595ad040a8abe57e2ffc109113",
    "resource_name": "Production-Web-Servers",
    "resource_type": "dashboard",
    "service_code": "virtualserver",
    "share_type": "Private",
    "srn": "srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113",
    "type": "Custom",
    "widgets": [
        {
            "dashboard_id": "b48e730a70e74f6aa3d2555000b5c22b",
            "height": 1,
            "id": "75da70a1a4fb486ab0282cf90693ec3c",
            "order": 1,
            "properties": {
                "metrics": [
                    {
                        "color": "#ff7f0e",
                        "dimensions": [
                            {
                                "key": "InstanceId",
                                "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
                            }
                        ],
                        "display_name": "EC2-Prod-CPU",
                        "name": "CPUUtilization",
                        "namespace_name": "Virtual Server",
                        "period": 300,
                        "statistic_type": "AVG"
                    }
                ],
                "period": 300,
                "stacked": false,
                "statistic_type": "AVG",
                "title": "Virtual Server | CPU Utilization",
                "view": "line"
            },
            "type": "metric",
            "width": 1
        }
    ]
}

1.23.2 - 1.1

put /v1/dashboards/{dashboard_id}

Description

Set dashboard

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Type	Name	Description	Schema	Default
path	dashboard_id required	Dashboard’s unique ID Example : `b48e730a70e74f6aa3d2555000b5c22b`	string	None
body	body required		DashboardUpdateRequest

Responses

HTTP Code	Description	Schema
200	OK	DashboardDetailResponseV1Dot1
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/dashboards/{dashboard_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.1"

Request body

{
    "name": "Renamed-Dashboard",
    "widgets": [
        {
            "height": 1,
            "order": 1,
            "properties": {
                "metrics": [
                    {
                        "color": "#ff7f0e",
                        "dimensions": [
                            {
                                "key": "InstanceId",
                                "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
                            }
                        ],
                        "display_name": "EC2-Prod-CPU",
                        "individual_items": [
                            {
                                "key": "BucketId",
                                "value": "b-1234567890abcdef0"
                            }
                        ],
                        "name": "CPUUtilization",
                        "namespace_name": "Virtual Server",
                        "period": 300,
                        "statistic_type": "AVG"
                    }
                ],
                "period": 300,
                "stacked": false,
                "statistic_type": "AVG",
                "title": "Virtual Server | CPU Utilization",
                "view": "line"
            },
            "type": "metric",
            "width": 1
        }
    ]
}

Example HTTP response

Response 200

{
    "alerts": {
        "summary": {
            "high": 1,
            "low": 0,
            "medium": 3
        },
        "widgets": [
            {
                "properties": {
                    "metrics": [
                        {
                            "alerts": [
                                {
                                    "id": "",
                                    "name": ""
                                }
                            ],
                            "color": "#ff7f0e",
                            "dimensions": [
                                {
                                    "key": "InstanceId",
                                    "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
                                }
                            ],
                            "display_name": "EC2-Prod-CPU",
                            "individual_items": [
                                {
                                    "key": "BucketId",
                                    "value": "b-1234567890abcdef0"
                                }
                            ],
                            "name": "CPUUtilization",
                            "namespace_name": "Virtual Server",
                            "period": 300,
                            "statistic_type": "AVG"
                        }
                    ],
                    "period": 300,
                    "stacked": false,
                    "statistic_type": "AVG",
                    "title": "Virtual Server | CPU Utilization",
                    "view": "line"
                }
            }
        ]
    },
    "created_at": "2026-04-14T15:03:57.584Z",
    "created_by": "user-xxxxxxxx",
    "favorite_enabled": true,
    "id": "b48e730a70e74f6aa3d2555000b5c22b",
    "modified_at": "",
    "modified_by": "user-yyyyyyyy",
    "name": "Production-Web-Servers",
    "product_name": "ServiceWatch",
    "resource_id": "c8e41e595ad040a8abe57e2ffc109113",
    "resource_name": "Production-Web-Servers",
    "resource_type": "dashboard",
    "service_code": "virtualserver",
    "share_type": "Private",
    "srn": "srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113",
    "type": "Custom",
    "widgets": [
        {
            "dashboard_id": "b48e730a70e74f6aa3d2555000b5c22b",
            "height": 1,
            "id": "75da70a1a4fb486ab0282cf90693ec3c",
            "order": 1,
            "properties": {
                "metrics": [
                    {
                        "color": "#ff7f0e",
                        "dimensions": [
                            {
                                "key": "InstanceId",
                                "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
                            }
                        ],
                        "display_name": "EC2-Prod-CPU",
                        "name": "CPUUtilization",
                        "namespace_name": "Virtual Server",
                        "period": 300,
                        "statistic_type": "AVG"
                    }
                ],
                "period": 300,
                "stacked": false,
                "statistic_type": "AVG",
                "title": "Virtual Server | CPU Utilization",
                "view": "line"
            },
            "type": "metric",
            "width": 1
        }
    ]
}

1.23.3 - 1.0

put /v1/dashboards/{dashboard_id}

Description

Set dashboard

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	dashboard_id required	Dashboard’s unique ID Example : `b48e730a70e74f6aa3d2555000b5c22b`	string	None
body	body required		DashboardUpdateRequest

Responses

HTTP Code	Description	Schema
200	OK	DashboardDetailResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/dashboards/{dashboard_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.0"

Request body

{
    "name": "Renamed-Dashboard",
    "widgets": [
        {
            "height": 1,
            "order": 1,
            "properties": {
                "metrics": [
                    {
                        "color": "#ff7f0e",
                        "dimensions": [
                            {
                                "key": "InstanceId",
                                "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
                            }
                        ],
                        "display_name": "EC2-Prod-CPU",
                        "individual_items": [
                            {
                                "key": "BucketId",
                                "value": "b-1234567890abcdef0"
                            }
                        ],
                        "name": "CPUUtilization",
                        "namespace_name": "Virtual Server",
                        "period": 300,
                        "statistic_type": "AVG"
                    }
                ],
                "period": 300,
                "stacked": false,
                "statistic_type": "AVG",
                "title": "Virtual Server | CPU Utilization",
                "view": "line"
            },
            "type": "metric",
            "width": 1
        }
    ]
}

Example HTTP response

Response 200

{
    "alerts": {
        "summary": {
            "high": 1,
            "low": 0,
            "medium": 3
        },
        "widgets": [
            {
                "properties": {
                    "metrics": [
                        {
                            "alerts": [
                                {
                                    "id": "",
                                    "name": ""
                                }
                            ],
                            "color": "#ff7f0e",
                            "dimensions": [
                                {
                                    "key": "InstanceId",
                                    "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
                                }
                            ],
                            "display_name": "EC2-Prod-CPU",
                            "individual_items": [
                                {
                                    "key": "BucketId",
                                    "value": "b-1234567890abcdef0"
                                }
                            ],
                            "name": "CPUUtilization",
                            "namespace_name": "Virtual Server",
                            "period": 300,
                            "statistic_type": "AVG"
                        }
                    ],
                    "period": 300,
                    "stacked": false,
                    "statistic_type": "AVG",
                    "title": "Virtual Server | CPU Utilization",
                    "view": "line"
                }
            }
        ]
    },
    "created_at": "2026-04-14T15:03:57.237Z",
    "created_by": "user-xxxxxxxx",
    "favorite_enabled": true,
    "id": "b48e730a70e74f6aa3d2555000b5c22b",
    "modified_at": "",
    "modified_by": "user-yyyyyyyy",
    "name": "Production-Web-Servers",
    "product_name": "ServiceWatch",
    "resource_id": "c8e41e595ad040a8abe57e2ffc109113",
    "resource_name": "Production-Web-Servers",
    "resource_type": "dashboard",
    "share_type": "Private",
    "srn": "srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113",
    "type": "Custom",
    "widgets": [
        {
            "dashboard_id": "b48e730a70e74f6aa3d2555000b5c22b",
            "height": 1,
            "id": "75da70a1a4fb486ab0282cf90693ec3c",
            "order": 1,
            "properties": {
                "metrics": [
                    {
                        "color": "#ff7f0e",
                        "dimensions": [
                            {
                                "key": "InstanceId",
                                "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
                            }
                        ],
                        "display_name": "EC2-Prod-CPU",
                        "individual_items": [
                            {
                                "key": "BucketId",
                                "value": "b-1234567890abcdef0"
                            }
                        ],
                        "name": "CPUUtilization",
                        "namespace_name": "Virtual Server",
                        "period": 300,
                        "statistic_type": "AVG"
                    }
                ],
                "period": 300,
                "stacked": false,
                "statistic_type": "AVG",
                "title": "Virtual Server | CPU Utilization",
                "view": "line"
            },
            "type": "metric",
            "width": 1
        }
    ]
}

1.24 - SetEventRule

1.24.1 - 1.2

patch /v1/event-rules/{event_rule_id}

Description

Set the Event rule.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	event_rule_id required	Event rule ID Example : `b73f95c698f540dab18860f72fafd03f`	string	None
body	body required		EventRuleSetRequest

Responses

HTTP Code	Description	Schema
200	OK	EventRuleShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/event-rules/{event_rule_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "active_yn": "Y",
    "description": "Event rule 1 description",
    "event_ids": [
        "014cb88ca2a9420e840d5c9ac16cac89",
        "28520cbbc8c54a3f86f513a9695e6481",
        "29f97b569020491ca63d37e27b2c7fec",
        "3339ebd5839e41c982a81803431f6932",
        "3fb112a5708f44549878c7de7159922d"
    ],
    "none_attributes": [
        "description",
        "resource_type_id",
        "event_ids",
        "srn_list",
        "recipient_ids"
    ],
    "recipient_ids": [
        "947c6a8559434505b28a5e21fff463d0",
        "aa57f19630b347f0b294f189acd098a7",
        "bc086de26abc4ea2b3e1322b14c013f3",
        "4af4507824924a7a9988a7bd3bd09bb7",
        "c0e4f5d4b0cf4dc5b8f6f915602949d5"
    ],
    "resource_type_id": "596bf16709e84e27b7df397bf59b877c",
    "service_id": "2778de83d7e247609445bbd570a4eba9",
    "srn_list": [
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a",
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/1fd94ff609dd40b3a873b306432059df",
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a23783834c7c4fd29b015632811b9a76",
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/704c0b21e1be44ba82a552d751d282d2",
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/63b5ea57e1254dfaa934cd76aaf3aade"
    ]
}

Example HTTP response

Response 200

{
    "event_rule": {
        "account_id": "1bcf39b344ac41cbaf0466ff0d2bebad",
        "active_yn": "Y",
        "created_at": "2026-04-14T15:03:58.209Z",
        "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "description": "Event rule 1 description",
        "id": "b73f95c698f540dab18860f72fafd03f",
        "modified_at": "2026-04-14T15:03:58.209Z",
        "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "name": "Event rule 1",
        "resource_type_id": "596bf16709e84e27b7df397bf59b877c",
        "service_id": "2778de83d7e247609445bbd570a4eba9"
    }
}

1.24.2 - 1.1

patch /v1/event-rules/{event_rule_id}

Description

Set the Event rule.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Type	Name	Description	Schema	Default
path	event_rule_id required	Event rule ID Example : `b73f95c698f540dab18860f72fafd03f`	string	None
body	body required		EventRuleSetRequest

Responses

HTTP Code	Description	Schema
200	OK	EventRuleShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/event-rules/{event_rule_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.1"

Request body

{
    "active_yn": "Y",
    "description": "Event rule 1 description",
    "event_ids": [
        "014cb88ca2a9420e840d5c9ac16cac89",
        "28520cbbc8c54a3f86f513a9695e6481",
        "29f97b569020491ca63d37e27b2c7fec",
        "3339ebd5839e41c982a81803431f6932",
        "3fb112a5708f44549878c7de7159922d"
    ],
    "none_attributes": [
        "description",
        "resource_type_id",
        "event_ids",
        "srn_list",
        "recipient_ids"
    ],
    "recipient_ids": [
        "947c6a8559434505b28a5e21fff463d0",
        "aa57f19630b347f0b294f189acd098a7",
        "bc086de26abc4ea2b3e1322b14c013f3",
        "4af4507824924a7a9988a7bd3bd09bb7",
        "c0e4f5d4b0cf4dc5b8f6f915602949d5"
    ],
    "resource_type_id": "596bf16709e84e27b7df397bf59b877c",
    "service_id": "2778de83d7e247609445bbd570a4eba9",
    "srn_list": [
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a",
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/1fd94ff609dd40b3a873b306432059df",
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a23783834c7c4fd29b015632811b9a76",
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/704c0b21e1be44ba82a552d751d282d2",
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/63b5ea57e1254dfaa934cd76aaf3aade"
    ]
}

Example HTTP response

Response 200

{
    "event_rule": {
        "account_id": "1bcf39b344ac41cbaf0466ff0d2bebad",
        "active_yn": "Y",
        "created_at": "2026-04-14T15:03:57.637Z",
        "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "description": "Event rule 1 description",
        "id": "b73f95c698f540dab18860f72fafd03f",
        "modified_at": "2026-04-14T15:03:57.637Z",
        "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "name": "Event rule 1",
        "resource_type_id": "596bf16709e84e27b7df397bf59b877c",
        "service_id": "2778de83d7e247609445bbd570a4eba9"
    }
}

1.24.3 - 1.0

patch /v1/event-rules/{event_rule_id}

Description

Set the Event rule.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	event_rule_id required	Event rule ID Example : `b73f95c698f540dab18860f72fafd03f`	string	None
body	body required		EventRuleSetRequest

Responses

HTTP Code	Description	Schema
200	OK	EventRuleShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/event-rules/{event_rule_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.0"

Request body

{
    "active_yn": "Y",
    "description": "Event rule 1 description",
    "event_ids": [
        "014cb88ca2a9420e840d5c9ac16cac89",
        "28520cbbc8c54a3f86f513a9695e6481",
        "29f97b569020491ca63d37e27b2c7fec",
        "3339ebd5839e41c982a81803431f6932",
        "3fb112a5708f44549878c7de7159922d"
    ],
    "none_attributes": [
        "description",
        "resource_type_id",
        "event_ids",
        "srn_list",
        "recipient_ids"
    ],
    "recipient_ids": [
        "947c6a8559434505b28a5e21fff463d0",
        "aa57f19630b347f0b294f189acd098a7",
        "bc086de26abc4ea2b3e1322b14c013f3",
        "4af4507824924a7a9988a7bd3bd09bb7",
        "c0e4f5d4b0cf4dc5b8f6f915602949d5"
    ],
    "resource_type_id": "596bf16709e84e27b7df397bf59b877c",
    "service_id": "2778de83d7e247609445bbd570a4eba9",
    "srn_list": [
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a",
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/1fd94ff609dd40b3a873b306432059df",
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a23783834c7c4fd29b015632811b9a76",
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/704c0b21e1be44ba82a552d751d282d2",
        "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/63b5ea57e1254dfaa934cd76aaf3aade"
    ]
}

Example HTTP response

Response 200

{
    "event_rule": {
        "account_id": "1bcf39b344ac41cbaf0466ff0d2bebad",
        "active_yn": "Y",
        "created_at": "2026-04-14T15:03:57.299Z",
        "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "description": "Event rule 1 description",
        "id": "b73f95c698f540dab18860f72fafd03f",
        "modified_at": "2026-04-14T15:03:57.299Z",
        "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "name": "Event rule 1",
        "resource_type_id": "596bf16709e84e27b7df397bf59b877c",
        "service_id": "2778de83d7e247609445bbd570a4eba9"
    }
}

1.25 - SetLogGroup

1.25.1 - 1.2

patch /v1/log-groups/{log_group_id}

Description

Set the Log group.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	log_group_id required	Log group ID Example : `bce52822147744b4afe0187164caa2e8`	string	None
body	body required		LogGroupSetRequest

Responses

HTTP Code	Description	Schema
200	OK	LogGroupShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/log-groups/{log_group_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Request body

{
    "retention_period": 365
}

Example HTTP response

Response 200

{
    "log_group": {
        "account_id": "1bcf39b344ac41cbaf0466ff0d2bebad",
        "created_at": "2026-04-14T15:03:58.330Z",
        "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "id": "bce52822147744b4afe0187164caa2e8",
        "modified_at": "2026-04-14T15:03:58.330Z",
        "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "name": "testlg01",
        "retention_period": 365,
        "retention_period_name": "1 year",
        "status": "ACTIVE"
    }
}

1.25.2 - 1.1

patch /v1/log-groups/{log_group_id}

Description

Set the Log group.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Type	Name	Description	Schema	Default
path	log_group_id required	Log group ID Example : `bce52822147744b4afe0187164caa2e8`	string	None
body	body required		LogGroupSetRequest

Responses

HTTP Code	Description	Schema
200	OK	LogGroupShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/log-groups/{log_group_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.1"

Request body

{
    "retention_period": 365
}

Example HTTP response

Response 200

{
    "log_group": {
        "account_id": "1bcf39b344ac41cbaf0466ff0d2bebad",
        "created_at": "2026-04-14T15:03:57.742Z",
        "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "id": "bce52822147744b4afe0187164caa2e8",
        "modified_at": "2026-04-14T15:03:57.742Z",
        "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "name": "testlg01",
        "retention_period": 365,
        "retention_period_name": "1 year",
        "status": "ACTIVE"
    }
}

1.25.3 - 1.0

patch /v1/log-groups/{log_group_id}

Description

Set the Log group.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	log_group_id required	Log group ID Example : `bce52822147744b4afe0187164caa2e8`	string	None
body	body required		LogGroupSetRequest

Responses

HTTP Code	Description	Schema
200	OK	LogGroupShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/log-groups/{log_group_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.0"

Request body

{
    "retention_period": 365
}

Example HTTP response

Response 200

{
    "log_group": {
        "account_id": "1bcf39b344ac41cbaf0466ff0d2bebad",
        "created_at": "2026-04-14T15:03:57.369Z",
        "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "id": "bce52822147744b4afe0187164caa2e8",
        "modified_at": "2026-04-14T15:03:57.369Z",
        "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "name": "testlg01",
        "retention_period": 365,
        "retention_period_name": "1 year",
        "status": "ACTIVE"
    }
}

1.26 - ShowAgentDownloadLink

1.26.1 - 1.2

get /v1/agents/download-link

Description

Show link to agent download

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Responses

HTTP Code	Description	Schema
200	OK	AgentDownloadLinkResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/agents/download-link

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Example HTTP response

Response 200

{
    "download_link": "https://object-store.private.{region}.{environment}.samsungsdscloud.com/account:swt-agent/1.0/ServiceWatch_Agent.zip"
}

1.26.2 - 1.1

get /v1/agents/download-link

Description

Show link to agent download

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Responses

HTTP Code	Description	Schema
200	OK	AgentDownloadLinkResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/agents/download-link

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.1"

Example HTTP response

Response 200

{
    "download_link": "https://object-store.private.{region}.{environment}.samsungsdscloud.com/account:swt-agent/1.0/ServiceWatch_Agent.zip"
}

1.27 - ShowAlert

1.27.1 - 1.2

get /v1/alerts/{id}

Description

Show the Alert

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	id required	Alert ID Example : `0ad6da92-634a-4f8c-932e-9d650599ab1e`	string	None

Responses

HTTP Code	Description	Schema
200	OK	AlertDetailResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/alerts/{id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Example HTTP response

Response 200

{
    "activated_yn": "Y",
    "created_at": "2026-04-14T15:03:57.934Z",
    "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
    "description": "Alert1 Description",
    "dimension": {
        "key": "InstanceId",
        "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
    },
    "dimensions": [
        {
            "key": "InstanceId",
            "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
        }
    ],
    "evaluation_count": 3,
    "evaluation_time_window": 900,
    "individual_items": [
        {
            "key": "VolumeID",
            "value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
        }
    ],
    "level": "HIGH",
    "lower_bound": 80.0,
    "metric_id": "d91097ac-0387-4e69-adb2-7b8d453b8db5",
    "metric_name": "CPU Usage/Core[Basic]",
    "metric_unit": "BYTE",
    "missing_data_option": "BREACHING",
    "modified_at": "2026-04-14T15:03:57.935Z",
    "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
    "name": "Alert1",
    "namespace_id": "d583a229-9766-4eb8-96c4-ec389902ba3d",
    "namespace_name": "Virtual Server",
    "operator": "RANGE",
    "period": 300,
    "srn": "srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::scp-servicewatch:alert/0ad6da92-634a-4f8c-932e-9d650599ab1e",
    "state": "NORMAL",
    "statistic": "AVG",
    "threshold": 80.0,
    "type": "METRIC_ALERT",
    "upper_bound": 90.0,
    "violation_count": 2
}

1.28 - ShowDashboard

1.28.1 - 1.2

get /v1/dashboards/{dashboard_id}

Description

Show dashboard

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	dashboard_id required	Dashboard’s unique ID Example : `b48e730a70e74f6aa3d2555000b5c22b`	string	None

Responses

HTTP Code	Description	Schema
200	OK	DashboardDetailResponseV1Dot1
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/dashboards/{dashboard_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Example HTTP response

Response 200

{
    "alerts": {
        "summary": {
            "high": 1,
            "low": 0,
            "medium": 3
        },
        "widgets": [
            {
                "properties": {
                    "metrics": [
                        {
                            "alerts": [
                                {
                                    "id": "",
                                    "name": ""
                                }
                            ],
                            "color": "#ff7f0e",
                            "dimensions": [
                                {
                                    "key": "InstanceId",
                                    "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
                                }
                            ],
                            "display_name": "EC2-Prod-CPU",
                            "individual_items": [
                                {
                                    "key": "BucketId",
                                    "value": "b-1234567890abcdef0"
                                }
                            ],
                            "name": "CPUUtilization",
                            "namespace_name": "Virtual Server",
                            "period": 300,
                            "statistic_type": "AVG"
                        }
                    ],
                    "period": 300,
                    "stacked": false,
                    "statistic_type": "AVG",
                    "title": "Virtual Server | CPU Utilization",
                    "view": "line"
                }
            }
        ]
    },
    "created_at": "2026-04-14T15:03:58.122Z",
    "created_by": "user-xxxxxxxx",
    "favorite_enabled": true,
    "id": "b48e730a70e74f6aa3d2555000b5c22b",
    "modified_at": "",
    "modified_by": "user-yyyyyyyy",
    "name": "Production-Web-Servers",
    "product_name": "ServiceWatch",
    "resource_id": "c8e41e595ad040a8abe57e2ffc109113",
    "resource_name": "Production-Web-Servers",
    "resource_type": "dashboard",
    "service_code": "virtualserver",
    "share_type": "Private",
    "srn": "srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113",
    "type": "Custom",
    "widgets": [
        {
            "dashboard_id": "b48e730a70e74f6aa3d2555000b5c22b",
            "height": 1,
            "id": "75da70a1a4fb486ab0282cf90693ec3c",
            "order": 1,
            "properties": {
                "metrics": [
                    {
                        "color": "#ff7f0e",
                        "dimensions": [
                            {
                                "key": "InstanceId",
                                "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
                            }
                        ],
                        "display_name": "EC2-Prod-CPU",
                        "name": "CPUUtilization",
                        "namespace_name": "Virtual Server",
                        "period": 300,
                        "statistic_type": "AVG"
                    }
                ],
                "period": 300,
                "stacked": false,
                "statistic_type": "AVG",
                "title": "Virtual Server | CPU Utilization",
                "view": "line"
            },
            "type": "metric",
            "width": 1
        }
    ]
}

1.28.2 - 1.1

get /v1/dashboards/{dashboard_id}

Description

Show dashboard

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20260831

Parameters

Type	Name	Description	Schema	Default
path	dashboard_id required	Dashboard’s unique ID Example : `b48e730a70e74f6aa3d2555000b5c22b`	string	None

Responses

HTTP Code	Description	Schema
200	OK	DashboardDetailResponseV1Dot1
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/dashboards/{dashboard_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.1"

Example HTTP response

Response 200

{
    "alerts": {
        "summary": {
            "high": 1,
            "low": 0,
            "medium": 3
        },
        "widgets": [
            {
                "properties": {
                    "metrics": [
                        {
                            "alerts": [
                                {
                                    "id": "",
                                    "name": ""
                                }
                            ],
                            "color": "#ff7f0e",
                            "dimensions": [
                                {
                                    "key": "InstanceId",
                                    "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
                                }
                            ],
                            "display_name": "EC2-Prod-CPU",
                            "individual_items": [
                                {
                                    "key": "BucketId",
                                    "value": "b-1234567890abcdef0"
                                }
                            ],
                            "name": "CPUUtilization",
                            "namespace_name": "Virtual Server",
                            "period": 300,
                            "statistic_type": "AVG"
                        }
                    ],
                    "period": 300,
                    "stacked": false,
                    "statistic_type": "AVG",
                    "title": "Virtual Server | CPU Utilization",
                    "view": "line"
                }
            }
        ]
    },
    "created_at": "2026-04-14T15:03:57.566Z",
    "created_by": "user-xxxxxxxx",
    "favorite_enabled": true,
    "id": "b48e730a70e74f6aa3d2555000b5c22b",
    "modified_at": "",
    "modified_by": "user-yyyyyyyy",
    "name": "Production-Web-Servers",
    "product_name": "ServiceWatch",
    "resource_id": "c8e41e595ad040a8abe57e2ffc109113",
    "resource_name": "Production-Web-Servers",
    "resource_type": "dashboard",
    "service_code": "virtualserver",
    "share_type": "Private",
    "srn": "srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113",
    "type": "Custom",
    "widgets": [
        {
            "dashboard_id": "b48e730a70e74f6aa3d2555000b5c22b",
            "height": 1,
            "id": "75da70a1a4fb486ab0282cf90693ec3c",
            "order": 1,
            "properties": {
                "metrics": [
                    {
                        "color": "#ff7f0e",
                        "dimensions": [
                            {
                                "key": "InstanceId",
                                "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
                            }
                        ],
                        "display_name": "EC2-Prod-CPU",
                        "name": "CPUUtilization",
                        "namespace_name": "Virtual Server",
                        "period": 300,
                        "statistic_type": "AVG"
                    }
                ],
                "period": 300,
                "stacked": false,
                "statistic_type": "AVG",
                "title": "Virtual Server | CPU Utilization",
                "view": "line"
            },
            "type": "metric",
            "width": 1
        }
    ]
}

1.28.3 - 1.0

get /v1/dashboards/{dashboard_id}

Description

Show dashboard

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20260630

Parameters

Type	Name	Description	Schema	Default
path	dashboard_id required	Dashboard’s unique ID Example : `b48e730a70e74f6aa3d2555000b5c22b`	string	None

Responses

HTTP Code	Description	Schema
200	OK	DashboardDetailResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/dashboards/{dashboard_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.0"

Example HTTP response

Response 200

{
    "alerts": {
        "summary": {
            "high": 1,
            "low": 0,
            "medium": 3
        },
        "widgets": [
            {
                "properties": {
                    "metrics": [
                        {
                            "alerts": [
                                {
                                    "id": "",
                                    "name": ""
                                }
                            ],
                            "color": "#ff7f0e",
                            "dimensions": [
                                {
                                    "key": "InstanceId",
                                    "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
                                }
                            ],
                            "display_name": "EC2-Prod-CPU",
                            "individual_items": [
                                {
                                    "key": "BucketId",
                                    "value": "b-1234567890abcdef0"
                                }
                            ],
                            "name": "CPUUtilization",
                            "namespace_name": "Virtual Server",
                            "period": 300,
                            "statistic_type": "AVG"
                        }
                    ],
                    "period": 300,
                    "stacked": false,
                    "statistic_type": "AVG",
                    "title": "Virtual Server | CPU Utilization",
                    "view": "line"
                }
            }
        ]
    },
    "created_at": "2026-04-14T15:03:57.219Z",
    "created_by": "user-xxxxxxxx",
    "favorite_enabled": true,
    "id": "b48e730a70e74f6aa3d2555000b5c22b",
    "modified_at": "",
    "modified_by": "user-yyyyyyyy",
    "name": "Production-Web-Servers",
    "product_name": "ServiceWatch",
    "resource_id": "c8e41e595ad040a8abe57e2ffc109113",
    "resource_name": "Production-Web-Servers",
    "resource_type": "dashboard",
    "share_type": "Private",
    "srn": "srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113",
    "type": "Custom",
    "widgets": [
        {
            "dashboard_id": "b48e730a70e74f6aa3d2555000b5c22b",
            "height": 1,
            "id": "75da70a1a4fb486ab0282cf90693ec3c",
            "order": 1,
            "properties": {
                "metrics": [
                    {
                        "color": "#ff7f0e",
                        "dimensions": [
                            {
                                "key": "InstanceId",
                                "value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
                            }
                        ],
                        "display_name": "EC2-Prod-CPU",
                        "individual_items": [
                            {
                                "key": "BucketId",
                                "value": "b-1234567890abcdef0"
                            }
                        ],
                        "name": "CPUUtilization",
                        "namespace_name": "Virtual Server",
                        "period": 300,
                        "statistic_type": "AVG"
                    }
                ],
                "period": 300,
                "stacked": false,
                "statistic_type": "AVG",
                "title": "Virtual Server | CPU Utilization",
                "view": "line"
            },
            "type": "metric",
            "width": 1
        }
    ]
}

1.29 - ShowEventRule

1.29.1 - 1.2

get /v1/event-rules/{event_rule_id}

Description

Show the Event rule.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	event_rule_id required	Event rule ID Example : `b73f95c698f540dab18860f72fafd03f`	string	None

Responses

HTTP Code	Description	Schema
200	OK	EventRuleShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/event-rules/{event_rule_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Example HTTP response

Response 200

{
    "event_rule": {
        "account_id": "1bcf39b344ac41cbaf0466ff0d2bebad",
        "active_yn": "Y",
        "created_at": "2026-04-14T15:03:58.192Z",
        "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "description": "Event rule 1 description",
        "id": "b73f95c698f540dab18860f72fafd03f",
        "modified_at": "2026-04-14T15:03:58.192Z",
        "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "name": "Event rule 1",
        "resource_type_id": "596bf16709e84e27b7df397bf59b877c",
        "service_id": "2778de83d7e247609445bbd570a4eba9"
    }
}

1.30 - ShowLogGroup

1.30.1 - 1.2

get /v1/log-groups/{log_group_id}

Description

Show the Log group.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	log_group_id required	Log group ID Example : `bce52822147744b4afe0187164caa2e8`	string	None

Responses

HTTP Code	Description	Schema
200	OK	LogGroupShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/log-groups/{log_group_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Example HTTP response

Response 200

{
    "log_group": {
        "account_id": "1bcf39b344ac41cbaf0466ff0d2bebad",
        "created_at": "2026-04-14T15:03:58.313Z",
        "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "id": "bce52822147744b4afe0187164caa2e8",
        "modified_at": "2026-04-14T15:03:58.313Z",
        "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "name": "testlg01",
        "retention_period": 365,
        "retention_period_name": "1 year",
        "status": "ACTIVE"
    }
}

1.31 - ShowLogStream

1.31.1 - 1.2

get /v1/log-groups/{log_group_id}/log-streams/{log_stream_id}

Description

Show the Log group log stream

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	log_group_id required	Log group ID Example : `bce52822147744b4afe0187164caa2e8`	string	None
path	log_stream_id required	Log stream ID Example : `b0fc99a46a2c44b8b22739b130853dd8`	string	None

Responses

HTTP Code	Description	Schema
200	OK	LogStreamShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/log-groups/{log_group_id}/log-streams/{log_stream_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = servicewatch 1.2"

Example HTTP response

Response 200

{
    "log_stream": {
        "collect_yn": "Y",
        "created_at": "2026-04-14T15:03:58.382Z",
        "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "id": "b0fc99a46a2c44b8b22739b130853dd8",
        "log_group_id": "bce52822147744b4afe0187164caa2e8",
        "modified_at": "2026-04-14T15:03:58.382Z",
        "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
        "name": "testls01"
    }
}

2 - Models

2.1 - AgentDownloadLinkResponse

Name	Description	Schema	Default
download_link required	URL to download agent Example : `https://object-store.private.{region}.{environment}.samsungsdscloud.com/account:swt-agent/1.0/ServiceWatch_Agent.zip`	string

2.2 - AlertActivatedSetRequest

Name	Description	Schema	Default
activated_yn required	Whether the Alert is activated or not Example : `Y`	enum (N, Y)

2.3 - AlertActivatedSetResponse

Name	Description	Schema
activated_yn required	Whether the Alert is activated or not Example : `Y`	enum (N, Y)
id required	Alert ID Example : `0ad6da92-634a-4f8c-932e-9d650599ab1e`	string
modified_at required	Modified date time Example : `2026-03-13T02:34:40.008404`	string (date-time)

2.4 - AlertCreateRequest

Name	Description	Schema	Default
description optional	Alert Description Example : `Alert1 Description`	any of [string, null]
dimension optional	Dimension	any of [DimensionDTO, null]
dimensions optional	List of Dimensions	any of [array[DimensionDTO], null]
evaluation_count optional	Evaluation Count for the Alert Condition Example : `3`	integer	1
individual_items optional	List of Individual Items	any of [array[MetricIndividualItemDto], null]
level required	Alert Level - HIGH, MIDDLE, LOW Example : `HIGH`	enum (HIGH, MIDDLE, LOW)
lower_bound optional	Lower bound for the Alert range operator Example : `80.0`	any of [object, null]
metric_id required	Metric ID Example : `d91097ac-0387-4e69-adb2-7b8d453b8db5`	string
missing_data_option optional	Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNORE Example : `BREACHING`	any of [enum (MISSING, BREACHING, NOT_BREACHING, IGNORE), null]	IGNORE
name required	Alert Name Example : `Alert1` Minimum length : `3` Maximum length : `100`	string
namespace_id required	Namespace ID Example : `d583a229-9766-4eb8-96c4-ec389902ba3d`	string
operator required	Operator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGE Example : `RANGE`	enum (GTE, GT, LTE, LT, EQ, NOT_EQ, RANGE)
period required	Period (seconds) Example : `300`	integer
recipient_ids optional	List of User IDs Example : `['1234da92-634a-4f8c-932e-9d650599ab1b', '1234da92-634a-4f8c-932e-9d650599ab1a', '1234da92-634a-4f8c-932e-9d650599ab1c']`	any of [array[string], null]
statistic required	Statistic - SUM, AVG, MAX, MIN Example : `AVG`	enum (AVG, SUM, MAX, MIN, CNT)
tags optional	List of Tags	any of [array[TagDTO], null]
threshold optional	Threshold for the Alert Condition (except fro RANGE operator) Example : `80.0`	any of [object, null]
upper_bound optional	Upper bound for the Alert range operator Example : `90.0`	any of [object, null]
violation_count optional	Violation Count for the Alert Condition Example : `2`	integer	1

2.5 - AlertCreateResponse

Name	Description	Schema
created_at required	Created date time Example :	string (date-time)
created_by required	Creator ID Example : `f4b8a4c4017f4f8d8399f0c02582ae47`	string
id required	Alert ID Example : `0ad6da92-634a-4f8c-932e-9d650599ab1e`	string

2.6 - AlertDeleteRequest

Name	Description	Schema	Default
ids required	List of Alert IDs Example : `['0ad6da92-634a-4f8c-932e-9d650599ab1e']`	array[string]

2.7 - AlertDeleteResponse

Name	Description	Schema	Default
ids required	List of Alert IDs Example : `['0ad6da92-634a-4f8c-932e-9d650599ab1e']`	array[string]

2.8 - AlertDescriptionSetRequest

Name	Description	Schema	Default
description optional	Alert Description Example : `Alert1 Description` Maximum length : `1000`	string

2.9 - AlertDescriptionSetResponse

Name	Description	Schema
description required	Alert Description Example : `Alert1 Description`	any of [string, null]
id required	Alert ID Example : `0ad6da92-634a-4f8c-932e-9d650599ab1e`	string
modified_at required	Modified date time Example : `2026-03-13T02:34:40.006634`	string (date-time)

2.10 - AlertDetailResponse

Name	Description	Schema
activated_yn required	Whether the Alert is activated or not Example : `Y`	enum (N, Y)
created_at required	Created date time Example :	string (date-time)
created_by required	Creator ID Example : `f4b8a4c4017f4f8d8399f0c02582ae47`	string
description required	Alert Description Example : `Alert1 Description`	any of [string, null]
dimension required	Dimension	DimensionDTO
dimensions required	List of Dimensions	array[DimensionDTO]
evaluation_count required	Evaluation Count for the Alert Condition Example : `3`	integer
evaluation_time_window required	Evaluation Time Window (period * evaluation_count) Example : `900`	integer
individual_items required	List of Individual Items	any of [array[MetricIndividualItemDto], null]
level required	Alert Level - HIGH, MIDDLE, LOW Example : `HIGH`	enum (HIGH, MIDDLE, LOW)
lower_bound required	Lower bound for the Alert range operator Example : `80.0`	any of [object, null]
metric_id required	Metric ID Example : `d91097ac-0387-4e69-adb2-7b8d453b8db5`	string
metric_name required	Metric Name Example : `CPU Usage/Core[Basic]`	string
metric_unit required	Metric Unit. Allowed Units: SECONDS, MICROSECONDS, MILLISECONDS, BYTES, KILOBYTES, MEGABYTES, GIGABYTES, TERABYTES, BITS, KILOBITS, MEGABITS, GIGABITS, TERABITS, PERCENT, COUNT, BYTES_PER_SECOND, KILOBYTES_PER_SECOND, MEGABYTES_PER_SECOND, GIGABYTES_PER_SECOND, TERABYTES_PER_SECOND, BITS_PER_SECOND, KILOBITS_PER_SECOND, MEGABITS_PER_SECOND, GIGABITS_PER_SECOND, TERABITS_PER_SECOND, COUNT_PER_SECOND, COUNT_PER_MINUTE, NONE Example : `BYTE`	string
missing_data_option required	Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNORE Example : `BREACHING`	enum (MISSING, BREACHING, NOT_BREACHING, IGNORE)
modified_at required	Modified date time Example :	string (date-time)
modified_by required	Modifier ID Example : `f4b8a4c4017f4f8d8399f0c02582ae47`	string
name required	Alert Name Example : `Alert1`	string
namespace_id required	Namespace ID Example : `d583a229-9766-4eb8-96c4-ec389902ba3d`	string
namespace_name required	Namespace Name Example : `Virtual Server`	string
operator required	Operator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGE Example : `RANGE`	enum (GTE, GT, LTE, LT, EQ, NOT_EQ, RANGE)
period required	Period (seconds) Example : `300`	integer
srn required	SDS cloud Resource Name of the Alert Example : `srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::scp-servicewatch:alert/0ad6da92-634a-4f8c-932e-9d650599ab1e`	string
state required	Alert State - NORMAL, ALERT, INSUFFICIENT_DATA Example : `NORMAL`	enum (INSUFFICIENT_DATA, NORMAL, ALERT)
statistic required	Statistic - SUM, AVG, MAX, MIN Example : `AVG`	enum (AVG, SUM, MAX, MIN, CNT)
threshold required	Threshold for the Alert Condition (except fro RANGE operator) Example : `80.0`	any of [object, null]
type required	Alert Type Example : `METRIC_ALERT`	enum (METRIC_ALERT, SERVICE_ALERT, COMPOSITE_ALERT)
upper_bound required	Upper bound for the Alert range operator Example : `90.0`	any of [object, null]
violation_count required	Violation Count for the Alert Condition Example : `2`	integer

2.11 - AlertPropertiesDTO

Name	Description	Schema
metrics required	List of metrics included in the widget	array[MetricAlertsDTO]
period optional	Query period (seconds) Example : `300`	any of [integer, null]
stacked required	Whether the graph is stacked Example : `False`	boolean
statistic_type optional	Statistical function Example : `AVG`	any of [string, null]
title required	Widget title Example : `Virtual Server \| CPU Utilization`	string
view required	View type Example : `line`	string

2.12 - AlertSetRequest

Name	Description	Schema	Default
dimension optional	Dimension	any of [DimensionDTO, null]
dimensions optional	List of Dimensions	any of [array[DimensionDTO], null]
evaluation_count optional	Evaluation Count for the Alert Condition Example : `3`	integer	1
individual_items optional	List of Individual Items	any of [array[MetricIndividualItemDto], null]
level required	Alert Level - HIGH, MIDDLE, LOW Example : `HIGH`	enum (HIGH, MIDDLE, LOW)
lower_bound optional	Lower bound for the Alert range operator Example : `80.0`	any of [object, null]
metric_id required	Metric ID Example : `d91097ac-0387-4e69-adb2-7b8d453b8db5`	string
missing_data_option optional	Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNORE Example : `BREACHING`	any of [enum (MISSING, BREACHING, NOT_BREACHING, IGNORE), null]	IGNORE
namespace_id required	Namespace ID Example : `d583a229-9766-4eb8-96c4-ec389902ba3d`	string
operator required	Operator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGE Example : `RANGE`	enum (GTE, GT, LTE, LT, EQ, NOT_EQ, RANGE)
period required	Period (seconds) Example : `300`	integer
statistic required	Statistic - SUM, AVG, MAX, MIN Example : `AVG`	enum (AVG, SUM, MAX, MIN, CNT)
threshold optional	Threshold for the Alert Condition (except fro RANGE operator) Example : `80.0`	any of [object, null]
upper_bound optional	Upper bound for the Alert range operator Example : `90.0`	any of [object, null]
violation_count optional	Violation Count for the Alert Condition Example : `2`	integer	1

2.13 - AlertSetResponse

Name	Description	Schema	Default
dimension required	Dimension	DimensionDTO
dimensions required	List of Dimensions	array[DimensionDTO]
id required	Alert ID Example : `0ad6da92-634a-4f8c-932e-9d650599ab1e`	string
individual_items required	List of Individual Items	any of [array[MetricIndividualItemDto], null]
level required	Alert Level - HIGH, MIDDLE, LOW Example : `HIGH`	enum (HIGH, MIDDLE, LOW)
lower_bound optional	Lower bound for the Alert range operator Example : `80.0`	any of [object, null]
metric_id required	Metric ID Example : `d91097ac-0387-4e69-adb2-7b8d453b8db5`	string
missing_data_option optional	Missing Data Option - MISSING, BREACHING, NOT_BREACHING, IGNORE Example : `BREACHING`	enum (MISSING, BREACHING, NOT_BREACHING, IGNORE)	IGNORE
modified_at required	Modified date time Example : `2026-03-13T02:34:40.010698`	string (date-time)
namespace_id required	Namespace ID Example : `d583a229-9766-4eb8-96c4-ec389902ba3d`	string
operator required	Operator - EQ, NOT_EQ, GT, GTE, LT, LTE, RANGE Example : `RANGE`	enum (GTE, GT, LTE, LT, EQ, NOT_EQ, RANGE)
period required	Period (seconds) Example : `300`	integer
statistic required	Statistic - SUM, AVG, MAX, MIN Example : `AVG`	enum (AVG, SUM, MAX, MIN, CNT)
threshold optional	Threshold for the Alert Condition (except fro RANGE operator) Example : `80.0`	any of [object, null]
upper_bound optional	Upper bound for the Alert range operator Example : `90.0`	any of [object, null]

2.14 - AlertsObjectDTO

Name	Description	Schema	Default
summary required	Alert summary	AlertSummaryDTO
widgets optional	List of widgets containing alert information	any of [array[DashboardAlertWidgetDTO], null]

2.15 - AlertSummaryDTO

Name	Description	Schema
high required	Number of high-severity alarms Example : `1`	integer
low required	Number of low-severity alarms Example : `0`	integer
medium required	Number of medium-severity alarms Example : `3`	integer

2.16 - CustomLogEventsCreateRequest

Name	Description	Schema	Default
resourceLogs required	Resource Logs	array[ResourceLogDTO]

2.17 - DashboardAlertWidgetDTO

Name	Description	Schema	Default
properties required	Widget’s detailed properties	AlertPropertiesDTO

2.18 - DashboardBulkDeleteRequest

Name	Description	Schema	Default
dashboard_ids required	List of dashboard IDs Example : `['b48e730a70e74f6aa3d2555000b5c22b', 'c48e730a70e74f6aa3d2555000b5c22b']`	array[string]

2.19 - DashboardBulkDeleteResponse

Name	Description	Schema	Default
dashboard_names required	List of dashboard’s name Example : `['dash-abc', 'dash-def']`	array[string]

2.20 - DashboardCreationRequest

Name	Description	Schema	Default
name required	Dashboard’s name Example : `New-Monitoring-Dashboard`	string
widgets optional	List of widgets included in the dashboard	any of [array[WidgetDTO], null]

2.21 - DashboardDetailResponse

Name	Description	Schema
alerts optional	Alert information related to the dashboard	any of [AlertsObjectDTO, null]
created_at required	Created date time Example :	string (date-time)
created_by required	Creator ID Example : `user-xxxxxxxx`	string
favorite_enabled required	Whether it is a favorite dashboard Example : `True`	boolean
id required	Dashboard’s unique ID Example : `b48e730a70e74f6aa3d2555000b5c22b`	string
modified_at optional	Modified date time Example :	any of [string (date-time), null]
modified_by optional	Modifier ID Example : `user-yyyyyyyy`	any of [string, null]
name required	Dashboard’s name Example : `Production-Web-Servers`	string
product_name required	Associated resource type Example : `ServiceWatch`	string
resource_id required	Associated resource ID Example : `c8e41e595ad040a8abe57e2ffc109113`	string
resource_name required	Associated resource name Example : `Production-Web-Servers`	string
resource_type required	Associated resource type Example : `dashboard`	string
share_type required	Sharing type Example : `Private`	string
srn required	Service resource name (SRN) Example : `srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113`	string
type required	Dashboard type Example : `Custom`	string
widgets optional	List of widgets included in the dashboard	any of [array[WidgetDetailDTO], null]

2.22 - DashboardDetailResponseV1Dot1

Name	Description	Schema
alerts optional	Alert information related to the dashboard	any of [AlertsObjectDTO, null]
created_at required	Created date time Example :	string (date-time)
created_by required	Creator ID Example : `user-xxxxxxxx`	string
favorite_enabled required	Whether it is a favorite dashboard Example : `True`	boolean
id required	Dashboard’s unique ID Example : `b48e730a70e74f6aa3d2555000b5c22b`	string
modified_at optional	Modified date time Example :	any of [string (date-time), null]
modified_by optional	Modifier ID Example : `user-yyyyyyyy`	any of [string, null]
name required	Dashboard’s name Example : `Production-Web-Servers`	string
product_name required	Associated resource type Example : `ServiceWatch`	string
resource_id required	Associated resource ID Example : `c8e41e595ad040a8abe57e2ffc109113`	string
resource_name required	Associated resource name Example : `Production-Web-Servers`	string
resource_type required	Associated resource type Example : `dashboard`	string
service_code optional	Associated service code Example : `virtualserver`	any of [string, null]
share_type required	Sharing type Example : `Private`	string
srn required	Service resource name (SRN) Example : `srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113`	string
type required	Dashboard type Example : `Custom`	string
widgets optional	List of widgets included in the dashboard	any of [array[WidgetDetailDtoV1Dot1], null]

2.23 - DashboardDTO

Name	Description	Schema
created_at required	Created date time Example :	string (date-time)
favorite_enabled required	Whether it is a favorite dashboard Example : `True`	boolean
id required	Dashboard’s unique ID Example : `b48e730a70e74f6aa3d2555000b5c22b`	string
modified_at required	Modified date time Example :	string (date-time)
name required	Dashboard’s name Example : `Production-Web-Servers`	string
type required	Dashboard type Example : `Custom`	string

2.24 - DashboardPageResponse

Name	Description	Schema
count required	count Example : `20`	integer
dashboards required	List of dashboards	array[DashboardDTO]
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

2.25 - DashboardUpdateRequest

Name	Description	Schema	Default
name optional	Dashboard’s name Example : `Renamed-Dashboard`	any of [string, null]
widgets optional	List of widgets included in the dashboard	any of [array[WidgetDTO], null]

2.26 - DimensionDTO

Name	Description	Schema	Default
key required	Dimension Key Example : `InstanceId` Pattern : `^[a-zA-Z][a-zA-Z0-9_]{2,127}$`	string
value required	Dimension Value Example : `10bf5d24-0f20-4066-bb0b-de2b1d6ff502`	string

2.27 - EventRuleCreateRequest

Name	Description	Schema
description optional	Event rule description Example : `Event rule 1 description`	any of [string, null]
event_ids optional	List of Event IDs Example : `['014cb88ca2a9420e840d5c9ac16cac89', '28520cbbc8c54a3f86f513a9695e6481', '29f97b569020491ca63d37e27b2c7fec', '3339ebd5839e41c982a81803431f6932', '3fb112a5708f44549878c7de7159922d']`	any of [array[string], null]
name required	Event rule name Example : `Event rule 1`	string
recipient_ids optional	Notification recipient IDs Example : `['947c6a8559434505b28a5e21fff463d0', 'aa57f19630b347f0b294f189acd098a7', 'bc086de26abc4ea2b3e1322b14c013f3', '4af4507824924a7a9988a7bd3bd09bb7', 'c0e4f5d4b0cf4dc5b8f6f915602949d5']`	any of [array[string], null]
resource_type_id optional	Resource type ID Example : `596bf16709e84e27b7df397bf59b877c`	any of [string, null]
service_id required	Service ID Example : `2778de83d7e247609445bbd570a4eba9`	string
srn_list optional	List of SDS cloud Resource Names Example : ['srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a', 'srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/1fd94ff609dd40b3a873b306432059df', 'srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a23783834c7c4fd29b015632811b9a76', 'srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/704c0b21e1be44ba82a552d751d282d2', 'srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/63b5ea57e1254dfaa934cd76aaf3aade']	any of [array[string], null]
tags optional	List of Tags Example : `[{'key': 'key01', 'value': 'value01'}, {'key': 'key02', 'value': 'value02'}]`	any of [array[ResourceTag], null]

2.28 - EventRuleDTO

Name	Description	Schema
account_id required	Account ID Example : `1bcf39b344ac41cbaf0466ff0d2bebad`	string
active_yn required	Whether the Event rule is active Example : `Y`	enum (N, Y)
created_at required	Created date time Example :	string (date-time)
created_by required	Creator ID Example : `f4b8a4c4017f4f8d8399f0c02582ae47`	string
description required	Event rule description Example : `Event rule 1 description`	any of [string, null]
id required	Event rule ID Example : `b73f95c698f540dab18860f72fafd03f`	string
modified_at required	Modified date time Example :	string (date-time)
modified_by required	Modifier ID Example : `f4b8a4c4017f4f8d8399f0c02582ae47`	string
name required	Event rule name Example : `Event rule 1`	string
resource_type_id required	Resource type ID Example : `596bf16709e84e27b7df397bf59b877c`	any of [string, null]
service_id required	Service ID Example : `2778de83d7e247609445bbd570a4eba9`	string

2.29 - EventRulesDeleteRequest

Name	Description	Schema	Default
ids required	List of Event rule IDs Example : `['66d77b4e32d04558b2382b1d14765d86', '3abcf524eb3d4457b39ef90eab2c9e48', 'ec67101ca2364ca28ad1e69b8084492d', 'f0620e8eb6a843aaaa2714494dfb7dbb', '0ecc082aa1e3485bba95419c47e0b741']`	array[string]

2.30 - EventRulesDeleteResponse

Name	Description	Schema	Default
ids required	List of Event rule IDs Example : `['66d77b4e32d04558b2382b1d14765d86', '3abcf524eb3d4457b39ef90eab2c9e48', 'ec67101ca2364ca28ad1e69b8084492d', 'f0620e8eb6a843aaaa2714494dfb7dbb', '0ecc082aa1e3485bba95419c47e0b741']`	array[string]

2.31 - EventRuleSetRequest

Name	Description	Schema
active_yn optional	Whether the Event rule is active Example : `Y`	any of [enum (N, Y), null]
description optional	Event rule description Example : `Event rule 1 description`	any of [string, null]
event_ids optional	List of Event IDs Example : `['014cb88ca2a9420e840d5c9ac16cac89', '28520cbbc8c54a3f86f513a9695e6481', '29f97b569020491ca63d37e27b2c7fec', '3339ebd5839e41c982a81803431f6932', '3fb112a5708f44549878c7de7159922d']`	any of [array[string], null]
none_attributes optional	List of attributes to assign to None Example : `['description', 'resource_type_id', 'event_ids', 'srn_list', 'recipient_ids']`	any of [array[string], null]
recipient_ids optional	Notification recipient IDs Example : `['947c6a8559434505b28a5e21fff463d0', 'aa57f19630b347f0b294f189acd098a7', 'bc086de26abc4ea2b3e1322b14c013f3', '4af4507824924a7a9988a7bd3bd09bb7', 'c0e4f5d4b0cf4dc5b8f6f915602949d5']`	any of [array[string], null]
resource_type_id optional	Resource type ID Example : `596bf16709e84e27b7df397bf59b877c`	any of [string, null]
service_id required	Service ID Example : `2778de83d7e247609445bbd570a4eba9`	string
srn_list optional	List of SDS cloud Resource Names Example : ['srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a58c8645928043a6868277c7d7fef11a', 'srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/1fd94ff609dd40b3a873b306432059df', 'srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/a23783834c7c4fd29b015632811b9a76', 'srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/704c0b21e1be44ba82a552d751d282d2', 'srn:dev2::1bcf39b344ac41cbaf0466ff0d2bebad:kr-west1::servicewatch:event-rule/63b5ea57e1254dfaa934cd76aaf3aade']	any of [array[string], null]

2.32 - EventRuleShowResponse

Name	Description	Schema	Default
event_rule required	Event rule	EventRuleDTO

2.33 - IndividualItemDTO

Name	Description	Schema	Default
key required	Individual item’s key Example : `bucket_id`	string
value required	Individual item’s value Example : `6870d9989ec3496c932de11b409ed9cc`	object

2.34 - LogAttributeDTO

Name	Description	Schema	Default
key required	Key Example :	string
value required	Value	LogValueDTO

2.35 - LogEventsCreateResponse

Name	Description	Schema	Default
status required	Status Example : `success`	string

2.36 - LogGroupCreateRequest

Name	Description	Schema
name required	Log group name Example : `testlg01`	string
retention_period required	Log group retention period Example : `365`	integer
tags optional	List of Tags Example : `[{'key': 'key01', 'value': 'value01'}, {'key': 'key02', 'value': 'value02'}]`	any of [array[ResourceTag], null]

2.37 - LogGroupDTO

Name	Description	Schema
account_id required	Account ID Example : `1bcf39b344ac41cbaf0466ff0d2bebad`	string
created_at required	Created date time Example :	string (date-time)
created_by required	Creator ID Example : `f4b8a4c4017f4f8d8399f0c02582ae47`	string
id required	Log group ID Example : `bce52822147744b4afe0187164caa2e8`	string
modified_at required	Modified date time Example :	string (date-time)
modified_by required	Modifier ID Example : `f4b8a4c4017f4f8d8399f0c02582ae47`	string
name required	Log group name Example : `testlg01`	string
retention_period required	Log group retention period Example : `365`	integer
retention_period_name required	Log group retention period name Example : `1 year`	string
status required	Log group status Example : `ACTIVE`	enum (ACTIVE, DELETING, DELETED)

2.38 - LogGroupLogStreamCreateRequest

Name	Description	Schema	Default
name required	Log stream name Example : `testls01`	string

2.39 - LogGroupLogStreamsDeleteRequest

Name	Description	Schema	Default
ids required	List of Log stream IDs Example : `['b0fc99a46a2c44b8b22739b130853dd8', '36dc853661144df687c4c7f158db5553', '3f611f40e9f841acbd62639b2779e35e', '5bd44e218eeb4f6190048a85599ade44', '188842fa2f13484ba6c9e210b817c780']`	array[string]

2.40 - LogGroupPageResponse

Name	Description	Schema
count required	count Example : `20`	integer
log_groups required	List of Log groups	array[LogGroupDTO]
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

2.41 - LogGroupsDeleteRequest

Name	Description	Schema	Default
ids required	List of Log group IDs Example : `['602b39cb1d6b4b7fb0f18de43a4c689c', 'bce52822147744b4afe0187164caa2e8', '953978a05b5d4ab8b2fc80bb5d0b8b6e', '3eeb8030bfca4e729b8332f6004628a4', '4a11695ad4b34539b4cee12db2a14aa9']`	array[string]

2.42 - LogGroupsDeleteResponse

Name	Description	Schema	Default
ids required	List of Log group IDs Example : `['602b39cb1d6b4b7fb0f18de43a4c689c', 'bce52822147744b4afe0187164caa2e8', '953978a05b5d4ab8b2fc80bb5d0b8b6e', '3eeb8030bfca4e729b8332f6004628a4', '4a11695ad4b34539b4cee12db2a14aa9']`	array[string]

2.43 - LogGroupSetRequest

Name	Description	Schema	Default
retention_period required	Log group retention period Example : `365`	integer

2.44 - LogGroupShowResponse

Name	Description	Schema	Default
log_group required	Log group	LogGroupDTO

2.45 - LogGroupsLogStreamsCollectCustomRequest

Name	Description	Schema	Default
log_group_name required	Log group name Example : `testlg01`	string
log_stream_name required	Log stream name Example : `testls01`	string

2.46 - LogGroupsLogStreamsCollectCustomResponse

Name	Description	Schema
account_id required	Account ID Example : `1bcf39b344ac41cbaf0466ff0d2bebad`	string
log_group_value required	Log group value Example : `fa6169af200b4d5db229aff384b2a028`	string
log_stream_value required	Log stream value Example : `551513c5182b45beb22eadb634cdccfb`	string
requests_per_second required	Export log requests per second Example : `500`	integer

2.47 - LogRecordDTO

Name	Description	Schema	Default
body required	Body	LogValueDTO
timeUnixNano required	Unix nano time Example : `1762336464000000000`	integer

2.48 - LogResourceDTO

Name	Description	Schema	Default
attributes required	Attributes Example : `[{'key': 'log_stream_value', 'value': {'stringValue': 'a1e2f3045678901a2b3c4d5e6f7a8b81'}}, {'key': 'log_group_value', 'value': {'stringValue': 'b1e2f3045678901a2b3c4d5e6f7a8b81'}}, {'key': 'account_id', 'value': {'stringValue': 'c1e2f3045678901a2b3c4d5e6f7a8b81'}}]`	array[LogAttributeDTO]

2.49 - LogStreamDTO

Name	Description	Schema
collect_yn required	Whether to collect logs or not Example : `Y`	enum (N, Y)
created_at required	Created date time Example :	string (date-time)
created_by required	Creator ID Example : `f4b8a4c4017f4f8d8399f0c02582ae47`	string
id required	Log stream ID Example : `b0fc99a46a2c44b8b22739b130853dd8`	string
log_group_id required	Log group ID Example : `bce52822147744b4afe0187164caa2e8`	string
modified_at required	Modified date time Example :	string (date-time)
modified_by required	Modifier ID Example : `f4b8a4c4017f4f8d8399f0c02582ae47`	string
name required	Log stream name Example : `testls01`	string

2.50 - LogStreamShowResponse

Name	Description	Schema	Default
log_stream required	Log stream	LogStreamDTO

2.51 - LogValueDTO

Name	Description	Schema	Default
stringValue required	String Value: account_id, log_group_value, log_stream_value Example : `level=info otlp test log`	string

2.52 - MetricAlert

Name	Description	Schema	Default
id required	Example :	string
name required	Example :	string

2.53 - MetricAlertDto

Name	Description	Schema	Default
id required	Alert ID Example : `0ad6da92-634a-4f8c-932e-9d650599ab1e`	string
name required	Alert Name Example : `Alert1`	string

2.54 - MetricAlertsDTO

Name	Description	Schema
alerts optional	List of Alerts	any of [array[MetricAlert], null]
color required	Metric line color Example : `#ff7f0e`	string
dimensions required	List of Dimensions	array[DimensionDTO]
display_name required	Display name (label) of the metric Example : `EC2-Prod-CPU`	string
individual_items optional	List of Individual Items Example : `[{'key': 'BucketId', 'value': 'b-1234567890abcdef0'}]`	any of [array[IndividualItemDTO], null]
name required	Metric Name Example : `CPUUtilization`	string
namespace_name required	Namespace Example : `Virtual Server`	string
period required	Query period (seconds) Example : `300`	integer
statistic_type required	Statistical function Example : `AVG`	string

2.55 - MetricCustomMetaRequest

Name	Description	Schema	Default
metricMetas required		array[MetricMetaDto]
namespace required	Namespace Example : `MyCustom/filestorage`	string

2.56 - MetricCustomMetaResponse

Name	Description	Schema
account_id required	Account ID of Metrics Example : `d79a5194b1a44a858969eb94754d3ba1`	string
max_data_points optional	Example :	integer
unit_logs required		array[UnitLogDto]

2.57 - MetricCustomRequest

Name	Description	Schema	Default
resource_metrics required	The resourceMetrics field holds a set of all metric data associated with a specific resource	array[OtlpResourceMetricDto]

2.58 - MetricDataImageDto

Name	Description	Schema
color optional	Color Example : `#0000ff`	any of [string, null]
dimensions required	List of Dimensions	array[MetricLabelDto]
display_name optional	Metric Display Name Example : `Virtual Server \| VirtualServer001 \| CPU Usage/Core[Basic]`	any of [string, null]
individual_items optional	List of Individual Items	any of [array[MetricLabelDto], null]
name required	Metric Name Example : `CPU Usage/Core[Basic]`	string
namespace_name required	Namespace Example : `Virtual Server`	string
period optional	Statistic Period Example : `300`	any of [integer, null]
statistic_type optional	Metric Statistics Type Example : `AVG`	any of [enum (AVG, SUM, MAX, MIN, CNT), null]

2.59 - MetricDataImageDtoV1Dot1

Name	Description	Schema
color optional	Color Example : `#0000ff`	any of [string, null]
dimensions required	List of Dimensions	array[MetricLabelDto]
display_name optional	Metric Display Name Example : `Virtual Server \| VirtualServer001 \| CPU Usage/Core[Basic]`	any of [string, null]
name required	Metric Name Example : `CPU Usage/Core[Basic]`	string
namespace_name required	Namespace Example : `Virtual Server`	string
period optional	Statistic Period Example : `300`	any of [integer, null]
statistic_type optional	Metric Statistics Type Example : `AVG`	any of [enum (AVG, SUM, MAX, MIN, CNT), null]

2.60 - MetricDataImageRequest

Name	Description	Schema	Default
end required	Metric End Time - Unix Timestamp Example : `1640995440` Maximum : `4102444800`	integer
height optional	Chart Image Height(pixels) Example : `400`	any of [integer, null]	500
metrics required		array[MetricDataImageDto]
period required	Statistic Period Example : `300`	integer
start required	Metric Start Time - Unix Timestamp Example : `1640995200` Maximum : `4102444800`	integer
statistic_type required	Metric Statistics Type Example : `AVG`	enum (AVG, SUM, MAX, MIN, CNT)
timezone optional	Timezone Example : `UTC`	any of [string, null]	UTC
title optional	Chart Title Example : `Virtual Server Metric Chart`	any of [string, null]
width optional	Chart Image Width(pixels) Example : `600`	any of [integer, null]	1400

2.61 - MetricDataImageRequestV1Dot1

Name	Description	Schema	Default
end required	Metric End Time - Unix Timestamp Example : `1640995440` Maximum : `4102444800`	integer
height optional	Chart Image Height(pixels) Example : `400`	any of [integer, null]	500
metrics required		array[MetricDataImageDtoV1Dot1]
period required	Statistic Period Example : `300`	integer
start required	Metric Start Time - Unix Timestamp Example : `1640995200` Maximum : `4102444800`	integer
statistic_type required	Metric Statistics Type Example : `AVG`	enum (AVG, SUM, MAX, MIN, CNT)
timezone optional	Timezone Example : `UTC`	any of [string, null]	UTC
title optional	Chart Title Example : `Virtual Server Metric Chart`	any of [string, null]
width optional	Chart Image Width(pixels) Example : `600`	any of [integer, null]	1400

2.62 - MetricDataRequest

Name	Description	Schema
end required	Metric End Time - Unix Timestamp Example : `1640995440` Maximum : `4102444800`	integer
metrics required		array[MetricDetailDto]
period required	Statistic Period Example : `300`	integer
start required	Metric Start Time - Unix Timestamp Example : `1640995200` Maximum : `4102444800`	integer
statistic_type required	Metric Statistics Type Example : `AVG`	enum (AVG, SUM, MAX, MIN, CNT)

2.63 - MetricDataRequestV1Dot1

Name	Description	Schema
end required	Metric End Time - Unix Timestamp Example : `1640995440` Maximum : `4102444800`	integer
metrics required		array[MetricDetailDtoV1Dot1]
period required	Statistic Period Example : `300`	integer
start required	Metric Start Time - Unix Timestamp Example : `1640995200` Maximum : `4102444800`	integer
statistic_type required	Metric Statistics Type Example : `AVG`	enum (AVG, SUM, MAX, MIN, CNT)

2.64 - MetricDataResponse

Name	Description	Schema	Default
metrics required		array[MetricDataResponseDto]

2.65 - MetricDataResponseDto

Name	Description	Schema
display_name required	Metric Display Name Example : `Virtual Server \| VirtualServer001 \| CPU Usage/Core[Basic]`	string
status required	Example :	string
values required	List of Metric Series Values Example : `[[1640995200, "45.5"]]`	array[array[any of [integer, string]]]

2.66 - MetricDetailDto

Name	Description	Schema
dimensions required	List of Dimensions	array[MetricLabelDto]
display_name optional	Metric Display Name Example : `Virtual Server \| VirtualServer001 \| CPU Usage/Core[Basic]`	any of [string, null]
individual_items optional	List of Individual Items	any of [array[MetricLabelDto], null]
name required	Metric Name Example : `CPU Usage/Core[Basic]`	string
namespace_name required	Namespace Example : `Virtual Server`	string
period optional	Statistic Period Example : `300`	any of [integer, null]
statistic_type optional	Metric Statistics Type Example : `AVG`	any of [enum (AVG, SUM, MAX, MIN, CNT), null]

2.67 - MetricDetailDtoV1Dot1

Name	Description	Schema
dimensions required	List of Dimensions	array[MetricLabelDto]
display_name optional	Metric Display Name Example : `Virtual Server \| VirtualServer001 \| CPU Usage/Core[Basic]`	any of [string, null]
name required	Metric Name Example : `CPU Usage/Core[Basic]`	string
namespace_name required	Namespace Example : `Virtual Server`	string
period optional	Statistic Period Example : `300`	any of [integer, null]
statistic_type optional	Metric Statistics Type Example : `AVG`	any of [enum (AVG, SUM, MAX, MIN, CNT), null]

2.68 - MetricDimensionDto

Name	Description	Schema
columns required		array[MetricsMetricColumnDto]
key required	Dimension Key Example : `InstanceId`	string
metrics required		array[MetricListDto]

2.69 - MetricDimensionDtoV1Dot1

Name	Description	Schema
columns required		array[MetricsMetricColumnDto]
keys required	Dimension Key Example : `InstanceId`	array[string]
metrics required		array[MetricListDtoV1Dot1]

2.70 - MetricDTO

Name	Description	Schema
color required	Metric line color Example : `#ff7f0e`	string
dimensions required	List of Dimensions	array[DimensionDTO]
display_name required	Display name (label) of the metric Example : `EC2-Prod-CPU`	string
individual_items optional	List of Individual Items Example : `[{'key': 'BucketId', 'value': 'b-1234567890abcdef0'}]`	any of [array[IndividualItemDTO], null]
name required	Metric Name Example : `CPUUtilization`	string
namespace_name required	Namespace Example : `Virtual Server`	string
period required	Query period (seconds) Example : `300`	integer
statistic_type required	Statistical function Example : `AVG`	string

2.71 - MetricDtoV1Dot1

Name	Description	Schema
color required	Metric line color Example : `#ff7f0e`	string
dimensions required	List of Dimensions	array[DimensionDTO]
display_name required	Display name (label) of the metric Example : `EC2-Prod-CPU`	string
name required	Metric Name Example : `CPUUtilization`	string
namespace_name required	Namespace Example : `Virtual Server`	string
period required	Query period (seconds) Example : `300`	integer
statistic_type required	Statistical function Example : `AVG`	string

2.72 - MetricIndividualItemDto

Name	Description	Schema	Default
key required	Individual Item Key Example : `VolumeID`	string
value required	Individual Item Value Example : `45fbde15-cdd2-4891-be31-4a9de75fccda`	string

2.73 - MetricLabelDto

Name	Description	Schema	Default
key required	Key Example : `VolumeID`	string
value required	Value Example : `45fbde15-cdd2-4891-be31-4a9de75fccda`	string

2.74 - MetricLabelNameDto

Name	Description	Schema	Default
key required	Key Example : `VolumeID`	string
value required	Value Example : `45fbde15-cdd2-4891-be31-4a9de75fccda`	any of [string, null]

2.75 - MetricListDto

Name	Description	Schema
alerts required	List of Alerts	any of [array[MetricAlertDto], null]
default_collection_interval required	Metric’s Default Collection Interval Example : `5m`	enum (NONE, 1s, 1m, 5m)
detailed_collection_interval required	Metric’s Detailed Collection Interval Example : `1m`	enum (NONE, 1s, 1m, 5m)
dimensions required	List of Dimensions	array[MetricLabelDto]
id required	Metric ID Example : `d91097ac-0387-4e69-adb2-7b8d453b8db5`	string
individual_items optional	List of Dimensions	any of [array[MetricLabelDto], null]
name required	Metric Name Example : `CPU Usage/Core[Basic]`	string
named_dimensions required	List of Dimensions	any of [array[MetricLabelNameDto], null]
namespace_id required	Namespace ID Example : `d583a229-9766-4eb8-96c4-ec389902ba3d`	string
namespace_name required	Namespace Example : `Virtual Server`	string
primary required	Primary Metric Example : `True`	boolean
recommended_stat_types required	List of Recommended Metric Statistics Example : `["AVG", "MAX"]`	array[string]
tags required	List of Tags	any of [array[TagDTO], null]
unit required	Metric Unit. Allowed Units: SECONDS, MICROSECONDS, MILLISECONDS, BYTES, KILOBYTES, MEGABYTES, GIGABYTES, TERABYTES, BITS, KILOBITS, MEGABITS, GIGABITS, TERABITS, PERCENT, COUNT, BYTES_PER_SECOND, KILOBYTES_PER_SECOND, MEGABYTES_PER_SECOND, GIGABYTES_PER_SECOND, TERABYTES_PER_SECOND, BITS_PER_SECOND, KILOBITS_PER_SECOND, MEGABITS_PER_SECOND, GIGABITS_PER_SECOND, TERABITS_PER_SECOND, COUNT_PER_SECOND, COUNT_PER_MINUTE, NONE Example : `BYTE`	string

2.76 - MetricListDtoV1Dot1

Name	Description	Schema
alerts required	List of Alerts	any of [array[MetricAlertDto], null]
default_collection_interval required	Metric’s Default Collection Interval Example : `5m`	enum (NONE, 1s, 1m, 5m)
detailed_collection_interval required	Metric’s Detailed Collection Interval Example : `1m`	enum (NONE, 1s, 1m, 5m)
dimensions required	List of Dimensions	array[MetricLabelDto]
id required	Metric ID Example : `d91097ac-0387-4e69-adb2-7b8d453b8db5`	string
name required	Metric Name Example : `CPU Usage/Core[Basic]`	string
named_dimensions required	List of Dimensions	any of [array[MetricLabelNameDto], null]
namespace_id required	Namespace ID Example : `d583a229-9766-4eb8-96c4-ec389902ba3d`	string
namespace_name required	Namespace Example : `Virtual Server`	string
primary required	Primary Metric Example : `True`	boolean
recommended_stat_types required	List of Recommended Metric Statistics Example : `["AVG", "MAX"]`	array[string]
tags required	List of Tags	any of [array[TagDTO], null]
unit required	Metric Unit. Allowed Units: SECONDS, MICROSECONDS, MILLISECONDS, BYTES, KILOBYTES, MEGABYTES, GIGABYTES, TERABYTES, BITS, KILOBITS, MEGABITS, GIGABITS, TERABITS, PERCENT, COUNT, BYTES_PER_SECOND, KILOBYTES_PER_SECOND, MEGABYTES_PER_SECOND, GIGABYTES_PER_SECOND, TERABYTES_PER_SECOND, BITS_PER_SECOND, KILOBITS_PER_SECOND, MEGABITS_PER_SECOND, GIGABITS_PER_SECOND, TERABITS_PER_SECOND, COUNT_PER_SECOND, COUNT_PER_MINUTE, NONE Example : `BYTE`	string

2.77 - MetricMetaDto

Name	Description	Schema
descriptionEn required	Description of Metrics in English Example : `filestorage volume total byte`	any of [string, null]
descriptionKo required	Description of Metrics in Korean Example : `파일스토리지 총 바이트 수`	any of [string, null]
dimensions required	List of Dimension Keys Example : `[['image_id']]`	array[array[string]]
metricName required	Metric Name Example : `Custom_filestorage_volume_total_byte`	string
storageResolution optional	Storage Resolution Example : `60`	any of [integer, null]
unit required	Metric Unit. Allowed Units: SECONDS, MICROSECONDS, MILLISECONDS, BYTES, KILOBYTES, MEGABYTES, GIGABYTES, TERABYTES, BITS, KILOBITS, MEGABITS, GIGABITS, TERABITS, PERCENT, COUNT, BYTES_PER_SECOND, KILOBYTES_PER_SECOND, MEGABYTES_PER_SECOND, GIGABYTES_PER_SECOND, TERABYTES_PER_SECOND, BITS_PER_SECOND, KILOBITS_PER_SECOND, MEGABITS_PER_SECOND, GIGABITS_PER_SECOND, TERABITS_PER_SECOND, COUNT_PER_SECOND, COUNT_PER_MINUTE, NONE Example : `Bytes`	any of [string, null]

2.78 - MetricNamespaceDto

Name	Description	Schema
dimensions required		array[MetricDimensionDto]
id required	Namespace ID Example : `d583a229-9766-4eb8-96c4-ec389902ba3d`	string
name required	Namespace Example : `Virtual Server`	string
service_name required	Example :	string

2.79 - MetricNamespaceDtoV1Dot1

Name	Description	Schema
dimensions required		array[MetricDimensionDtoV1Dot1]
id required	Namespace ID Example : `d583a229-9766-4eb8-96c4-ec389902ba3d`	string
name required	Namespace Example : `Virtual Server`	string
service_name required	Example :	string

2.80 - MetricSearchRequest

Name	Description	Schema
metric_name optional	Metric Name Example : `CPU Usage/Core[Basic]`	any of [string, null]
namespaces optional	List of Namespace	any of [array[SearchOptionNamespaceDto], null]
resource_id optional	Resource ID Example : `10bf5d24-0f20-4066-bb0b-de2b1d6ff502`	any of [string, null]
resource_name optional	Resource Name Example : `VirtualServer01`	any of [string, null]
tags optional	List of Tags	any of [array[TagDTO], null]

2.81 - MetricSearchRequestV1Dot1

Name	Description	Schema
metric_name optional	Metric Name Example : `CPU Usage/Core[Basic]`	any of [string, null]
namespaces optional	List of Namespace	any of [array[SearchOptionNamespaceDtoV1Dot1], null]
resource_id optional	Resource ID Example : `10bf5d24-0f20-4066-bb0b-de2b1d6ff502`	any of [string, null]
resource_name optional	Resource Name Example : `VirtualServer01`	any of [string, null]
tags optional	List of Tags	any of [array[TagDTO], null]

2.82 - MetricsMetricColumnDto

Name	Description	Schema
key required	Column Key Example : `name`	string
name_en required	Column Name Example : `지표명`	string
name_ko required	Column Name Example : `지표명`	string

2.83 - MetricsResponse

Name	Description	Schema	Default
count required	Count Example : `1`	integer
namespaces required		array[MetricNamespaceDto]

2.84 - MetricsResponseV1Dot1

Name	Description	Schema	Default
count required	Count Example : `1`	integer
namespaces required		array[MetricNamespaceDtoV1Dot1]

2.85 - OtlpAttributeDto

Name	Description	Schema	Default
key required	Key value of an Attribute. Generally, Resource Attributes are configured to signify the entity or environment from which the metric data was collected. Data Point Attributes represent the name of the label. Example :	string
value required	Value of Attribute. There are fields that correspond to multiple types, and only a single value may be sent. If more than one value is provided, only one will be accepted and the additional values will be dropped	OtlpAttributeValueDto

2.86 - OtlpAttributeValueDto

Name	Description	Schema
array_value optional	Array-typed Value of Attribute Example :	any of [array[object], null]
bool_value optional	Bool-typed Value of Attribute Example :	any of [boolean, null]
byte_value optional	Byte-typed Value of Attribute Example :	any of [string (binary), null]
double_value optional	Double-typed Value of Attribute Example :	any of [object, null]
int_value optional	Int-typed Value of Attribute Example :	any of [integer, null]
kvlist_value optional	Key-Value List-typed Value of Attribute Example :	any of [object, null]
string_value optional	String-typed Value of Attribute Example :	any of [string, null]

2.87 - OtlpGaugeDto

Name	Description	Schema	Default
data_points required	The dataPoints field contains a list of the actual observed values for a specific metric, where each value has a timestamp and a metric value. The value of a data point must be represented as either asInt or asDouble, and only a single value may be sent. If more than one value is provided, only one will be accepted and the additional values will be dropped	array[OtlpNumberDataPointDto]

2.88 - OtlpMetricDto

Name	Description	Schema
description optional	Description of Metric Example : `The total number of bytes read successfully.`	any of [string, null]
gauge optional	The gauge field is a metric type that represents a single value at a specific point in time, used for measuring fluctuating values like current memory usage or CPU temperature. either sum or gauge must be specified.	any of [OtlpGaugeDto, null]
name required	Name of Metric Example : `node_disk_read_bytes_total`	string
sum optional	The sum field is a metric type that represents a cumulative value over time, used for measuring quantities that only increase, like the number of requests or bytes sent. either sum or gauge must be specified.	any of [OtlpSumDto, null]
unit optional	Unit of Metric Example : `Bytes`	any of [string, null]

2.89 - OtlpNumberDataPointDto

Name	Description	Schema
as_double optional	Double-typed value of the metric Example : `0.75`	any of [object, null]
as_int optional	Int-typed value of the metric Example : `10`	any of [integer, null]
attributes required	Labels of Metric	array[OtlpAttributeDto]
start_time_unix_nano optional	Unix timestamp, expressed in nanoseconds, for the moment when the metric data began being measured (only used for sum, not for gauge) Example : `1753776789854000000`	any of [string, null]
time_unix_nano required	Unix timestamp, expressed in nanoseconds, for the moment when the metric data was measured or when the measurement ended Example : `1753776789854000000`	integer

2.90 - OtlpResourceDto

Name	Description	Schema	Default
attributes required	Resource attributes of Metric	array[OtlpAttributeDto]

2.91 - OtlpResourceMetricDto

Name	Description	Schema	Default
resource required	The resource field holds attributes that describe the entity or environment from which the metric data originated	OtlpResourceDto
scope_metrics required	The scopeMetrics field holds a set of all metric data associated with a specific instrumentation library/scope	array[OtlpScopeMetricDto]

2.92 - OtlpScopeDto

Name	Description	Schema	Default
name required	Name of the Collector that collected the metric Example : `ServiceWatch-Agent`	string
version optional	Version of the Collector that collected the metric Example : `1.0.0`	any of [string, null]

2.93 - OtlpScopeMetricDto

Name	Description	Schema	Default
metrics required	The metrics field contains a list of the actual metric data generated by the scope, where each item represents a single metric. The metric type can only be gauge or sum, and you must send exactly one value. If more than one value is provided, only one will be accepted and the additional values will be dropped	array[OtlpMetricDto]
scope required	The scope field identifies the instrumentation library or scope that generated the metrics, typically including its name and version	OtlpScopeDto

2.94 - OtlpSumDto

Name	Description	Schema
aggregation_temporality required	Aggregation Temporality defines the time window over which metric measurements are aggregated, specifying if the reported value is the cumulative sum (2) or the incremental change (1, Delta) since the last report or unspecified (0). Example : `2`	integer
data_points required	The dataPoints field contains a list of the actual observed values for a specific metric, where each value has a timestamp and a metric value. The value of a data point must be represented as either asInt or asDouble, and only a single value may be sent. If more than one value is provided, only one will be accepted and the additional values will be dropped	array[OtlpNumberDataPointDto]
is_monotonic required	Whether the value is monotonic Example : `True`	boolean

2.95 - PropertiesDTO

Name	Description	Schema
metrics required	List of metrics included in the widget	array[MetricDTO]
period optional	Query period (seconds) Example : `300`	any of [integer, null]
stacked required	Whether the graph is stacked Example : `False`	boolean
statistic_type optional	Statistical function Example : `AVG`	any of [string, null]
title required	Widget title Example : `Virtual Server \| CPU Utilization`	string
view required	View type Example : `line`	string

2.96 - PropertiesDtoV1Dot1

Name	Description	Schema
metrics required	List of metrics included in the widget	array[MetricDtoV1Dot1]
period optional	Query period (seconds) Example : `300`	any of [integer, null]
stacked required	Whether the graph is stacked Example : `False`	boolean
statistic_type optional	Statistical function Example : `AVG`	any of [string, null]
title required	Widget title Example : `Virtual Server \| CPU Utilization`	string
view required	View type Example : `line`	string

2.97 - ResourceLogDTO

Name	Description	Schema	Default
resource required	Resource	LogResourceDTO
scopeLogs required	Scope Log	array[ScopeLogDTO]

2.98 - ResourceTag

Name	Description	Schema	Default
key required	Example :	string
value required	Example :	string

2.99 - ScopeLogDTO

Name	Description	Schema	Default
logRecords required	Log Records	array[LogRecordDTO]

2.100 - SearchOptionNamespaceDto

Name	Description	Schema	Default
dimensions required	List of Dimensions Example : `["resource_id"]`	array[string]
name required	Namespace Example : `Virtual Server`	string

2.101 - SearchOptionNamespaceDtoV1Dot1

Name	Description	Schema	Default
dimensions required	List of Dimensions Example : `[["resource_id"]]`	array[array[string]]
name required	Namespace Example : `Virtual Server`	string

2.102 - TagDTO

Name	Description	Schema	Default
key required	Tag Key Example : `key01`	string
value required	Tag Value Example : `value01`	string

2.103 - UnitLogDto

Name	Description	Schema	Default
code required	RESPONSE STATUS CODE of Metric Example : `Success`	string
message required	Message about Updated Unit Info Example : `[libvirt_domain_info_virtual_cpus] unit is updated from Count to Bytes`	string

2.104 - WidgetDetailDTO

Name	Description	Schema
dashboard_id required	Dashboard’s unique ID Example : `b48e730a70e74f6aa3d2555000b5c22b`	string
height required	Widget’s height Example : `1`	integer
id required	Widget’s unique ID Example : `75da70a1a4fb486ab0282cf90693ec3c`	string
order required	Widget’s order in the dashboard Example : `1`	integer
properties required	Widget’s detailed properties	PropertiesDTO
type required	Widget type Example : `metric`	string
width required	Widget’s width Example : `1`	integer

2.105 - WidgetDetailDtoV1Dot1

Name	Description	Schema
dashboard_id required	Dashboard’s unique ID Example : `b48e730a70e74f6aa3d2555000b5c22b`	string
height required	Widget’s height Example : `1`	integer
id required	Widget’s unique ID Example : `75da70a1a4fb486ab0282cf90693ec3c`	string
order required	Widget’s order in the dashboard Example : `1`	integer
properties required	Widget’s detailed properties	PropertiesDtoV1Dot1
type required	Widget type Example : `metric`	string
width required	Widget’s width Example : `1`	integer

2.106 - WidgetDTO

Name	Description	Schema
height required	Widget’s height Example : `1`	integer
order required	Widget’s order in the dashboard Example : `1`	integer
properties required	Widget’s detailed properties	PropertiesDTO
type required	Widget type Example : `metric`	string
width required	Widget’s width Example : `1`	integer