elasticsearch-js/docs/reference/api/Cat.md

Cat

Constructor

::: new Cat(transport: Transport); :::

Properties

Name	Type	Description
acceptedParams	Record<string, { path: string[]; body: string[]; query: string[]; }>
transport	Transport

Methods

Name	Signature	Description
aliases	aliases(this: [That](./That.md), params?: [CatAliasesRequest](./CatAliasesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatAliasesResponse](./CatAliasesResponse.md)>;	Get aliases. Get the cluster's index aliases, including filter and routing information. This API does not return data stream aliases. IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.