Instaclustr Logo
Powered by Redocly

Firewall Rule

Operations related to firewall rules of a cluster.

List all firewall rules

Lists all the firewall rules for the specified cluster.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Example: 0c7067d6-c70a-11ea-87d0-0242ac130003
Responses
200

List retrieved successfully.

400

Bad Request

401

Not Authorized

403

Forbidden

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

get/provisioning/v1/{clusterId}/firewallRules
Request samples 
Response samples 
application/json
[
  • {
    }
]
Update a firewall rule
Updates a firewall rule for the specified cluster as identified by the cluster id and network/security group id. Used for changing the port ranges that a particular cluster will accept requests on. Note: It can take up to 10 minutes for the firewall rule changes to reach a useable state. You may check the status of provisioning using the list firewall rules endpoint, or via the console.


SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
 
 Example:  0c7067d6-c70a-11ea-87d0-0242ac130003
Request Body schema: application/json
One of:
required
Array of objects (FirewallRuleKind)   unique 
 
securityGroupId
string^sg-([0-9a-fA-F]{8}|[0-9a-fA-F]{17})$
The security group to which the firewall rule relates.  Should not be included if network is already included.


 
Responses 
202
Firewall rule update request accepted


400
Bad Request


401
Not Authorized


403
Forbidden


404
Resource not found


415
Unsupported media type: returned when the payload is in an unsupported format.


429
Too many requests: returned when more than 35 requests per second are being received by your user.


put/provisioning/v1/{clusterId}/firewallRules
Request samples 
application/json
{
  • "rules": [
    ],
  • "securityGroupId": "sg-fa3dE817"
}
Response samples 
application/json
{
  • "message": "update firewall rule request accepted"
}
Create a firewall rule
Creates a firewall rule for the specified cluster.  The request will fail if the firewall rule already exists.


Note: It can take up to 10 minutes for the firewall rule to reach a useable state. You may check the status of provisioning using the list firewall rules endpoint, or via the console.


SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
 
 Example:  0c7067d6-c70a-11ea-87d0-0242ac130003
Request Body schema: application/json
One of:
required
Array of objects (FirewallRuleKind)   unique 
 
securityGroupId
string^sg-([0-9a-fA-F]{8}|[0-9a-fA-F]{17})$
The security group to which the firewall rule relates.  Should not be included if network is already included.


 
Responses 
202
Firewall rule creation request accepted


400
Bad Request


401
Not Authorized


403
Forbidden


404
Resource not found


415
Unsupported media type: returned when the payload is in an unsupported format.


429
Too many requests: returned when more than 35 requests per second are being received by your user.


post/provisioning/v1/{clusterId}/firewallRules
Request samples 
application/json
{
  • "rules": [
    ],
  • "securityGroupId": "sg-fa3dE817"
}
Response samples 
application/json
{
  • "message": "create firewall rule request accepted"
}
Delete a firewall rule
Deletes the specified firewall rule for the specified resource.


Note that the API responds with 202 Accepted for any valid IP address, even if it is not referenced in the cluster. To verify deletion, use the list firewall rules endpoint, or check the “Cassandra Allowed Addresses” section in the console.


Upon deletion, you may need to wait up to 10 minutes before provisioning a replacement using the same network.


SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
 
 Example:  0c7067d6-c70a-11ea-87d0-0242ac130003
Request Body schema: application/json
One of:
required
Array of objects (FirewallRuleKind)   unique 
 
securityGroupId
string^sg-([0-9a-fA-F]{8}|[0-9a-fA-F]{17})$
The security group to which the firewall rule relates.  Should not be included if network is already included.


 
Responses 
202
Firewall rule delete request accepted


400
Bad Request


401
Not Authorized


403
Forbidden


404
Resource not found


415
Unsupported media type: returned when the payload is in an unsupported format.


429
Too many requests: returned when more than 35 requests per second are being received by your user.


delete/provisioning/v1/{clusterId}/firewallRules
Request samples 
application/json
{
  • "rules": [
    ],
  • "securityGroupId": "sg-fa3dE817"
}
Response samples 
application/json
{
  • "message": "firewall rule marked for deletion"
}
➔ Next to Kafka ACL