---
title: "SDK: deploy"
description: "The deploy methods of the Overlane TypeScript SDK, with their signatures. Generated from the SDK types."
---

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

# SDK: deploy

{/* Generated by apps/docs/scripts/generate.mjs (SDK pages from the TypeScript types in packages/sdk). Do not edit; run `pnpm --filter @overlane/docs gen`. */}

The `deploy` area has 13 methods on the client. Each takes one object of path, query and body arguments and an optional `CallOptions`, and returns a promise of the response body. A refused call rejects with `OverlaneApiError` (see the [SDK index](/sdk/)).

## deployEnvironmentsCreate

Create a deploy environment (policy class)

- Request: `POST` on `/v1/tenants/{tenantId}/projects/{projectId}/deploy/environments`
- Needs an approval for agents: class `policy_change`

```ts
deployEnvironmentsCreate(args: { tenantId: string; projectId: string; body: CreateEnvironmentRequest }, options?: CallOptions): Promise<EnvironmentResponse>
```

## deployEnvironmentsList

List deploy environments

- Request: `GET` on `/v1/tenants/{tenantId}/projects/{projectId}/deploy/environments`

```ts
deployEnvironmentsList(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<Record<string, unknown>>
```

## deployEnvironmentsRollback

Roll an environment back to its previous release

- Request: `POST` on `/v1/tenants/{tenantId}/projects/{projectId}/deploy/environments/{environmentId}/rollback`

```ts
deployEnvironmentsRollback(args: { tenantId: string; projectId: string; environmentId: string; body: RollbackRequest }, options?: CallOptions): Promise<RollbackResponse>
```

## deployEnvironmentsSecret

Set an environment secret (secrets class)

- Request: `PUT` on `/v1/tenants/{tenantId}/projects/{projectId}/deploy/environments/{environmentId}/secrets`
- Needs an approval for agents: class `secrets`

```ts
deployEnvironmentsSecret(args: { tenantId: string; projectId: string; environmentId: string; body: SetEnvironmentSecretRequest }, options?: CallOptions): Promise<Record<string, unknown>>
```

## deployEnvironmentsSecretDelete

Delete an environment secret (secrets class)

- Request: `DELETE` on `/v1/tenants/{tenantId}/projects/{projectId}/deploy/environments/{environmentId}/secrets/{name}`
- Needs an approval for agents: class `secrets`

```ts
deployEnvironmentsSecretDelete(args: { tenantId: string; projectId: string; environmentId: string; name: string }, options?: CallOptions): Promise<DeleteEnvironmentSecretResponse>
```

## deployPreviewsCreate

Deploy a branch preview

- Request: `POST` on `/v1/tenants/{tenantId}/projects/{projectId}/deploy/previews`

```ts
deployPreviewsCreate(args: { tenantId: string; projectId: string; body: PreviewRequest }, options?: CallOptions): Promise<DeployResponse>
```

## deployProvidersList

List the deploy services this project can use, whether each is available, and prices for hosting on Overlane

- Request: `GET` on `/v1/tenants/{tenantId}/projects/{projectId}/deploy/providers`

```ts
deployProvidersList(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<ProviderListResponse>
```

## deployReleasesCreate

Deploy a built artifact to an environment

- Request: `POST` on `/v1/tenants/{tenantId}/projects/{projectId}/deploy/releases`

```ts
deployReleasesCreate(args: { tenantId: string; projectId: string; body: DeployRequest }, options?: CallOptions): Promise<DeployResponse>
```

## deployReleasesList

List deploys

- Request: `GET` on `/v1/tenants/{tenantId}/projects/{projectId}/deploy/releases`

```ts
deployReleasesList(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<ReleaseListResponse>
```

## deployTargetsCreate

Add a deploy target (secrets class). The provider token is write-only; a target hosted on Overlane takes none

- Request: `POST` on `/v1/tenants/{tenantId}/projects/{projectId}/deploy/targets`
- Needs an approval for agents: class `secrets`

```ts
deployTargetsCreate(args: { tenantId: string; projectId: string; body: CreateTargetRequest }, options?: CallOptions): Promise<TargetResponse>
```

## deployTargetsDelete

Remove a deploy target and its stored token (deletion class). Refused with target_in_use while an environment deploys to it

- Request: `DELETE` on `/v1/tenants/{tenantId}/projects/{projectId}/deploy/targets/{target}`
- Needs an approval for agents: class `deletion`

```ts
deployTargetsDelete(args: { tenantId: string; projectId: string; target: string }, options?: CallOptions): Promise<DeleteTargetResponse>
```

## deployTargetsList

List deploy targets

- Request: `GET` on `/v1/tenants/{tenantId}/projects/{projectId}/deploy/targets`

```ts
deployTargetsList(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<TargetListResponse>
```

## deployTargetsUpdate

Rename a deploy target, change its settings or replace its provider token (secrets class). The kind never changes; the token is write-only

- Request: `PATCH` on `/v1/tenants/{tenantId}/projects/{projectId}/deploy/targets/{target}`
- Needs an approval for agents: class `secrets`

```ts
deployTargetsUpdate(args: { tenantId: string; projectId: string; target: string; body: UpdateTargetRequest }, options?: CallOptions): Promise<TargetResponse>
```

Source: https://docs.overlane.app/sdk/deploy/index.mdx