Instaclustr Logo
Powered by Redocly

Apache Kafka ACL V2

List all ACLs in the Kafka cluster.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>

ID of the Kafka cluster.

Responses
200

Successfully retrieved Kafka ACLs.

get/cluster-management/v2/data-sources/kafka_cluster/{clusterId}/acls/v2/
Request samples 
Response samples 
application/json
[
  • {
    }
]
Search for ACLs in the Kafka cluster with optional filters as ACL parameters
SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
ID of the Kafka cluster.


 
query Parameters
principal
string
(Optional) Specifies the users(s) for which this ACL applies and can include the wildcard *. Valid values must start with "User:" including the wildcard


 
host
string
(Optional) The IP address to which this ACL applies. It takes any string including the wildcard * for all IP addresses


 
resourceType
string
(Optional) Specifies the type of resource


 Enum: "CLUSTER" "TOPIC" "GROUP" "DELEGATION_TOKEN" "TRANSACTIONAL_ID" "ANY"  
resourceName
string
(Optional) Any string that fits the resource name, e.g. topic name if the resource type is TOPIC


 
operation
string
(Optional) The operation that will be allowed or denied


 Enum: "ALL" "READ" "WRITE" "CREATE" "DELETE" "ALTER" "DESCRIBE" "CLUSTER_ACTION" "DESCRIBE_CONFIGS" "ALTER_CONFIGS" "IDEMPOTENT_WRITE" "ANY"  
permissionType
string
(Optional) Specifies whether to allow or deny the operation


 Enum: "ALLOW" "DENY" "ANY"  
patternType
string
(Optional) Indicates the resource-pattern-type


 Enum: "LITERAL" "PREFIXED" "ANY"  
Responses 
200
Successfully retrieved Kafka ACLs.


get/cluster-management/v2/data-sources/kafka_cluster/{clusterId}/acls/v2/search
Request samples 
Response samples 
application/json
[
  • {
    }
]
Create a Kafka ACL.
SecurityBasic Authentication 
Request 
Request Body schema: application/json
required
required
Array of objects (Root Type for KafkaAclV2) 
List of ACLs for the given principal.


 
userQuery
required
string
This is the principal without the User: prefix.


 
clusterId
required
string <uuid> 
UUID of the Kafka cluster.


 
Responses 
202
Kafka ACL creation requested.


post/cluster-management/v2/resources/applications/kafka/acls/v2/
Request samples 
application/json
{
  • "acls": [
    ],
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "id": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37_test",
  • "userQuery": "test"
}
Response samples 
application/json
{
  • "acls": [
    ],
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "id": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37_test",
  • "userQuery": "test"
}
Get list of Kafka ACLs for a given principal.
Get list of Kafka ACLs for a principal.


SecurityBasic Authentication 
Request 
path Parameters
kafkaAclId
required
string
 
Responses 
200
Kafka ACL details retrieved.


get/cluster-management/v2/resources/applications/kafka/acls/v2/{kafkaAclId}/
Request samples 
Response samples 
application/json
{
  • "acls": [
    ],
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "id": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37_test",
  • "userQuery": "test"
}
Update ACL list for a principal.
Update ACL list for a specific principal in a Kafka cluster.


SecurityBasic Authentication 
Request 
path Parameters
kafkaAclId
required
string
 
Request Body schema: application/json
required
required
Array of objects (Root Type for KafkaAclV2) 
List of ACLs for the given principal.


 
userQuery
required
string
This is the principal without the User: prefix.


 
clusterId
required
string <uuid> 
UUID of the Kafka cluster.


 
Responses 
202
Updated list of ACLs for the given kafkaAclId


put/cluster-management/v2/resources/applications/kafka/acls/v2/{kafkaAclId}/
Request samples 
application/json
{
  • "acls": [
    ],
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "id": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37_test",
  • "userQuery": "test"
}
Response samples 
application/json
{
  • "acls": [
    ],
  • "clusterId": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37",
  • "id": "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37_test",
  • "userQuery": "test"
}
Delete all ACLs associated with a principal.
Delete all ACLs associated with the given kafkaAclId.


SecurityBasic Authentication 
Request 
path Parameters
kafkaAclId
required
string
 
Responses 
204
Kafka ACL delete requested.


delete/cluster-management/v2/resources/applications/kafka/acls/v2/{kafkaAclId}/
Request samples 
➔ Next to Apache Kafka Connect Mirror V2