Approvals

List approval requests

get

Returns a list of approval requests

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Query parameters

pageintegerOptional

The page number to be returned, must be greater than zero. Defaults to 1.

Example: 1

pageSizeintegerRequired

The elements amount on a single page, must be greater than zero.

Example: 25

sortFieldstring · enumOptional

The field to sort results by

Possible values:

sortOrderstring · enumOptional

Sorting order. Defaults to ascending

Possible values:

entityNamestringOptional

filter request by matching entity names

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

/api/v1/environments/{environment}/proxy/api/v1/approvals

HTTPcURLJavaScriptPython

GET /api/v1/environments/{environment}/proxy/api/v1/approvals?pageSize=1 HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
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-12-29T11:39:53.816Z",
      "createdBy": "text",
      "approvalStatus": "Approved",
      "rejectionReason": "text",
      "failureReason": "text",
      "reviewedBy": "text",
      "reviewedAt": "2025-12-29T11:39:53.816Z",
      "defaultTopicConfig": {
        "ANY_ADDITIONAL_PROPERTY": {
          "default": "text",
          "serverDefaultProperties": "text",
          "description": "text"
        }
      }
    }
  ],
  "pagesAmount": 1,
  "totalCount": 1
}

Create a new approval request

post

Creates a new approval request

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Body

application/json

or

or

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

post

/api/v1/environments/{environment}/proxy/api/v1/approvals

HTTPcURLJavaScriptPython

POST /api/v1/environments/{environment}/proxy/api/v1/approvals HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
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"
}

Get approval request details

get

Returns the approval request details

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

idstring · uuidRequired

The request id

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

/api/v1/environments/{environment}/proxy/api/v1/approvals/{id}

HTTPcURLJavaScriptPython

GET /api/v1/environments/{environment}/proxy/api/v1/approvals/{id} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
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-12-29T11:39:53.816Z",
  "createdBy": "text",
  "approvalStatus": "Approved",
  "rejectionReason": "text",
  "failureReason": "text",
  "reviewedBy": "text",
  "reviewedAt": "2025-12-29T11:39:53.816Z",
  "defaultTopicConfig": {
    "ANY_ADDITIONAL_PROPERTY": {
      "default": "text",
      "serverDefaultProperties": "text",
      "description": "text"
    }
  }
}

Approve a request

put

Approves the request

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

idstring · uuidRequired

Responses

204Success

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

/api/v1/environments/{environment}/proxy/api/v1/approvals/{id}/approve

HTTPcURLJavaScriptPython

PUT /api/v1/environments/{environment}/proxy/api/v1/approvals/{id}/approve HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Reject an approval request

put

Rejects the approval request

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

idstring · uuidRequired

Body

application/json

rejectionReasonstringOptional

Responses

204Success

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

/api/v1/environments/{environment}/proxy/api/v1/approvals/{id}/reject

HTTPcURLJavaScriptPython

PUT /api/v1/environments/{environment}/proxy/api/v1/approvals/{id}/reject HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "rejectionReason": "text"
}

No content