return-data-box-frame

Prev Next

Available in VPC

Terminate Data Box Frame. This is an infrastructure termination that takes some time, so it will be processed asynchronously.

Request

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

Method URI
POST /api/v1/data-box-frame/return-data-box-frame

Request headers

For information about the headers common to all Data Box Frame APIs, see Data Box Frame request headers.

Request body

You can include the following data in the body of your request:

Field Type Required Description
dataBoxFrameNo Integer Required Data Box Frame number

Request example

The request example is as follows:

curl --location --request POST 'https://databoxframe.apigw.ntruss.com/api/v1/data-box-frame/return-data-box-frame' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "dataBoxFrameNo": 83
}' 

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
returnMessage String - API processing result message

Response status codes

For information about the response status codes common to all Data Box Frame APIs, see Data Box Frame API response status codes.

Response example

The response example is as follows:

{
    "returnMessage": "A Data Box Frame return has been requested."
}