Edit console access rule

Prev Next

Available in Classic and VPC

Edit sub account console access rules.

Request

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

Method URI
PUT /api/v1/sub-accounts/{subAccountId}/access-rules/console

Request headers

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

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
subAccountId String Required Sub account ID

Request body

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

Field Type Required Description
useConsolePermitIp Boolean Required Whether the IP range accessible to the console is restricted
  • true | false
    • true: Accessible only from specified IP range
    • false: Accessible from everywhere
consolePermitIps Array Optional List of IP ranges accessible to the console
  • Up to 100 can be entered

Request example

The request example is as follows:

curl --location --request PUT 'https://subaccount.apigw.ntruss.com/api/v1/sub-accounts/2b141960-****-****-****-246e9659184c/access-rules/console' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
    "useConsolePermitIp": "true",
    "consolePermitIps": [
        "10.0.0.0"
    ]
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
success Boolean - API call success status
  • true | false
    • true: succeeded
    • false: failed
id String - Sub account ID

Response status codes

For information about the HTTP status codes common to all Sub Account APIs, see Sub Account status codes.

Response example

The response example is as follows:

{
    "success": true,
    "id": "2b141960-****-****-****-246e9659184c"
}