api-keys

Search and filter API keys

Search API keys with flexible filtering, sorting, and pagination. Supports filtering by username (admin-only), subscription name, status, sorting by multiple fields, and pagination.

post/api/v1/api-keys/search

Request body

Response

OK response.

objectstring required

Object type, always "list"

has_moreboolean required

Whether there are more results beyond this page

subscriptionDetailsobject

Map of subscription name to its details (model names). Populated by the BFF by fetching MaaSSubscription resources for any subscription values found on the returned API keys.

Example response

{
  "object": "list",
  "data": [
    {
      "subscription": "premium-team-sub"
    }
  ],
  "has_more": true
}

Changes

Changed in 4 of the 33 revisions of this API.14

    • added the new optional request property /

      new-optional-request-property

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • endpoint added

      endpoint-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog