> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# AdminRemoveRanksRequest

> AdminRemoveRanksRequest — Kinetica Node.js API

interface AdminRemoveRanksRequest \{\
&#x20;[options](#options)?: Record\<string, string>;\
&#x20;[ranks](#ranks): string\[];\
}

<ul>
  <li>Defined in [src/types.ts:218](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L218)</li>
</ul>

##### Index

### Properties

[options?](#options) [ranks](#ranks)&#x20;

## Properties

### `Optional`options

options?: Record\<string, string>

Optional parameters.

<ul>
  <li>Defined in [src/types.ts:222](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L222)</li>
</ul>

### ranks

ranks: string\[]

Each array value designates one or more ranks to remove from the cluster. Values can be formatted as 'rankN' for a specific rank, 'hostN' (from the gpudb.conf file) to remove all ranks on that host, or the host IP address (hostN.address from the gpub.conf file) which also removes all ranks on that host. Rank 0 (the head rank) cannot be removed (but can be moved to another host using `admin_switchover`). At least one worker rank must be left in the cluster after the operation.

<ul>
  <li>Defined in [src/types.ts:220](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L220)</li>
</ul>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.