Networking

View as Markdown

Resource management for secure Databricks Workspace deployment, cross-account IAM roles, storage, encryption, networking and private access.

List Ip Access ListsGET /api/2.0/ip-access-listsReplace Ip Access ListPUT /api/2.0/ip-access-lists/{list_id}

List Ip Access Lists GA

GET /api/2.0/ip-access-lists

Gets all IP access lists for the specified workspace.

API scopes: networking

Response

ip_access_listsarray of object

Show child attributesHide child attributes

list_idstring

Universally unique identifier (UUID) of the IP access list.

labelstring

Label for the IP access list. This cannot be empty.

Example: Office VPN

ip_addressesarray of string

Example: 192.168.100.0/22

address_countint32

Total number of IP or CIDR values.

Example: 2

list_typestring

Values: ALLOW, BLOCK

created_atint64

Creation timestamp in milliseconds.

Example: 1580265020299

created_byint64

User ID of the user who created this list.

Example: 202480738464078

updated_atint64

Update timestamp in milliseconds.

Example: 1580265020299

updated_byint64

User ID of the user who updated this list.

Example: 202480738464089

enabledboolean

Specifies whether this IP access list is enabled.

View as Markdown

Response

{
  "ip_access_lists": [
    {
      "address_count": 2,
      "created_at": 1668721146261,
      "created_by": 5145712326753123,
      "enabled": true,
      "ip_addresses": [
        "32.19.112.0",
        "192.168.100.0/22"
      ],
      "label": "Office VPN",
      "list_id": "4da50de0-fa72-4959-a76f-ca434c61e79a",
      "list_type": "ALLOW",
      "updated_at": 1679462174641,
      "updated_by": 5145712326753123
    },
    {
      "address_count": 3,
      "created_at": 1679681892421,
      "created_by": 5145712326753123,
      "enabled": true,
      "ip_addresses": [
        "198.54.117.59",
        "3.46.85.235/24",
        "251.3.208.1"
      ],
      "label": "Public Lobby",
      "list_id": "103e0ef1-a04b-4dda-8dcb-9c4369cb655d",
      "list_type": "BLOCK",
      "updated_at": 1679681892421,
      "updated_by": 5145712326753123
    }
  ]
}

Replace Ip Access List GA

PUT /api/2.0/ip-access-lists/{list_id}

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. Note that your resulting IP access list has no effect until you enable the feature. See workspaceconf/setStatus.

API scopes: networking

Parameters

list_idstringpath

The ID for the corresponding IP access list

Request body

labelstring

Label for the IP access list. This cannot be empty.

Example: Office VPN

list_typestring

Values: ALLOW, BLOCK

ip_addressesarray of string

Example: 192.168.100.0/22

enabledboolean

Specifies whether this IP access list is enabled.

Response

ip_access_listobject

Show child attributesHide child attributes

list_idstring

Universally unique identifier (UUID) of the IP access list.

labelstring

Label for the IP access list. This cannot be empty.

Example: Office VPN

ip_addressesarray of string

Example: 192.168.100.0/22

address_countint32

Total number of IP or CIDR values.

Example: 2

list_typestring

Values: ALLOW, BLOCK

created_atint64

Creation timestamp in milliseconds.

Example: 1580265020299

created_byint64

User ID of the user who created this list.

Example: 202480738464078

updated_atint64

Update timestamp in milliseconds.

Example: 1580265020299

updated_byint64

User ID of the user who updated this list.

Example: 202480738464089

enabledboolean

Specifies whether this IP access list is enabled.

View as Markdown

Request

{
  "label": "Office VPN",
  "list_type": "string",
  "ip_addresses": "192.168.100.0/22",
  "enabled": true
}

Response

{
  "ip_access_list": {
    "list_id": "string",
    "label": "Office VPN",
    "ip_addresses": "192.168.100.0/22",
    "address_count": 2,
    "list_type": "string",
    "created_at": 1580265020299,
    "created_by": 202480738464078,
    "updated_at": 1580265020299,
    "updated_by": 202480738464089,
    "enabled": true
  }
}