List Firewall Rules (Trusted Sources) for a Database Cluster

v1.0.0

To list all of a database cluster's firewall rules (known as "trusted sources" in the control panel), send a GET request to /v2/databases/$DATABASE_ID/firewall. The result will be a JSON object with a rules key.

Input

{
  "type": "object",
  "properties": {
    "database_cluster_uuid": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "database_cluster_uuid"
  ],
  "additionalProperties": false
}

Output

{
  "properties": {
    "rules": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "type",
          "value"
        ],
        "properties": {
          "cluster_uuid": {
            "type": "string",
            "description": "A unique ID for the database cluster to which the rule is applied."
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "A time value given in ISO8601 combined date and time format that represents when the firewall rule was created."
          },
          "type": {
            "type": "string",
            "description": "The type of resource that the firewall rule allows to access the database cluster.",
            "enum": [
              "droplet",
              "k8s",
              "ip_addr",
              "tag",
              "app"
            ]
          },
          "uuid": {
            "type": "string",
            "description": "A unique ID for the firewall rule itself."
          },
          "value": {
            "type": "string",
            "description": "The ID of the specific resource, the name of a tag applied to a group of resources, or the IP address that the firewall rule allows to access the database cluster."
          }
        }
      }
    }
  }
}