Instaclustr Logo
Powered by Redocly

Cluster Network Firewall Rule V2

Operations related to cluster network firewall rule, not supported for on-premises clusters

List all cluster network firewall rules

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>

ID of the cluster.

Responses
200

Successfully retrieved cluster network firewall rules.

get/cluster-management/v2/data-sources/cluster/{clusterId}/network-firewall-rules/v2
Request samples 
Response samples 
application/json
[
  • {
    }
]
Add a cluster network firewall rule
SecurityBasic Authentication 
Request 
Request Body schema: application/json
required
clusterId
required
string <uuid> 
ID of the cluster for the cluster network firewall rule.


 
type
required
string (FirewallRuleTypesV2) 
The type of firewall rule.


 Enum: "APACHE_ZOOKEEPER" "CADENCE" "CADENCE_GRPC" "CADENCE_HTTP_API" "CADENCE_WEB" "CASSANDRA" "CASSANDRA_CQL" "CLICKHOUSE" "CLICKHOUSE_WEB" "ELASTICSEARCH" "KAFKA" "KAFKA_CONNECT" "KAFKA_ENCRYPTION" "KAFKA_MTLS" "KAFKA_NO_ENCRYPTION" "KAFKA_PRIVATE_SASL_PLAINTEXT_LISTENER" "KAFKA_PUBLIC_SASL_PLAINTEXT_LISTENER" "KAFKA_PRIVATE_PLAINTEXT_LISTENER" "KAFKA_PUBLIC_PLAINTEXT_LISTENER" "KAFKA_PRIVATE_SSL_LISTENER" "KAFKA_PUBLIC_SSL_LISTENER" "KAFKA_REST_PROXY" "KAFKA_SCHEMA_REGISTRY" "KARAPACE_REST_PROXY" "KARAPACE_SCHEMA_REGISTRY" "OPENSEARCH" "OPENSEARCH_DASHBOARDS" "PGBOUNCER" "POSTGRESQL" "REDIS" "VALKEY" "SEARCH_DASHBOARDS" "SECURE_APACHE_ZOOKEEPER" "SPARK" "SPARK_JOBSERVER" "SHOTOVER_PROXY"  
network
required
string
The network of the cluster network firewall rule.


 
Responses 
202
Successfully added the cluster network firewall rule.


409
A firewall rule of that kind already exists for that address in cluster


post/cluster-management/v2/resources/network-firewall-rules/v2
Request samples 
application/json
{
  • "clusterId": "91346037-b969-4c4d-8112-59e1d2aa67e9",
  • "deferredReason": "",
  • "id": "c66477fa-6b2b-4850-915f-6d42a0e7cd64",
  • "network": "127.0.0.3/32",
  • "status": "GENESIS",
  • "type": "CASSANDRA_CQL"
}
Response samples 
application/json
{
  • "clusterId": "91346037-b969-4c4d-8112-59e1d2aa67e9",
  • "deferredReason": "",
  • "id": "c66477fa-6b2b-4850-915f-6d42a0e7cd64",
  • "network": "127.0.0.3/32",
  • "status": "GENESIS",
  • "type": "CASSANDRA_CQL"
}
Get cluster network firewall rule details
SecurityBasic Authentication 
Request 
path Parameters
firewallRuleId
required
string <uuid> 
ID of the cluster network firewall rule.


 
Responses 
200
Retrieved the details of the cluster network firewall rule.


404
Cluster network firewall rule not found


get/cluster-management/v2/resources/network-firewall-rules/v2/{firewallRuleId}
Request samples 
Response samples 
application/json
{
  • "clusterId": "91346037-b969-4c4d-8112-59e1d2aa67e9",
  • "deferredReason": "",
  • "id": "c66477fa-6b2b-4850-915f-6d42a0e7cd64",
  • "network": "127.0.0.3/32",
  • "status": "GENESIS",
  • "type": "CASSANDRA_CQL"
}
Delete cluster network firewall rule
SecurityBasic Authentication 
Request 
path Parameters
firewallRuleId
required
string <uuid> 
ID of the cluster network firewall rule.


 
Responses 
204
Cluster Network Firewall Rule successfully deleted.


404
Cluster Network Firewall Rule not found


delete/cluster-management/v2/resources/network-firewall-rules/v2/{firewallRuleId}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Cluster Network Firewall Rules V2