Get console access rule

Prev Next

Available in Classic and VPC

Get sub account console access rules.

Request

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

Method URI
GET /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 example

The request example is as follows:

curl --location --request GET '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' 

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
subAccountId String - Sub account ID
useConsolePermitIp Boolean - 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 - List of IP range accessible to the console

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:

{
    "subAccountId": "2b141960-****-****-****-246e9659184c",
    "useConsolePermitIp": true,
    "consolePermitIps": [
        "10.0.0.0"
    ]
}