Kafka ACLs & Quotas

get

Fetch Kafka Access Control Lists

Responses

200Success

application/json

400

The request input was invalid

text/plain

401

Authentication error

text/plain

402

The purchased Lenses license does not provide access to this feature

text/plain

403

Authorisation error

text/plain

404

The requested resource cannot be found

text/plain

500

An internal server error has occurred

text/plain

get

GET /api/v1/environments/{name}/proxy/api/acl HTTP/1.1
Host: 
Accept: */*

[
  {
    "resourceType": "text",
    "resourceName": "text",
    "patternType": "text",
    "principal": "text",
    "permissionType": "text",
    "host": "text",
    "operation": "text"
  }
]

put

Create or update a Kafka Access Control List

Body

resourceTypestringRequired

resourceNamestringRequired

patternTypestringOptional

principalstringRequired

permissionTypestringRequired

hoststringRequired

operationstringRequired

Responses

200Success

No content

400

The request input was invalid

text/plain

401

Authentication error

text/plain

402

The purchased Lenses license does not provide access to this feature

text/plain

403

Authorisation error

text/plain

404

The requested resource cannot be found

text/plain

500

An internal server error has occurred

text/plain

put

PUT /api/v1/environments/{name}/proxy/api/acl HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 162

{
  "resourceType": "Topic",
  "resourceName": "trades",
  "patternType": "LITERAL",
  "principal": "User:Alice",
  "permissionType": "Allow",
  "host": "example.com",
  "operation": "Read"
}

No content

delete

Remove a Kafka Access Control List

Body

resourceTypestringRequired

resourceNamestringRequired

patternTypestringOptional

principalstringRequired

permissionTypestringRequired

hoststringRequired

operationstringRequired

Responses

200Success

No content

400

The request input was invalid

text/plain

401

Authentication error

text/plain

402

The purchased Lenses license does not provide access to this feature

text/plain

403

Authorisation error

text/plain

404

The requested resource cannot be found

text/plain

500

An internal server error has occurred

text/plain

delete

DELETE /api/v1/environments/{name}/proxy/api/acl HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 162

{
  "resourceType": "Topic",
  "resourceName": "trades",
  "patternType": "LITERAL",
  "principal": "User:Alice",
  "permissionType": "Allow",
  "host": "example.com",
  "operation": "Read"
}

No content

get

Responses

200Success

application/json

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

get

GET /api/v1/environments/{name}/proxy/api/quotas HTTP/1.1
Host: 
Accept: */*

[
  {
    "entityType": "CLIENT",
    "entityName": "text",
    "child": "text",
    "properties": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "url": "text",
    "isAuthorized": true
  }
]

put

Path parameters

usernamestringRequired

The user to create the quota for

Example: jane

Body

Other propertiesstringOptional

Responses

200Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

put

PUT /api/v1/environments/{name}/proxy/api/quotas/users/{username} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "producer_byte_rate": "100000",
  "consumer_byte_rate": "200000",
  "request_percentage": "75"
}

No content

delete

Path parameters

usernamestringRequired

The user to delete the quota for

Example: jane

Bodystring[]

string[]Optional

Responses

200Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

delete

DELETE /api/v1/environments/{name}/proxy/api/quotas/users/{username} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 64

[
  "producer_byte_rate",
  "consumer_byte_rate",
  "request_percentage"
]

No content

put

Path parameters

client-idstringRequired

The client id to create the quota for

Example: app1

Body

Other propertiesstringOptional

Responses

200Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

put

PUT /api/v1/environments/{name}/proxy/api/quotas/clients/{client-id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "producer_byte_rate": "100000",
  "consumer_byte_rate": "200000",
  "request_percentage": "75"
}

No content

delete

Path parameters

client-idstringRequired

The client id to create the quota for

Example: app1

Bodystring[]

string[]Optional

Responses

200Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

delete

DELETE /api/v1/environments/{name}/proxy/api/quotas/clients/{client-id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 64

[
  "producer_byte_rate",
  "consumer_byte_rate",
  "request_percentage"
]

No content

put

Path parameters

usernamestringRequired

The user to delete the quota for

Example: jane

Body

Other propertiesstringOptional

Responses

200Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

put

PUT /api/v1/environments/{name}/proxy/api/quotas/users/{username}/clients HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "producer_byte_rate": "100000",
  "consumer_byte_rate": "200000",
  "request_percentage": "75"
}

No content

delete

Path parameters

usernamestringRequired

The user to delete the quota for

Example: jane

Bodystring[]

string[]Optional

Responses

200Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

delete

DELETE /api/v1/environments/{name}/proxy/api/quotas/users/{username}/clients HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 64

[
  "producer_byte_rate",
  "consumer_byte_rate",
  "request_percentage"
]

No content

put

Body

Other propertiesstringOptional

Responses

200Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

put

PUT /api/v1/environments/{name}/proxy/api/quotas/users HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "producer_byte_rate": "100000",
  "consumer_byte_rate": "200000",
  "request_percentage": "75"
}

No content

delete

Bodystring[]

string[]Optional

Responses

200Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

delete

DELETE /api/v1/environments/{name}/proxy/api/quotas/users HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 64

[
  "producer_byte_rate",
  "consumer_byte_rate",
  "request_percentage"
]

No content

put

Body

Other propertiesstringOptional

Responses

200Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

put

PUT /api/v1/environments/{name}/proxy/api/quotas/clients HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "producer_byte_rate": "100000",
  "consumer_byte_rate": "200000",
  "request_percentage": "75"
}

No content

delete

Bodystring[]

string[]Optional

Responses

200Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

delete

DELETE /api/v1/environments/{name}/proxy/api/quotas/clients HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 64

[
  "producer_byte_rate",
  "consumer_byte_rate",
  "request_percentage"
]

No content

put

Path parameters

usernamestringRequired

The user to delete the quota for

Example: jane

client-idstringRequired

The client id to create the quota for

Example: app1

Body

Other propertiesstringOptional

Responses

200Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

put

PUT /api/v1/environments/{name}/proxy/api/quotas/users/{username}/clients/{client-id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "producer_byte_rate": "100000",
  "consumer_byte_rate": "200000",
  "request_percentage": "75"
}

No content

delete

Path parameters

usernamestringRequired

The user to delete the quota for

Example: jane

client-idstringRequired

The client id to create the quota for

Example: app1

Bodystring[]

string[]Optional

Responses

200Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

delete

DELETE /api/v1/environments/{name}/proxy/api/quotas/users/{username}/clients/{client-id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 64

[
  "producer_byte_rate",
  "consumer_byte_rate",
  "request_percentage"
]

No content

PreviousExternal Applications NextKafka Consumer Groups

Last updated 4 months ago

Was this helpful?