CockroachDB · Schema

AddEgressRuleRequest

Request body for adding an egress rule.

Cluster ManagementCloudDatabaseDistributed SQLInfrastructurePostgreSQL CompatibleSQL

Properties

Name Type Description
name string Name for the new egress rule.
destination string Destination FQDN or CIDR to allow outbound traffic to.
ports array List of destination ports to allow.
type string Rule type. Accepted values are FQDN and CIDR.
View JSON Schema on GitHub

JSON Schema

cockroachdb-addegressrulerequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AddEgressRuleRequest",
  "title": "AddEgressRuleRequest",
  "type": "object",
  "description": "Request body for adding an egress rule.",
  "required": [
    "name",
    "destination"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Name for the new egress rule."
    },
    "destination": {
      "type": "string",
      "description": "Destination FQDN or CIDR to allow outbound traffic to."
    },
    "ports": {
      "type": "array",
      "description": "List of destination ports to allow.",
      "items": {
        "type": "integer"
      }
    },
    "type": {
      "type": "string",
      "description": "Rule type. Accepted values are FQDN and CIDR."
    }
  }
}