This guide provides a brief description of Queue Service 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	20270220
1.0	SUPPORTED	20260919

OpenAPI URL

https://queueservice.{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

API Version History

1.2

Queue Service has been updated to version 1.2.

Changes

[New] PUT /queues/{queue_id}/deduplication - Update Queue Deduplication API has been changed.
[New] PUT /queues/{queue_id}/deduplication-scope - Update Queue Deduplication Scope API has been changed.
[Updated] GET /queues/{queue_id} - Show Queue API has been changed.
Response model has been changed to QueueShowResponseV1_2.
The following fields are added to the response:
- content_based_deduplication
- deduplication_scope
[Updated] GET /queues/{queue_id}/attributes - Get Queue Attributes API has been changed.
Response model has been changed to QueueShowResponseV1_2.
The following fields are added to the response:
- content_based_deduplication
- deduplication_scope
[Updated] POST /queues - Create Queue API has been changed.
Request model has been changed to QueueShowResponseV1_2.
The following fields are added to the request:
- content_based_deduplication
- deduplication_scope
[Updated] PUT /queues/{queue_id}/config - Update Queue Config API has been changed.
Response model has been changed to QueueShowResponseV1_2.
The following fields are added to the response:
- content_based_deduplication
- deduplication_scope

1.1

Queue Service has been updated to version 1.1.

Changes

[New] GET /queues/{queue_id}/attributes - Show Queue Attributes API has been added.
[Updated] GET /queues - List Queue API has been changed.
Response model has been changed to QueueListResponseV1_1.
The following fields are added to the response:
- queue_urls
The following fields are deleted to the response:
- queues
- page
- size
- sort
[Updated] GET /queues/{queue_id} - Show Queue API has been changed.
Response model has been changed to QueueListResponseV1_1.
The following fields are added to the response:
- privatelink_service_id
[Updated] PUT /queues/{queue_id}/config - Update Queue Config API has been changed.
Response model has been changed to QueueListResponseV1_1.
The following fields are added to the response:
- privatelink_service_id

1.0

Queue Service version 1.0 has been released.

Changes

[New] GET /queues - List Queue API has been added.
[New] GET /queues/check-duplication - Check Queue Name Duplication API has been added.
[New] GET /queues/{queue_id} - Show Queue API has been added.
[New] POST /queues - Create Queue API has been added.
[New] POST /queues/{queue_id}/acl - Set Acl API has been added.
[New] PUT /queues/{queue_id}/config - Update Queue Config API has been added.
[New] PUT /queues/{queue_id}/description - Update Queue Description API has been added.
[New] DELETE /queues - Delete Queue API has been added.
[New] DELETE /queues/{queue_id}/acl - Delete Acl API has been added.

1 - APIs

1.1 - Check Queue Name Duplication

1.1.1 - 1.2

get /v1/queues/check-duplication

Description

check queue name duplication

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
query	name required	Queue name Example : `test-queue.fifo`	string	None

Responses

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

Example HTTP request

Request path

/v1/queues/check-duplication?name={name}

Request header

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

Example HTTP response

Response 200

{
    "result": true
}

1.1.2 - 1.1

get /v1/queues/check-duplication

Description

check queue name duplication

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270220

Parameters

Type	Name	Description	Schema	Default
query	name required	Queue name Example : `test-queue.fifo`	string	None

Responses

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

Example HTTP request

Request path

/v1/queues/check-duplication?name={name}

Request header

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

Example HTTP response

Response 200

{
    "result": true
}

1.1.3 - 1.0

get /v1/queues/check-duplication

Description

check queue name duplication

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260919

Parameters

Type	Name	Description	Schema	Default
query	name required	Queue name Example : `test-queue.fifo`	string	None

Responses

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

Example HTTP request

Request path

/v1/queues/check-duplication?name={name}

Request header

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

Example HTTP response

Response 200

{
    "result": true
}

1.2 - Create Queue

1.2.1 - 1.2

post /v1/queues

Description

create a queue

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		QueueCreateRequestV1_2

Responses

HTTP Code	Description	Schema
201	Created	QueueCreateResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/queues

Request header

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

Request body

{
    "content_based_deduplication": false,
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "deduplication_scope": "Queue",
    "description": "Queue description",
    "encryption": {
        "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "name": "test-kms"
    },
    "message_retention_period": 40,
    "message_retention_period_unit": "minute",
    "message_size": 256,
    "name": "test-queue.fifo",
    "tags": [
        {
            "key": "key1",
            "value": "value1"
        }
    ]
}

Example HTTP response

Response 201

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "messages": "Create Queue",
    "state": "ACTIVE"
}

1.2.2 - 1.1

post /v1/queues

Description

create a queue

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270220

Parameters

Type	Name	Description	Schema	Default
body	body required		QueueCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	QueueCreateResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/queues

Request header

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

Request body

{
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "description": "Queue description",
    "encryption": {
        "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "name": "test-kms"
    },
    "message_retention_period": 40,
    "message_retention_period_unit": "minute",
    "message_size": 256,
    "name": "test-queue.fifo",
    "tags": [
        {
            "key": "key1",
            "value": "value1"
        }
    ]
}

Example HTTP response

Response 201

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "messages": "Create Queue",
    "state": "ACTIVE"
}

1.2.3 - 1.0

post /v1/queues

Description

create a queue

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260919

Parameters

Type	Name	Description	Schema	Default
body	body required		QueueCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	QueueCreateResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/queues

Request header

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

Request body

{
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "description": "Queue description",
    "encryption": {
        "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "name": "test-kms"
    },
    "message_retention_period": 40,
    "message_retention_period_unit": "minute",
    "message_size": 256,
    "name": "test-queue.fifo",
    "tags": [
        {
            "key": "key1",
            "value": "value1"
        }
    ]
}

Example HTTP response

Response 201

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "messages": "Create Queue",
    "state": "ACTIVE"
}

1.3 - Delete Acl

1.3.1 - 1.2

delete /v1/queues/{queue_id}/acl

Description

delete an acl policy

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		AclRequest

Responses

HTTP Code	Description	Schema
200	OK	AclResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_id}/acl

Request header

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

Request body

{
    "ip_address": [
        "192.168.0.0",
        "172.16.0.0/12"
    ]
}

Example HTTP response

Response 200

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}

1.3.2 - 1.1

delete /v1/queues/{queue_id}/acl

Description

delete an acl policy

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270220

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		AclRequest

Responses

HTTP Code	Description	Schema
200	OK	AclResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_id}/acl

Request header

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

Request body

{
    "ip_address": [
        "192.168.0.0",
        "172.16.0.0/12"
    ]
}

Example HTTP response

Response 200

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}

1.3.3 - 1.0

delete /v1/queues/{queue_id}/acl

Description

delete an acl policy

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260919

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		AclRequest

Responses

HTTP Code	Description	Schema
200	OK	AclResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_id}/acl

Request header

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

Request body

{
    "ip_address": [
        "192.168.0.0",
        "172.16.0.0/12"
    ]
}

Example HTTP response

Response 200

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}

1.4 - Delete Queue

1.4.1 - 1.2

delete /v1/queues/{queue_id}

Description

delete a specific queue

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_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 = queueservice 1.2"

Example HTTP response

Response 204

1.4.2 - 1.1

delete /v1/queues/{queue_id}

Description

delete a specific queue

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270220

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_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 = queueservice 1.1"

Example HTTP response

Response 204

1.4.3 - 1.0

delete /v1/queues/{queue_id}

Description

delete a specific queue

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260919

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_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 = queueservice 1.0"

Example HTTP response

Response 204

1.5 - Get Queue Attributes

1.5.1 - 1.2

get /v1/queues/{queue_id}/attributes

Description

get queue attributes

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
query	attributes required	Queue Attributes Example : `All`	string	None
query	name required	Queue name Example : `test-queue.fifo`	string	None

Responses

HTTP Code	Description	Schema
200	OK	GetAttributesResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_id}/attributes?attributes={attributes}&name={name}

Request header

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

Example HTTP response

Response 200

{
    "attributes": {
        "approximate_number_of_messages": 10,
        "content_based_deduplication": false,
        "created_at": "2025-05-22T06:21:17.580522",
        "data_key_reuse_period": 40,
        "deduplication_scope": "Queue",
        "message_retention_period": 40,
        "message_size": 256,
        "modified_at": "2025-05-22T06:21:17.580522",
        "queue_srn": "srn:dev2::8c9f6c1c928a45b4bbd1e4da5531d656:kr-west1:queueservice:queue/8c9f6c1c928a45b4bbd1e4da5531d656",
        "type": "FIFO"
    },
    "queue_url": "https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue"
}

1.5.2 - 1.1

get /v1/queues/{queue_id}/attributes

Description

get queue attributes

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270220

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
query	attributes required	Queue Attributes Example : `All`	string	None
query	name required	Queue name Example : `test-queue.fifo`	string	None

Responses

HTTP Code	Description	Schema
200	OK	GetAttributesResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_id}/attributes?attributes={attributes}&name={name}

Request header

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

Example HTTP response

Response 200

{
    "attributes": {
        "approximate_number_of_messages": 10,
        "content_based_deduplication": false,
        "created_at": "2025-05-22T06:21:17.580522",
        "data_key_reuse_period": 40,
        "deduplication_scope": "Queue",
        "message_retention_period": 40,
        "message_size": 256,
        "modified_at": "2025-05-22T06:21:17.580522",
        "queue_srn": "srn:dev2::8c9f6c1c928a45b4bbd1e4da5531d656:kr-west1:queueservice:queue/8c9f6c1c928a45b4bbd1e4da5531d656",
        "type": "FIFO"
    },
    "queue_url": "https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue"
}

1.6 - List Queue

1.6.1 - 1.2

get /v1/queues

Description

list queue

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Responses

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

Example HTTP request

Request path

/v1/queues

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "queue_urls": [
        "https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue",
        "https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue2"
    ]
}

1.6.2 - 1.1

get /v1/queues

Description

list queue

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270220

Responses

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

Example HTTP request

Request path

/v1/queues

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "queue_urls": [
        "https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue",
        "https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue2"
    ]
}

1.6.3 - 1.0

get /v1/queues

Description

list queue

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260919

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	name optional	Queue name Example : `test-queue.fifo`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/queues

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "queues": [
        {
            "account_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "encryption": {
                "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
                "name": "test-kms"
            },
            "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "test-queue.fifo",
            "number_wait_messages": 10,
            "state": "ACTIVE",
            "type": "FIFO"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.7 - Set Acl

1.7.1 - 1.2

post /v1/queues/{queue_id}/acl

Description

update an acl policy

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		AclRequest

Responses

HTTP Code	Description	Schema
200	OK	AclResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_id}/acl

Request header

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

Request body

{
    "ip_address": [
        "192.168.0.0",
        "172.16.0.0/12"
    ]
}

Example HTTP response

Response 200

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}

1.7.2 - 1.1

post /v1/queues/{queue_id}/acl

Description

update an acl policy

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270220

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		AclRequest

Responses

HTTP Code	Description	Schema
200	OK	AclResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_id}/acl

Request header

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

Request body

{
    "ip_address": [
        "192.168.0.0",
        "172.16.0.0/12"
    ]
}

Example HTTP response

Response 200

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}

1.7.3 - 1.0

post /v1/queues/{queue_id}/acl

Description

update an acl policy

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260919

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		AclRequest

Responses

HTTP Code	Description	Schema
200	OK	AclResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_id}/acl

Request header

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

Request body

{
    "ip_address": [
        "192.168.0.0",
        "172.16.0.0/12"
    ]
}

Example HTTP response

Response 200

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}

1.8 - Show Queue

1.8.1 - 1.2

get /v1/queues/{queue_id}

Description

show a specific queue

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None

Responses

HTTP Code	Description	Schema
200	OK	QueueShowResponseV1_2
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_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 = queueservice 1.2"

Example HTTP response

Response 200

{
    "account_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "allow_ip_access": [
        "192.168.0.0",
        "172.16.0.0/12"
    ],
    "content_based_deduplication": false,
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "deduplication_scope": "Queue",
    "description": "Queue description",
    "encryption": {
        "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "name": "test-kms"
    },
    "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
    "message_retention_period": 40,
    "message_retention_period_unit": "minute",
    "message_size": 256,
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "test-queue.fifo",
    "number_wait_messages": 10,
    "privatelink_service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "state": "ACTIVE",
    "type": "FIFO"
}

1.8.2 - 1.1

get /v1/queues/{queue_id}

Description

show a specific queue

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270220

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None

Responses

HTTP Code	Description	Schema
200	OK	QueueShowResponseV1_1
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_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 = queueservice 1.1"

Example HTTP response

Response 200

{
    "account_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "allow_ip_access": [
        "192.168.0.0",
        "172.16.0.0/12"
    ],
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "description": "Queue description",
    "encryption": {
        "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "name": "test-kms"
    },
    "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
    "message_retention_period": 40,
    "message_retention_period_unit": "minute",
    "message_size": 256,
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "test-queue.fifo",
    "number_wait_messages": 10,
    "privatelink_service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "state": "ACTIVE",
    "type": "FIFO"
}

1.8.3 - 1.0

get /v1/queues/{queue_id}

Description

show a specific queue

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260919

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None

Responses

HTTP Code	Description	Schema
200	OK	QueueShowResponseV1_0
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_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 = queueservice 1.0"

Example HTTP response

Response 200

{
    "account_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "allow_ip_access": [
        "192.168.0.0",
        "172.16.0.0/12"
    ],
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "description": "Queue description",
    "encryption": {
        "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "name": "test-kms"
    },
    "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
    "message_retention_period": 40,
    "message_retention_period_unit": "minute",
    "message_size": 256,
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "test-queue.fifo",
    "number_wait_messages": 10,
    "state": "ACTIVE",
    "type": "FIFO"
}

1.9 - Update Queue Config

1.9.1 - 1.2

put /v1/queues/{queue_id}/config

Description

update queue config

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		ConfigSetRequest

Responses

HTTP Code	Description	Schema
200	OK	QueueShowResponseV1_2
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_id}/config

Request header

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

Request body

{
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "encryption": {
        "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "name": "test-kms"
    },
    "message_retention_period": 40,
    "message_retention_period_unit": "minute",
    "message_size": 256
}

Example HTTP response

Response 200

{
    "account_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "allow_ip_access": [
        "192.168.0.0",
        "172.16.0.0/12"
    ],
    "content_based_deduplication": false,
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "deduplication_scope": "Queue",
    "description": "Queue description",
    "encryption": {
        "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "name": "test-kms"
    },
    "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
    "message_retention_period": 40,
    "message_retention_period_unit": "minute",
    "message_size": 256,
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "test-queue.fifo",
    "number_wait_messages": 10,
    "privatelink_service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "state": "ACTIVE",
    "type": "FIFO"
}

1.9.2 - 1.1

put /v1/queues/{queue_id}/config

Description

update queue config

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270220

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		ConfigSetRequest

Responses

HTTP Code	Description	Schema
200	OK	QueueShowResponseV1_2
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_id}/config

Request header

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

Request body

{
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "encryption": {
        "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "name": "test-kms"
    },
    "message_retention_period": 40,
    "message_retention_period_unit": "minute",
    "message_size": 256
}

Example HTTP response

Response 200

{
    "account_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "allow_ip_access": [
        "192.168.0.0",
        "172.16.0.0/12"
    ],
    "content_based_deduplication": false,
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "deduplication_scope": "Queue",
    "description": "Queue description",
    "encryption": {
        "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "name": "test-kms"
    },
    "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
    "message_retention_period": 40,
    "message_retention_period_unit": "minute",
    "message_size": 256,
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "test-queue.fifo",
    "number_wait_messages": 10,
    "privatelink_service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "state": "ACTIVE",
    "type": "FIFO"
}

1.9.3 - 1.0

put /v1/queues/{queue_id}/config

Description

update queue config

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260919

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		ConfigSetRequest

Responses

HTTP Code	Description	Schema
200	OK	QueueShowResponseV1_2
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_id}/config

Request header

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

Request body

{
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "encryption": {
        "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "name": "test-kms"
    },
    "message_retention_period": 40,
    "message_retention_period_unit": "minute",
    "message_size": 256
}

Example HTTP response

Response 200

{
    "account_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "allow_ip_access": [
        "192.168.0.0",
        "172.16.0.0/12"
    ],
    "content_based_deduplication": false,
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "deduplication_scope": "Queue",
    "description": "Queue description",
    "encryption": {
        "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "name": "test-kms"
    },
    "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
    "message_retention_period": 40,
    "message_retention_period_unit": "minute",
    "message_size": 256,
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "test-queue.fifo",
    "number_wait_messages": 10,
    "privatelink_service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "state": "ACTIVE",
    "type": "FIFO"
}

1.10 - Update Queue Deduplication

1.10.1 - 1.2

put /v1/queues/{queue_id}/deduplication

Description

update queue deduplication

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		DeduplicationSetRequest

Responses

HTTP Code	Description	Schema
200	OK	QueueShowResponseV1_2
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_id}/deduplication

Request header

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

Request body

{
    "content_based_deduplication": false
}

Example HTTP response

Response 200

{
    "account_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "allow_ip_access": [
        "192.168.0.0",
        "172.16.0.0/12"
    ],
    "content_based_deduplication": false,
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "deduplication_scope": "Queue",
    "description": "Queue description",
    "encryption": {
        "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "name": "test-kms"
    },
    "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
    "message_retention_period": 40,
    "message_retention_period_unit": "minute",
    "message_size": 256,
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "test-queue.fifo",
    "number_wait_messages": 10,
    "privatelink_service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "state": "ACTIVE",
    "type": "FIFO"
}

1.11 - Update Queue Deduplication Scope

1.11.1 - 1.2

put /v1/queues/{queue_id}/deduplication-scope

Description

update queue deduplication scope

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		DeduplicationScopeSetRequest

Responses

HTTP Code	Description	Schema
200	OK	QueueShowResponseV1_2
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_id}/deduplication-scope

Request header

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

Request body

{
    "deduplication_scope": "Queue"
}

Example HTTP response

Response 200

{
    "account_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "allow_ip_access": [
        "192.168.0.0",
        "172.16.0.0/12"
    ],
    "content_based_deduplication": false,
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "data_key_reuse_period": 40,
    "data_key_reuse_period_unit": "minute",
    "deduplication_scope": "Queue",
    "description": "Queue description",
    "encryption": {
        "id": "8c9f6c1c928a45b4bbd1e4da5531d656",
        "name": "test-kms"
    },
    "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
    "message_retention_period": 40,
    "message_retention_period_unit": "minute",
    "message_size": 256,
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "test-queue.fifo",
    "number_wait_messages": 10,
    "privatelink_service_id": "8c9f6c1c928a45b4bbd1e4da5531d656",
    "state": "ACTIVE",
    "type": "FIFO"
}

1.12 - Update Queue Description

1.12.1 - 1.2

put /v1/queues/{queue_id}/description

Description

update queue description

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		DescriptionSetRequest

Responses

HTTP Code	Description	Schema
200	OK	DescriptionSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_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 = queueservice 1.2"

Request body

{
    "description": "Queue description"
}

Example HTTP response

Response 200

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}

1.12.2 - 1.1

put /v1/queues/{queue_id}/description

Description

update queue description

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270220

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		DescriptionSetRequest

Responses

HTTP Code	Description	Schema
200	OK	DescriptionSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_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 = queueservice 1.1"

Request body

{
    "description": "Queue description"
}

Example HTTP response

Response 200

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}

1.12.3 - 1.0

put /v1/queues/{queue_id}/description

Description

update queue description

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20260919

Parameters

Type	Name	Description	Schema	Default
path	queue_id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string	None
body	body required		DescriptionSetRequest

Responses

HTTP Code	Description	Schema
200	OK	DescriptionSetResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/queues/{queue_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 = queueservice 1.0"

Request body

{
    "description": "Queue description"
}

Example HTTP response

Response 200

{
    "id": "8c9f6c1c928a45b4bbd1e4da5531d656"
}

2 - Models

2.1 - Acl

Name	Description	Schema	Default
ip_address required	IP address Example : `192.168.0.0/32`	string

2.2 - AclRequest

Name	Description	Schema	Default
ip_address required	Access Allowed IP List Example : `['192.168.0.0', '172.16.0.0/12']`	array[string]

2.3 - AclResponse

Name	Description	Schema	Default
id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string

2.4 - CheckDuplicationResponse

Name	Description	Schema	Default
result required	Result Example : `True`	boolean

2.5 - ConfigSetRequest

Name	Description	Schema
data_key_reuse_period optional	Data key reuse period Example : `40`	any of [integer, null]
data_key_reuse_period_unit optional	Period unit Example : `minute`	any of [enum (minute, hour), null]
encryption optional	Encryption	any of [Encryption, null]
message_retention_period required	Message retention period Example : `40` Minimum : `1` Maximum : `1209600`	integer
message_retention_period_unit required	Period unit Example : `minute`	enum (second, minute, hour, day)
message_size required	Message size Example : `256` Minimum : `1` Maximum : `256`	integer

2.6 - DeduplicationScopeSetRequest

Name	Description	Schema	Default
deduplication_scope required	Deduplication scope Example : `Queue`	enum (Queue, MessageGroup)

2.7 - DeduplicationSetRequest

Name	Description	Schema	Default
content_based_deduplication required	Content based deduplication Example : `False`	boolean

2.8 - DescriptionSetRequest

Name	Description	Schema	Default
description required	Description Example : `Queue description` Maximum length : `100`	string

2.9 - DescriptionSetResponse

Name	Description	Schema	Default
id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string

2.10 - Encryption

Name	Description	Schema	Default
id required	KMS ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	any of [string, null]
name required	KMS name Example : `test-kms`	any of [string, null]

2.11 - GetAttribute

Name	Description	Schema
approximate_number_of_messages required	Approximate number of messages Example : `10`	any of [string, null]
content_based_deduplication required	Content based deduplication Example : `False`	any of [boolean, null]
created_at required	Created At Example : `2025-05-22T06:21:17.580522`	any of [string (date-time), null]
data_key_reuse_period required	Data key reuse period Example : `40`	any of [integer, null]
deduplication_scope required	Deduplication scope Example : `Queue`	any of [enum (Queue, MessageGroup), null]
message_retention_period required	Message retention period Example : `40`	any of [integer, null]
message_size required	Message size Example : `256`	any of [integer, null]
modified_at required	Modified At Example : `2025-05-22T06:21:17.580522`	any of [string (date-time), null]
queue_srn required	SRN Example : `srn:dev2::8c9f6c1c928a45b4bbd1e4da5531d656:kr-west1:queueservice:queue/8c9f6c1c928a45b4bbd1e4da5531d656`	any of [string, null]
type required	Queue Type Example : `FIFO`	any of [string, null]

2.12 - GetAttributesResponse

Name	Description	Schema	Default
attributes required		any of [GetAttribute, object]
queue_url required	Queue URL Example : `https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue`	string

2.13 - Queue

Name	Description	Schema
account_id required	Account ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
encryption optional	Encryption	any of [Encryption, null]
id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Queue name Example : `test-queue.fifo`	string
number_wait_messages required	Number of waiting messages Example : `10`	integer
state required	Queue state Example : `ACTIVE`	string
type required	Queue Type Example : `FIFO`	string

2.14 - QueueCreateRequest

Name	Description	Schema
data_key_reuse_period optional	Data key reuse period Example : `40`	any of [integer, null]
data_key_reuse_period_unit optional	Period unit Example : `minute`	any of [enum (minute, hour), null]
description optional	Description Example : `Queue description`	any of [string, null]
encryption optional	Encryption	any of [Encryption, null]
message_retention_period required	Message retention period Example : `40` Minimum : `1` Maximum : `1209600`	integer
message_retention_period_unit required	Period unit Example : `minute`	enum (second, minute, hour, day)
message_size required	Message size Example : `256` Minimum : `1` Maximum : `256`	integer
name required	Queue name Example : `test-queue.fifo` Pattern : `^[a-z][a-z0-9-]$\|^[a-z][a-z0-9-]\.fifo$` Minimum length : `3` Maximum length : `64`	string
tags optional	Tag List	any of [array[Tag], null]

2.15 - QueueCreateRequestV1_2

Name	Description	Schema
content_based_deduplication optional	Content based deduplication Example : `False`	any of [boolean, null]
data_key_reuse_period optional	Data key reuse period Example : `40`	any of [integer, null]
data_key_reuse_period_unit optional	Period unit Example : `minute`	any of [enum (minute, hour), null]
deduplication_scope optional	Deduplication scope Example : `Queue`	any of [enum (Queue, MessageGroup), null]
description optional	Description Example : `Queue description`	any of [string, null]
encryption optional	Encryption	any of [Encryption, null]
message_retention_period required	Message retention period Example : `40` Minimum : `1` Maximum : `1209600`	integer
message_retention_period_unit required	Period unit Example : `minute`	enum (second, minute, hour, day)
message_size required	Message size Example : `256` Minimum : `1` Maximum : `256`	integer
name required	Queue name Example : `test-queue.fifo` Pattern : `^[a-z][a-z0-9-]$\|^[a-z][a-z0-9-]\.fifo$` Minimum length : `3` Maximum length : `64`	string
tags optional	Tag List	any of [array[Tag], null]

2.16 - QueueCreateResponse

Name	Description	Schema
id required	Queue ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
messages required	Description Example : `Create Queue`	string
state required	Queue state Example : `ACTIVE`	string

2.17 - QueueListResponseV1_0

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

2.18 - QueueListResponseV1_1

Name	Description	Schema	Default
count required	Count Example : `20`	integer
queue_urls required	Queue URL List Example : `['https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue', 'https://queueservice.kr-west1.dev2.samsungsdscloud.com/8c9f6c1c928a45b4bbd1e4da5531d656/queue2']`	array[string]

2.19 - QueueShowResponseV1_0

Name	Description	Schema
account_id required	Account ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
allow_ip_access optional	Access Allowed IP List Example : `['192.168.0.0', '172.16.0.0/12']`	any of [array[Acl], null]
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
data_key_reuse_period optional	Data key reuse period Example : `40`	any of [integer, null]
data_key_reuse_period_unit optional	Period unit Example : `minute`	any of [enum (minute, hour), null]
description optional	Description Example : `Queue description`	any of [string, null]
encryption optional	Encryption	any of [Encryption, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
message_retention_period required	Message retention period Example : `40`	integer
message_retention_period_unit required	Period unit Example : `minute`	enum (second, minute, hour, day)
message_size required	Message size Example : `256`	integer
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Queue name Example : `test-queue.fifo`	string
number_wait_messages required	Number of waiting messages Example : `10`	integer
state required	Queue state Example : `ACTIVE`	string
type required	Queue Type Example : `FIFO`	string

2.20 - QueueShowResponseV1_1

Name	Description	Schema
account_id required	Account ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
allow_ip_access optional	Access Allowed IP List Example : `['192.168.0.0', '172.16.0.0/12']`	any of [array[Acl], null]
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
data_key_reuse_period optional	Data key reuse period Example : `40`	any of [integer, null]
data_key_reuse_period_unit optional	Period unit Example : `minute`	any of [enum (minute, hour), null]
description optional	Description Example : `Queue description`	any of [string, null]
encryption optional	Encryption	any of [Encryption, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
message_retention_period required	Message retention period Example : `40`	integer
message_retention_period_unit required	Period unit Example : `minute`	enum (second, minute, hour, day)
message_size required	Message size Example : `256`	integer
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Queue name Example : `test-queue.fifo`	string
number_wait_messages required	Number of waiting messages Example : `10`	integer
privatelink_service_id required	Privatelink Service ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
state required	Queue state Example : `ACTIVE`	string
type required	Queue Type Example : `FIFO`	string

2.21 - QueueShowResponseV1_2

Name	Description	Schema
account_id required	Account ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
allow_ip_access optional	Access Allowed IP List Example : `['192.168.0.0', '172.16.0.0/12']`	any of [array[Acl], null]
content_based_deduplication required	Content based deduplication Example : `False`	boolean
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
data_key_reuse_period optional	Data key reuse period Example : `40`	any of [integer, null]
data_key_reuse_period_unit optional	Period unit Example : `minute`	any of [enum (minute, hour), null]
deduplication_scope optional	Deduplication scope Example : `Queue`	any of [enum (Queue, MessageGroup), null]
description optional	Description Example : `Queue description`	any of [string, null]
encryption optional	Encryption	any of [Encryption, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
message_retention_period required	Message retention period Example : `40`	integer
message_retention_period_unit required	Period unit Example : `minute`	enum (second, minute, hour, day)
message_size required	Message size Example : `256`	integer
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Queue name Example : `test-queue.fifo`	string
number_wait_messages required	Number of waiting messages Example : `10`	integer
privatelink_service_id required	Privatelink Service ID Example : `8c9f6c1c928a45b4bbd1e4da5531d656`	string
state required	Queue state Example : `ACTIVE`	string
type required	Queue Type Example : `FIFO`	string

2.22 - Tag

Name	Description	Schema	Default
key required	Tag Key Example : `key1`	string
value required	Tag Value Example : `value1`	any of [string, null]