This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

ListLogGroups

1: 1.4
2: 1.3
3: 1.2
4: 1.1
5: 1.0

1 - 1.4

get /v1/log-groups

Description

Get list of Log groups.

State ACTIVE (CURRENT)

Version	Not Before
1.4	-

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.4"

Example HTTP response

Response 200

{
    "count": 20,
    "log_groups": [
        {
            "account_id": "1bcf39b344ac41cbaf0466ff0d2bebad",
            "created_at": "2024-01-15T10:30:00.000Z",
            "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
            "id": "bce52822147744b4afe0187164caa2e8",
            "modified_at": "2024-01-15T10:30:00.000Z",
            "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
            "name": "testlg01",
            "retention_period": 365,
            "retention_period_name": "1 year",
            "status": "ACTIVE"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2 - 1.3

get /v1/log-groups

Description

Get list of Log groups.

State ACTIVE (SUPPORTED)

Version	Not Before
1.3	20270131

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.3"

Example HTTP response

Response 200

{
    "count": 20,
    "log_groups": [
        {
            "account_id": "1bcf39b344ac41cbaf0466ff0d2bebad",
            "created_at": "2024-01-15T10:30:00.000Z",
            "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
            "id": "bce52822147744b4afe0187164caa2e8",
            "modified_at": "2024-01-15T10:30:00.000Z",
            "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
            "name": "testlg01",
            "retention_period": 365,
            "retention_period_name": "1 year",
            "status": "ACTIVE"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

3 - 1.2

get /v1/log-groups

Description

Get list of Log groups.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261130

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": "2024-01-15T10:30:00.000Z",
            "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
            "id": "bce52822147744b4afe0187164caa2e8",
            "modified_at": "2024-01-15T10:30:00.000Z",
            "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
            "name": "testlg01",
            "retention_period": 365,
            "retention_period_name": "1 year",
            "status": "ACTIVE"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

4 - 1.1

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.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": "2024-01-15T10:30:00.000Z",
            "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
            "id": "bce52822147744b4afe0187164caa2e8",
            "modified_at": "2024-01-15T10:30:00.000Z",
            "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
            "name": "testlg01",
            "retention_period": 365,
            "retention_period_name": "1 year",
            "status": "ACTIVE"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

5 - 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": "2024-01-15T10:30:00.000Z",
            "created_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
            "id": "bce52822147744b4afe0187164caa2e8",
            "modified_at": "2024-01-15T10:30:00.000Z",
            "modified_by": "f4b8a4c4017f4f8d8399f0c02582ae47",
            "name": "testlg01",
            "retention_period": 365,
            "retention_period_name": "1 year",
            "status": "ACTIVE"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}