a.ip_access_lists: Account IP Access Lists

class databricks.sdk.service.settings.AccountIpAccessListsAPI

The Accounts IP Access List API enables account admins to configure IP access lists for access to the account console.

Account IP Access Lists affect web application access and REST API access to the account console and account APIs. If the feature is disabled for the account, all access is allowed for this account. There is support for allow lists (inclusion) and block lists (exclusion).

When a connection is attempted: 1. First, all block lists are checked. If the connection IP address matches any block list, the connection is rejected. 2. If the connection was not rejected by block lists, the IP address is compared with the allow lists.

If there is at least one allow list for the account, the connection is allowed only if the IP address matches an allow list. If there are no allow lists for the account, all IP addresses are allowed.

For all allow lists and block lists combined, the account supports a maximum of 1000 IP/CIDR values, where one CIDR counts as a single value.

After changes to the account-level IP access lists, it can take a few minutes for changes to take effect.

create(label: str, list_type: ListType [, ip_addresses: Optional[List[str]]]) → CreateIpAccessListResponse

Creates an IP access list for the account.

A list can be an allow list or a block list. See the top of this file for a description of how the server treats allow lists and block lists at runtime.

When creating or updating an IP access list:

  • For all allow lists and block lists combined, the API supports a maximum of 1000 IP/CIDR values,

where one CIDR counts as a single value. Attempts to exceed that number return error 400 with error_code value QUOTA_EXCEEDED. * If the new list would block the calling user’s current IP, error 400 is returned with error_code value INVALID_STATE.

It can take a few minutes for the changes to take effect.

Parameters:

  • label – str Label for the IP access list. This cannot be empty.

  • list_type – ListType

  • ip_addresses – List[str] (optional)

Returns:

CreateIpAccessListResponse

delete(ip_access_list_id: str)

Deletes an IP access list, specified by its list ID.

Parameters:

ip_access_list_id – str The ID for the corresponding IP access list

get(ip_access_list_id: str) → GetIpAccessListResponse

Gets an IP access list, specified by its list ID.

Parameters:

ip_access_list_id – str The ID for the corresponding IP access list

Returns:

GetIpAccessListResponse

list() → Iterator[IpAccessListInfo]

Gets all IP access lists for the specified account.

Returns:

Iterator over IpAccessListInfo

replace(ip_access_list_id: str, label: str, list_type: ListType, enabled: bool [, ip_addresses: Optional[List[str]]])

Replaces an IP access list, specified by its ID.

A list can include allow lists and block lists. See the top of this file for a description of how the server treats allow lists and block lists at run time. When replacing an IP access list: * For all allow lists and block lists combined, the API supports a maximum of 1000 IP/CIDR values, where one CIDR counts as a single value. Attempts to exceed that number return error 400 with error_code value QUOTA_EXCEEDED. * If the resulting list would block the calling user’s current IP, error 400 is returned with error_code value INVALID_STATE. It can take a few minutes for the changes to take effect.

Parameters:

  • ip_access_list_id – str The ID for the corresponding IP access list

  • label – str Label for the IP access list. This cannot be empty.

  • list_type – ListType

  • enabled – bool Specifies whether this IP access list is enabled.

  • ip_addresses – List[str] (optional)

update(ip_access_list_id: str [, enabled: Optional[bool], ip_addresses: Optional[List[str]], label: Optional[str], list_type: Optional[ListType]])

Updates an existing IP access list, specified by its ID.

A list can include allow lists and block lists. See the top of this file for a description of how the server treats allow lists and block lists at run time.

When updating an IP access list:

  • For all allow lists and block lists combined, the API supports a maximum of 1000 IP/CIDR values,

where one CIDR counts as a single value. Attempts to exceed that number return error 400 with error_code value QUOTA_EXCEEDED. * If the updated list would block the calling user’s current IP, error 400 is returned with error_code value INVALID_STATE.

It can take a few minutes for the changes to take effect.

Parameters:

  • ip_access_list_id – str The ID for the corresponding IP access list

  • enabled – bool (optional) Specifies whether this IP access list is enabled.

  • ip_addresses – List[str] (optional)

  • label – str (optional) Label for the IP access list. This cannot be empty.

  • list_type – ListType (optional)