MENU
      Get API access rule

        Get API access rule


        Article summary

        Available in Classic and VPC

        Get a sub account API access rule.

        Request

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

        MethodURI
        GET/api/v1/sub-accounts/{subAccountId}/access-rules/api

        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:

        FieldTypeRequiredDescription
        subAccountIdStringRequiredSub 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/api' \
        --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'
        Shell

        Response

        This section describes the response format.

        Response body

        The response body includes the following data:

        FieldTypeRequiredDescription
        useApiAllowSourceBoolean-Whether the accessible source for the API is restricted
        • true | false
          • true: Accessible only from specified sources
          • false: Accessible from all sources
        apiAllowSourcesArray-List of sources accessible via API

        apiAllowSources

        The following describes apiAllowSources.

        FieldTypeRequiredDescription
        typeString-Access source type
        • IP | VPC | VPC_SERVER
          • IP: Single server IP or IP range including subnet
          • VPC: VPC in use
          • VPC_SERVER: Server in the VPC environment in use
        sourceString-Accessible source information

        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:

        {
            "useApiAllowSource": true,
            "apiAllowSources": [
                {
                    "type": "IP",
                    "source": "***.***.***.***"
                }
            ]
        }
        JSON

        Was this article helpful?

        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.