Approvals
Returns a list of approval requests
The page number to be returned, must be greater than zero. Defaults to 1.
1The elements amount on a single page, must be greater than zero.
25The field to sort results by
Sorting order. Defaults to ascending
filter request by matching entity names
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
GET /api/v1/environments/{environment}/proxy/api/v1/approvals?pageSize=1 HTTP/1.1
Host:
Accept: */*
{
"values": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"entityName": "text",
"type": "Create",
"entityType": "KafkaTopic",
"settings": {
"replication": 1,
"partitions": 1,
"topicConfig": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"capacity": {
"recordsSize": 1,
"dataProducedPerDay": 1,
"consumers": 1
}
},
"metadata": {
"reason": "text",
"tags": [
"text"
]
},
"createdAt": "2025-10-24T16:21:34.157Z",
"createdBy": "text",
"approvalStatus": "Approved",
"rejectionReason": "text",
"failureReason": "text",
"reviewedBy": "text",
"reviewedAt": "2025-10-24T16:21:34.157Z",
"defaultTopicConfig": {
"ANY_ADDITIONAL_PROPERTY": {
"default": "text",
"serverDefaultProperties": "text",
"description": "text"
}
}
}
],
"pagesAmount": 1,
"totalCount": 1
}Creates a new approval request
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
POST /api/v1/environments/{environment}/proxy/api/v1/approvals HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 321
{
"entityName": "topic-invoices",
"entityType": "KafkaTopic",
"settings": {
"replication": 2,
"partitions": 5,
"topicConfig": {
"delete.retention.ms": "30000"
},
"capacity": {
"recordsSize": 15
}
},
"metadata": {
"reason": "A topic to store invoice records produced by our billing app Foo",
"tags": [
"billing",
"invoices"
]
},
"type": "CreateNewEntity"
}{
"id": "123e4567-e89b-12d3-a456-426614174000"
}Returns the approval request details
The request id
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
GET /api/v1/environments/{environment}/proxy/api/v1/approvals/{id} HTTP/1.1
Host:
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"entityName": "text",
"type": "Create",
"entityType": "KafkaTopic",
"settings": {
"replication": 1,
"partitions": 1,
"topicConfig": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"capacity": {
"recordsSize": 1,
"dataProducedPerDay": 1,
"consumers": 1
}
},
"metadata": {
"reason": "text",
"tags": [
"text"
]
},
"createdAt": "2025-10-24T16:21:34.157Z",
"createdBy": "text",
"approvalStatus": "Approved",
"rejectionReason": "text",
"failureReason": "text",
"reviewedBy": "text",
"reviewedAt": "2025-10-24T16:21:34.157Z",
"defaultTopicConfig": {
"ANY_ADDITIONAL_PROPERTY": {
"default": "text",
"serverDefaultProperties": "text",
"description": "text"
}
}
}Approves the request
No content
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
PUT /api/v1/environments/{environment}/proxy/api/v1/approvals/{id}/approve HTTP/1.1
Host:
Accept: */*
No content
Rejects the approval request
No content
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
PUT /api/v1/environments/{environment}/proxy/api/v1/approvals/{id}/reject HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"rejectionReason": "text"
}No content
Last updated
Was this helpful?