---
title: "Endpoints hooks"
description: "Hand-written shim. Implementation is generated; see ./endpoints.gen."
section: "Libraries"
group: "React hooks"
order: 417
---

## Hooks

### `useCreateEndpoint` `mutation`

Create an endpoint.

```ts
useCreateEndpoint(options?: MutationOpts<Endpoint, CreateEndpointParams>)
```

**Types:** [Endpoint](/types/endpoint) · [CreateEndpointParams](/types/create-endpoint-params)

### `useDeleteEndpoint` `mutation`

Soft-delete an endpoint.

```ts
useDeleteEndpoint(options?: MutationOpts<SuccessResponse, string>)
```

**Types:** [SuccessResponse](/types/success-response)

### `useListEndpoints` `query`

List endpoints.

```ts
useListEndpoints(params?: Omit<ListEndpointsParams, | > & { filter?: EndpointFilter; orderBy?: EndpointOrderBy[]; } & EndpointShorthands, options?: QueryOpts<Page<Endpoint>>)
```

**Types:** [ListEndpointsParams](/types/list-endpoints-params) · [EndpointFilter](/types/endpoint-filter) · [EndpointOrderBy](/types/endpoint-order-by) · [EndpointShorthands](/types/endpoint-shorthands) · [Page](/types/page) · [Endpoint](/types/endpoint)

### `usePurgeEndpoint` `composite`

Permanently delete a soft-deleted endpoint.

```ts
usePurgeEndpoint(options?: MutationOpts<SuccessResponse, PurgeEndpointParams>)
```

**Types:** [SuccessResponse](/types/success-response) · [PurgeEndpointParams](/types/purge-endpoint-params)

### `useRestoreEndpoint` `composite`

Restore a soft-deleted endpoint.

```ts
useRestoreEndpoint(options?: MutationOpts<Endpoint, string>)
```

**Types:** [Endpoint](/types/endpoint)

### `useRetrieveEndpoint` `query`

Get an endpoint by ID.

```ts
useRetrieveEndpoint(id: string, options?: QueryOpts<Endpoint>)
```

**Types:** [Endpoint](/types/endpoint)

### `useUpdateEndpoint` `mutation`

Update an endpoint.

```ts
useUpdateEndpoint(options?: MutationOpts<Endpoint, UpdateEndpointParams>)
```

**Types:** [Endpoint](/types/endpoint) · [UpdateEndpointParams](/types/update-endpoint-params)