{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/cockroach-labs/main/json-schema/cockroach-labs-list-allowlist-entries-response-schema.json",
  "title": "ListAllowlistEntriesResponse",
  "description": "Paginated list of IP allowlist entries for a cluster.",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cockroach-labs-ipallowlists-api-openapi.yml#/components/schemas/ListAllowlistEntriesResponse",
  "type": "object",
  "properties": {
    "allowlist": {
      "type": "array",
      "description": "Array of allowlist entry objects.",
      "items": {
        "$ref": "#/$defs/AllowlistEntry"
      }
    },
    "pagination": {
      "$ref": "#/$defs/PaginationResponse"
    }
  },
  "$defs": {
    "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."
        }
      }
    },
    "PaginationResponse": {
      "type": "object",
      "description": "Pagination metadata included in list responses.",
      "properties": {
        "next": {
          "type": "string",
          "description": "Token or cursor for retrieving the next page of results."
        },
        "last": {
          "type": "string",
          "description": "Token or cursor for the last page of results."
        },
        "time": {
          "type": "string",
          "format": "date-time",
          "description": "Server time at which the paginated query was executed."
        }
      }
    }
  }
}