Operations

List operations

List operations. This is a generic endpoint and can be used to list any type of operation.

get/v1/operations

Request

  • Base URL: https://api.redpanda.com
  • URL: https://api.redpanda.com/v1/operations
  • Auth: OAuth 2 (implicit, authorization URL https://auth.prd.cloud.redpanda.com/oauth/authorize)

Query parameters

filter.type_instring[]
filter.state'STATE_IN_PROGRESS' | 'STATE_COMPLETED' | 'STATE_FAILED'
filter.resource_idstring
page_sizeinteger

Limit the number of operations returned per page, the page is capped to 100 operations.

page_tokenstring

Value of the next_page_token field returned by the previous response. If not provided, the system assumes the first page is requested.

read_maskstring

Response

OK

next_page_tokenstring

Page Token to fetch the next page. The value can be used as next_page_token in the next call to this endpoint. since the pagination is cursor based the last page will be encountered when the next page token is not set and the operations list is empty.

Changes

No recorded changes to this operation across all 1 revision of this API.