Secrets

List secrets. Optional: filter based on secret name and labels.

get/v1/secrets

Request

  • Base URL
    https://{dataplane_api_url}
  • Auth
    OAuth 2
    Implicit: https://auth.prd.cloud.redpanda.com/oauth/authorize

Query parameters

filter.name_containsstring

Substring match on secret name. Case-sensitive.

filter.labels[string]string

This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18

filter.scopesstring[]

Secret scopes to search for

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.

page_sizeinteger

Limit the paginated response to a number of items.

Response

OK

next_page_tokenstring

Token to retrieve the next page.

Changes

    • warning

      added the new SCOPE_AI_GATEWAY enum value to the /// response property for the response status

    • info

      added the enum value SCOPE_AI_GATEWAY to the property items/ of the query request parameter filter.scopes

    • warning

      added the new SCOPE_AI_AGENT enum value to the /// response property for the response status

    • warning

      added the new SCOPE_MCP_SERVER enum value to the /// response property for the response status

    • info

      added the enum value SCOPE_AI_AGENT to the property items/ of the query request parameter filter.scopes

    • info

      added the enum value SCOPE_MCP_SERVER to the property items/ of the query request parameter filter.scopes