stop
    • PDF

    stop

    • PDF

    Article summary

    Available in VPC

    Stops the Data Forest app.

    Requests

    Request Parameters

    Parameter nameRequirement statusTypeRestrictionsDescription
    idYESStringEnter up to 22 characters.- App identifier UUID (base62)
    - id can be acquired through getList API of Apps.

    Request headers

    See common guide.

    Request bodies

    • JSON
        {
            "id": "string"
        }
      
    • XML
        <?xml version="1.0" encoding="UTF-8"?>
        <StopAppRequest>
            <id>string</id>
        </StopAppRequest>
      

    Responses

    Response bodies

    • JSON
        {
            "id": "string",
            "message": "string",
            "success": true
        }
      
    • XML
        <?xml version="1.0" encoding="UTF-8"?>
        <StopAppResponse>
            <id>string</id>
            <message>string</message>
            <success>true</success>
        </StopAppResponse>
      

    Errors

    See DataForest overview

    Examples

    Request Examples

    • HTTP
      POST https://df.apigw.ntruss.com/api/v2/apps/stop
      HOST: df.apigw.ntruss.com
      Content-Type: application/json
      x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
      x-ncp-apigw-timestamp: 1658898041497
      x-ncp-iam-access-key: 17F9A6E9F72BD92ED94B
      
      {
      "id": "A4LI7d5mRn1f6M2HxZAEE2"
      }
      
    • BASH
      curl -X POST "https://df.apigw.ntruss.com/api/v2/apps/stop" \
      -H "accept: application/json" \
      -H "Content-Type: application/json" \
      -H "x-ncp-apigw-timestamp:1658898041497" \
      -H "x-ncp-iam-access-key:17F9A6E9F72BD92ED94B" \
      -H "x-ncp-apigw-signature-v2:WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=" \
      -d "{ \"id\": \"A4LI7d5mRn1f6M2HxZAEE2\"}" \
      

    Response examples

    • HTTP

      HTTP StatusDescription
      200OK
    • BASH

      {
          "success": true,
          "message": "success",
          "id": "ek9BCiVvAWBblGwfuberG1"
      }
      

    Was this article helpful?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.