Manage access list for public endpoints

Use access lists to limit what public endpoints are able to access your database. You can choose to restrict access in one of two ways:

  • Restrict access to specific IP addresses

  • Restrict access to a range of IP addresses using Classless Inter-Domain Routing (CIDR)

When Access List is configured and active, access to these endpoints is restricted:

  • CQL, GraphQL, and REST

  • GraphQL Playground

  • Swagger

  • CQLsh

This information applies to only serverless databases.

You can also manage your access list using the DevOps API.

If you are using the access list and restricting public access, these restrictions exclude the Astra internal site reliability controls.

Only Organization and Database Administrators for the database have permissions to manage the access list.

Restrict public access

By default, public access to your database is not restricted. Access to your database is possible via public internet.

  1. In your database Settings, select the toggle to restrict public access.

  2. Confirm your selection to Restrict Public Access.

Until you add an address to your access list, public access is still available.

Add IP address or CIDR to access list

  1. Ensure public access is restricted.

  2. Select Add Access.

  3. Select Add new endpoint.

  4. Select IP Address or CIDR from the Type menu.

    A CIDR indicates a range of IP addresses. For example, the CIDR range '192.168.0.0/16' represents the first IP address of '192.168.0.0' through the last IP address of '192.168.255.255'. The '/16' mask indicates that the first 16 bits of the IP address are static. The addresses in the CIDR range are represented by all the permutations of the last 16 bits.

  5. Enter the IP address or CIDR into the Address field.

    If you want to add you current IP address, copy it from the display and paste it into the Address field.

    All IP address must be entered in the IPv4 format, which is four decimal numbers, each ranging from 0 to 255. For example, 179.46.234.11.

  6. Optional: Add a description for the address you are adding. For example, office or home.

  7. Select Add to add the address to the access list.

It takes approximately five minutes for each address to sync and have access.

Upload list of endpoints

  1. Ensure public access is restricted.

  2. Select Add Access.

  3. Select Upload from file.

    [
      {
        "address": "10.0.0.1",
        "description": "Reader"
      },
      {
        "address": "10.0.0.1/32",
        "description": "Librarians"
      }
    ]
  4. Use the Select File button to find the JSON file with your access list to upload.

    You will see the list of addresses to be added to the access list.

  5. Select Import to add the addresses to your access list.

Import endpoints from database

You can import an access list from another Astra database. If you do not have another active Astra database, this option will not be available.

  1. Ensure public access is restricted.

  2. Select Add Access.

  3. Select Import from database.

  4. Select the active Astra database from which you want to import the addresses.

    You will see the list of addresses to be added to the access list.

  5. Select Import to add the addresses to your access list.

Enable or disable an endpoint

  1. Select the overflow menu for the address you want to enable or disable.

  2. Select Enable or Disable.

    The overflow menu will show the Disable option only when the address is enabled and the Enable option only when the address is disabled.

  3. Confirm your selection to Enable or Disable the endpoint.

Your access list remains active, even if all endpoints are disabled. If you want to allow public access, you must select the toggle to stop restricting public access.

Delete an endpoint

If you remove all of the addresses on your access list, your database will be accessible from the public internet, even if Restrict public access is selected.

  1. Select the overflow menu for the address you want to remove.

  2. Select Delete.

  3. Confirm your selection to Delete the endpoint.

It takes approximately five minutes for each address to sync and be removed from the access list.

Allow public access

If you stop restricting public access, access to your database is possible via public internet.

  1. Select the toggle to stop restricting public access.

  2. Confirm your selection to Enable public access.