Available in VPC
Terminate a box. 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/box/return-box |
Request headers
For information about the headers common to all Datafence APIs, see Datafence request headers.
Request body
You can include the following data in the body of your request:
Field | Type | Required | Description |
---|---|---|---|
fenceId |
Integer | Required | Datafence number
|
boxId |
Integer | Required | Box number
|
Request example
The request example is as follows:
curl --location --request POST 'https://datafence.apigw.ntruss.com/api/v1/box/return-box' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
"fenceId": 26,
"boxId": 74
}'
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
message |
String | - | API processing result message |
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:
{
"message": "Box return requested."
}