Chat / Platform API
Current version: v3
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Home
    /
    Chat
    /
    Platform API
    /
    Application

    Get an IP whitelist

    Retrieves a list of all the IP ranges and addresses that have access to your Sendbird application. This list is called an IP whitelist and its addresses are granted API access when the IP whitelist API enables CIDR notation.


    HTTP request

    GET https://api-{application_id}.sendbird.com/v3/applications/settings/ip_whitelist
    

    Response

    If successful, this action returns a list of all the allowed IP ranges and addresses in the response body. If there isn't any IP ranges and addresses on the whitelist, this action returns an empty response.

    {
        "ip_whitelist_addresses": [
            "160.8.1.0/24",
            "192.0.2.2/32",
            "192.168.0.0/28",
            "192.168.100.10/32"
        ]
    }
    

    Note: If an API request from your server receives an error, check if an IP whitelist includes the IP addresses or ranges of your server.

    In the case of an error, an error object is returned. A detailed list of error codes is available here.