---
title: "Deploys hooks"
description: "Hand-written shim. Generated list+get via ./deploys.gen.
useCancelDeploy stays hand-written."
section: "Libraries"
group: "React hooks"
order: 412
---

## Hooks

### `useCancelDeploy` `composite`

```ts
useCancelDeploy(options?: MutationOpts<SuccessResponse, CancelDeployParams>)
```

**Types:** [SuccessResponse](/types/success-response) · [CancelDeployParams](/types/cancel-deploy-params)

### `useCreateDeploy` `mutation`

Trigger a deploy.

```ts
useCreateDeploy(options?: MutationOpts<Deploy, CreateDeployParams>)
```

**Types:** [Deploy](/types/deploy) · [CreateDeployParams](/types/create-deploy-params)

### `useListDeploys` `query`

List deploys.

```ts
useListDeploys(params?: Omit<ListDeploysParams, | > & { filter?: DeployFilter; orderBy?: DeployOrderBy[]; } & DeployShorthands, options?: QueryOpts<Page<Deploy>>)
```

**Types:** [ListDeploysParams](/types/list-deploys-params) · [DeployFilter](/types/deploy-filter) · [DeployOrderBy](/types/deploy-order-by) · [DeployShorthands](/types/deploy-shorthands) · [Page](/types/page) · [Deploy](/types/deploy)

### `useRetrieveDeploy` `query`

Get a deploy by ID, including its step list.

```ts
useRetrieveDeploy(id: string, options?: QueryOpts<DeployWithSteps>)
```

**Types:** [DeployWithSteps](/types/deploy-with-steps)