{
  "opencollection": "1.0.0",
  "info": {
    "name": "CockroachDB Cloud APIKeys EgressRules API",
    "version": "2024-09-16"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "EgressRules",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List egress rules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cockroachlabs.cloud/api/v1/clusters/:cluster_id/networking/egress-rules",
            "params": [
              {
                "name": "cluster_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the CockroachDB Cloud cluster."
              },
              {
                "name": "pagination.page",
                "value": "",
                "type": "query",
                "description": "Page number for paginated results, starting from 1."
              },
              {
                "name": "pagination.limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results to return per page."
              },
              {
                "name": "pagination.as_of_time",
                "value": "",
                "type": "query",
                "description": "RFC3339 timestamp to return results as they were at a specific point in time (time-travel query)."
              },
              {
                "name": "pagination.sort_order",
                "value": "",
                "type": "query",
                "description": "Sort direction for paginated results. Accepted values are ASC and DESC."
              }
            ]
          },
          "docs": "Returns a list of egress traffic rules configured for the specified cluster. Supports pagination."
        },
        {
          "info": {
            "name": "Add an egress rule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://cockroachlabs.cloud/api/v1/clusters/:cluster_id/networking/egress-rules",
            "params": [
              {
                "name": "cluster_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the CockroachDB Cloud cluster."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds a new egress traffic rule to the cluster to permit outbound connections to specified destinations."
        },
        {
          "info": {
            "name": "Get an egress rule",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cockroachlabs.cloud/api/v1/clusters/:cluster_id/networking/egress-rules/:rule_id",
            "params": [
              {
                "name": "cluster_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the CockroachDB Cloud cluster."
              },
              {
                "name": "rule_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the egress rule."
              }
            ]
          },
          "docs": "Retrieves details of a specific egress rule by ID for the given cluster."
        },
        {
          "info": {
            "name": "Update an egress rule",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://cockroachlabs.cloud/api/v1/clusters/:cluster_id/networking/egress-rules/:rule_id",
            "params": [
              {
                "name": "cluster_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the CockroachDB Cloud cluster."
              },
              {
                "name": "rule_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the egress rule."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an existing egress rule configuration for the specified cluster."
        },
        {
          "info": {
            "name": "Delete an egress rule",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://cockroachlabs.cloud/api/v1/clusters/:cluster_id/networking/egress-rules/:rule_id",
            "params": [
              {
                "name": "cluster_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the CockroachDB Cloud cluster."
              },
              {
                "name": "rule_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the egress rule."
              },
              {
                "name": "idempotency_key",
                "value": "",
                "type": "query",
                "description": "Optional key for idempotent deletion."
              }
            ]
          },
          "docs": "Removes an egress rule from the cluster. An optional idempotency key may be supplied."
        }
      ]
    }
  ],
  "bundled": true
}