Instaclustr Logo
Powered by Redocly

Apache Kafka ACL V3

Create a Kafka ACL.

SecurityBasic Authentication
Request
Request Body schema: application/json
required
currentOperationStatus
string (CurrentOperationStatus)

Indicates if the cluster is currently performing any operation such as being created, updated, or deleted

Enum: "NO_OPERATION" "OPERATION_IN_PROGRESS" "OPERATION_FAILED"
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/v3/
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/v3/{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
currentOperationStatus
string (CurrentOperationStatus) 
Indicates if the cluster is currently performing any operation such as being created, updated, or deleted


 Enum: "NO_OPERATION" "OPERATION_IN_PROGRESS" "OPERATION_FAILED"  
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/v3/{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/v3/{kafkaAclId}/
Request samples 
➔ Next to Apache Kafka Connect Mirror V2