CockroachDB · Schema

AllowlistEntry

An IP allowlist entry representing a CIDR range authorized to connect to a CockroachDB cluster.

Cluster ManagementCloudDatabaseDistributed SQLInfrastructurePostgreSQL CompatibleSQL

Properties

Name Type Description
cidr_ip string IPv4 address of the CIDR range.
cidr_mask integer Prefix length of the CIDR range.
name string Human-readable label for this allowlist entry.
ui boolean Whether this entry grants access to the DB Console (UI), in addition to SQL.
sql boolean Whether this entry grants SQL access.
View JSON Schema on GitHub

JSON Schema

cockroachdb-allowlistentry-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AllowlistEntry",
  "title": "AllowlistEntry",
  "type": "object",
  "description": "An IP allowlist entry representing a CIDR range authorized to connect to a CockroachDB cluster.",
  "required": [
    "cidr_ip",
    "cidr_mask"
  ],
  "properties": {
    "cidr_ip": {
      "type": "string",
      "description": "IPv4 address of the CIDR range."
    },
    "cidr_mask": {
      "type": "integer",
      "description": "Prefix length of the CIDR range.",
      "minimum": 0,
      "maximum": 32
    },
    "name": {
      "type": "string",
      "description": "Human-readable label for this allowlist entry."
    },
    "ui": {
      "type": "boolean",
      "description": "Whether this entry grants access to the DB Console (UI), in addition to SQL."
    },
    "sql": {
      "type": "boolean",
      "description": "Whether this entry grants SQL access."
    }
  }
}