---
title: "Swarm Nodes hooks"
description: "Hand-written shim. Implementation is generated; see ./swarm-nodes.gen."
section: "Libraries"
group: "React hooks"
order: 452
---

## Hooks

### `useAddSwarmNode` `mutation`

Add a swarm node.

```ts
useAddSwarmNode(options?: MutationOpts<SwarmNode, AddSwarmNodeParams>)
```

**Types:** [SwarmNode](/types/swarm-node) · [AddSwarmNodeParams](/types/add-swarm-node-params)

### `useListSwarmNodes` `query`

List swarm nodes for a swarm version.

```ts
useListSwarmNodes(params?: Omit<ListSwarmNodesParams, | > & { filter?: SwarmNodeFilter; orderBy?: SwarmNodeOrderBy[]; } & SwarmNodeShorthands, options?: QueryOpts<SwarmNode[]>)
```

**Types:** [ListSwarmNodesParams](/types/list-swarm-nodes-params) · [SwarmNodeFilter](/types/swarm-node-filter) · [SwarmNodeOrderBy](/types/swarm-node-order-by) · [SwarmNodeShorthands](/types/swarm-node-shorthands) · [SwarmNode](/types/swarm-node)

### `useRemoveSwarmNode` `mutation`

Delete a swarm node.

```ts
useRemoveSwarmNode(options?: MutationOpts<SuccessResponse, DeleteSwarmNodeParams>)
```

**Types:** [SuccessResponse](/types/success-response) · [DeleteSwarmNodeParams](/types/delete-swarm-node-params)

### `useRetrieveSwarmNode` `query`

Get a swarm node by ID.

```ts
useRetrieveSwarmNode(id: string, options?: QueryOpts<SwarmNode>)
```

**Types:** [SwarmNode](/types/swarm-node)