Delete ACLs Run in API Explorer

DELETE /v1/acls

Delete all ACLs that match the filter criteria. The filter. query string parameters find matching ACLs that meet all specified conditions.

Query parameters

  • filter.resource_type string Required

    The type of resource (topic, consumer group, etc.) this ACL targets.

    Values are RESOURCE_TYPE_ANY, RESOURCE_TYPE_TOPIC, RESOURCE_TYPE_GROUP, RESOURCE_TYPE_CLUSTER, RESOURCE_TYPE_TRANSACTIONAL_ID, RESOURCE_TYPE_DELEGATION_TOKEN, or RESOURCE_TYPE_USER.

  • filter.resource_name string

    The name of the resource this ACL targets.

  • filter.resource_pattern_type string Required

    The pattern to use for matching the specified resource_name (any, exact match, literal, or prefixed).

    Values are RESOURCE_PATTERN_TYPE_ANY, RESOURCE_PATTERN_TYPE_MATCH, RESOURCE_PATTERN_TYPE_LITERAL, or RESOURCE_PATTERN_TYPE_PREFIXED.

  • filter.principal string

    The user for whom this ACL applies. With the Kafka simple authorizer, you must include the prefix "User:" with the user name.

  • filter.host string

    The host address to use for this ACL. To allow a principal access from multiple hosts, you must create an ACL for each host.

  • filter.operation string Required

    The operation that is allowed or denied (e.g. READ).

    Values are OPERATION_ANY, OPERATION_ALL, OPERATION_READ, OPERATION_WRITE, OPERATION_CREATE, OPERATION_DELETE, OPERATION_ALTER, OPERATION_DESCRIBE, OPERATION_CLUSTER_ACTION, OPERATION_DESCRIBE_CONFIGS, OPERATION_ALTER_CONFIGS, OPERATION_IDEMPOTENT_WRITE, OPERATION_CREATE_TOKENS, or OPERATION_DESCRIBE_TOKENS.

  • filter.permission_type string Required

    Whether the operation should be allowed or denied.

    Values are PERMISSION_TYPE_ANY, PERMISSION_TYPE_DENY, or PERMISSION_TYPE_ALLOW.

Responses

  • 200 application/json

    OK

    Hide response attribute Show response attribute object
    • matching_acls array[object]
      Hide matching_acls attributes Show matching_acls attributes object
      • error object

        The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

        You can find out more about this error model and how to work with it in the API Design Guide.

        Hide error attributes Show error attributes object
        • code string(int32)

          RPC status code, as described here.

          Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.

        • details array[object]

          A list of messages that carries the error details.

          Details of the error.

          Details of the error.

          One of:
        • message string

          Detailed error message. No compatibility guarantees are given for the text contained in this message.

      • host string

        The host address to use for this ACL.

      • operation string

        The operation that is allowed or denied (e.g. READ).

        Values are OPERATION_ANY, OPERATION_ALL, OPERATION_READ, OPERATION_WRITE, OPERATION_CREATE, OPERATION_DELETE, OPERATION_ALTER, OPERATION_DESCRIBE, OPERATION_CLUSTER_ACTION, OPERATION_DESCRIBE_CONFIGS, OPERATION_ALTER_CONFIGS, OPERATION_IDEMPOTENT_WRITE, OPERATION_CREATE_TOKENS, or OPERATION_DESCRIBE_TOKENS.

      • permission_type string

        Whether the operation should be allowed or denied.

        Values are PERMISSION_TYPE_ANY, PERMISSION_TYPE_DENY, or PERMISSION_TYPE_ALLOW.

      • principal string

        The user for whom this ACL applies.

      • resource_name string

        The name of the resource this ACL targets.

      • resource_pattern_type string

        The pattern to use for matching the specified resource_name (any, exact match, literal, or prefixed).

        Values are RESOURCE_PATTERN_TYPE_ANY, RESOURCE_PATTERN_TYPE_MATCH, RESOURCE_PATTERN_TYPE_LITERAL, or RESOURCE_PATTERN_TYPE_PREFIXED.

      • resource_type string

        The type of resource (topic, consumer group, etc.) this ACL targets.

        Values are RESOURCE_TYPE_ANY, RESOURCE_TYPE_TOPIC, RESOURCE_TYPE_GROUP, RESOURCE_TYPE_CLUSTER, RESOURCE_TYPE_TRANSACTIONAL_ID, RESOURCE_TYPE_DELEGATION_TOKEN, or RESOURCE_TYPE_USER.

  • 401 application/json

    Unauthenticated.

    Hide response attributes Show response attributes object
    • code string(int32)

      RPC status code, as described here.

      Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.

    • details array[object]

      A list of messages that carries the error details.

      Details of the error.

      Details of the error.

      One of:
    • message string

      Detailed error message. No compatibility guarantees are given for the text contained in this message.

  • 500 application/json

    Internal Server Error. Reach out to support.

    Hide response attributes Show response attributes object
    • code string(int32)

      RPC status code, as described here.

      Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.

    • details array[object]

      A list of messages that carries the error details.

      Details of the error.

      Details of the error.

      One of:
    • message string

      Detailed error message. No compatibility guarantees are given for the text contained in this message.

  • default application/json

    An unexpected error response.

    Hide response attributes Show response attributes object
    • code string(int32)

      RPC status code, as described here.

      Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.

    • details array[object]

      A list of messages that carries the error details.

      Details of the error.

      Details of the error.

      One of:
    • message string

      Detailed error message. No compatibility guarantees are given for the text contained in this message.

DELETE /v1/acls
curl \
 --request DELETE 'https://{dataplane_api_subdomain}.cloud.redpanda.com/v1/acls?filter.resource_type=RESOURCE_TYPE_ANY&filter.resource_pattern_type=RESOURCE_PATTERN_TYPE_ANY&filter.operation=OPERATION_ANY&filter.permission_type=PERMISSION_TYPE_ANY' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "matching_acls": [
    {
      "error": {
        "code": "OK",
        "details": [
          {
            "@type": "type.googleapis.com/google.rpc.BadRequest",
            "field_violations": [
              {
                "description": "string",
                "field": "string"
              }
            ]
          }
        ],
        "message": "string"
      },
      "host": "string",
      "operation": "OPERATION_ANY",
      "permission_type": "PERMISSION_TYPE_ANY",
      "principal": "string",
      "resource_name": "string",
      "resource_pattern_type": "RESOURCE_PATTERN_TYPE_ANY",
      "resource_type": "RESOURCE_TYPE_ANY"
    }
  ]
}
Response examples (401)
{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string"
        }
      ]
    }
  ],
  "message": "string"
}
Response examples (500)
{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string"
        }
      ]
    }
  ],
  "message": "string"
}
Response examples (default)
{
  "code": "OK",
  "details": [
    {
      "@type": "type.googleapis.com/google.rpc.BadRequest",
      "field_violations": [
        {
          "description": "string",
          "field": "string"
        }
      ]
    }
  ],
  "message": "string"
}