get-box-list

Available in VPC

Get the box list.

Request

This section describes the request format. The method and URI are as follows:

Request headers

For information about the headers common to all Datafence APIs, see Datafence request headers.

Request query parameters

You can use the following query parameters with your request:

Request example

The request example is as follows:

curl --location --request GET 'https://datafence.apigw.ntruss.com/api/v1/box/get-box-list?fenceId=26&page=1&size=10' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

content

The following describes content.

Response status codes

For information about the HTTP status codes common to all Datafence APIs, see Datafence API response status codes.

Response example

The response example is as follows:

{
    "totalCount": 1,
    "content": [
        {
            "boxId": 74,
            "boxName": "box1",
            "description": "",
            "statusCode": "USE",
            "statusName": "In use",
            "createDate": "2025-04-21T11:24:01+09:00"
        }
    ]
}