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

    Delete IPs from a whitelist

    Deletes allowed IPs from the whitelist by specifying their IP addresses or ranges. You can configure the IP whitelist under Settings > Security > Allowed IPs on the Sendbird Dashboard.


    HTTP request

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

    Request body

    The following table lists the properties of an HTTP request that this action supports.

    Required
    Property nameTypeDescription

    ip_whitelist_addresses[]

    array

    Specifies an array of one or more IP ranges and addresses to delete from a whitelist.

    {
        "ip_whitelist_addresses": [ // To delete certain IP ranges, make them part of the request body.
            "160.8.1.0/24",
            "192.0.0.0/24",
            "192.0.2.2/32"
        ]
    }
    

    Response

    If successful, this action returns an empty cidr_whitelist_addresses property in the response body.

    {
        "ip_whitelist_addresses": [
            "192.165.0.0/21",
            "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.