Allowlisting

Setting an allowlist in the UI

The UI for managing allowlists is on the Settings tab of your Deployment Overview.

Setting an allowlist through the CLI

The Cloud Databases CLI plug-in offers a set of commands for managing allowlists. Use cdb deployment-whitelist-add to add an allowlist.

To add a single IP address, use a command like:

ibmcloud cdb deployment-whitelist-add <INSTANCE_NAME_OR_CRN> 198.51.100.1 "Allowlisted for testing"

To add an IP address range, use a command like:

ibmcloud cdb deployment-whitelist-add <INSTANCE_NAME_OR_CRN> 198.51.100.0/24 "Testing range is now open"

The cdb deployment-whitelist-list command allows you to view the current allowlist.

Use a command like:

ibmcloud cdb deployment-whitelist-list <INSTANCE_NAME_OR_CRN>

For more information, see the Cloud Databases CLI plug-in reference page.

Setting an allowlist through the API

Manage your allowlist with the Cloud Databases API Authorization endpoint. Retrieve the current allowlist, add entries to the allowlist, and also bulk upload IP addresses to the allowlist from the API with this endpoint.

To add an address, use a command like:

curl -X POST https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/allowlists/ip_addresses -H 'Authorization: Bearer <>' -H 'Content-Type: application/json' -d '{"ip_address": {"address": "http://172.16.254.1/16", "description": "Dev IP space 3"}}' \

For more information, see Cloud Databases API Security.

Removing an allowlist in the UI

In the UI, remove an IP address or netmask from the allowlist by clicking Remove.

Removing an allowlist in the CLI

The cdb deployment-whitelist-delete command removes an IP address or range from the current allowlist for a deployment.

The command looks like:

ibmcloud cdb deployment-allowlist-delete <INSTANCE_NAME_OR_CRN> <ALLOWLIST ADDRESS OR RANGE> [--nowait] [--json]

When all entries on the allowlist are removed, the allowlist is disabled and all IP addresses are accepted by your deployment.

Removing an allowlist in the API

Delete an IP address or range with the Cloud Databases API Authorization endpoint.

The command looks like:

curl -X DELETE https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/allowlists/ip_addresses/{ipaddress} -H 'Authorization: Bearer <>' \

When all entries in the allowlist are removed, the allowlist is disabled and all IP addresses are accepted by your deployment.