killContainer

Prev Next

Available in VPC

Restart the Data Forest app component's container.

Request

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

Method URI
POST /api/v2/apps/killContainer

Request headers

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

Request body

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

Field Type Required Description
id String Required App's unique identifier
  • 0-22 characters
  • UUID converted to Base62 format
  • See getList.
containerName String Required Container name

Request example

The request example is as follows:

curl --location --request POST 'https://df.apigw.ntruss.com/api/v2/apps/killContainer' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "id": "***ziexhg0FcWx5eGUA***",
    "containerName": "shell-0"
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
success Boolean - API processing result
  • true | false
    • true: succeeded
    • false: failed
message String - Result message
  • Displayed if success is false
id String - App's unique identifier
  • UUID converted to Base62 format

Response status codes

For information about the HTTP status codes common to all Data Forest APIs, see Data Forest response status codes.

Response example

The response example is as follows:

{
    "success": true,
    "id": "***ziexhg0FcWx5eGUA***"
}