Sign in

v1

latestOpenAPI 3.0.02026-07-1329122146.2 KB
AdminService

Lists the API keys and the associated corpora names and IDs.

Some tips for this API:

  • This operation works with the Personal API Key and OAuth 2.0 (in a JWT "Bearer Token") authentication. You can find details of how to set up and use OAuth 2.0 here.
  • The filter feature applies to either the name or the description of a corpus.
post/v1/list-api-keys

Headers

customer-idinteger required

Enter the Customer ID to use for the request.

timeoutstring

(Optional) Enter the timeout value of the request in seconds, such as 10S or 30S.

Request body

numResultsinteger

Max results to return.

pageKeystring byte

A key that is passed to retrieve a specific page of results. Leave empty to retrieve first page. Subsequent page requests should use the page key returned in previous response, and all other fields are ignored.

apiKeyTypeAdminApiKeyType[]

[Optional] Get API keys of these types. Default: If not set, API_KEY_TYPE__SERVING and API_KEY_TYPE__SERVING_INDEXING are returned.

readCorporaInfoboolean

If set, returns corpus name & id associated with api keys.

Response

A successful response.

pageKeystring byte

A key that is passed into a subsequent result in order to retrieve the next page of results.