# Client API: App Deployment

> The starters a deployment can begin from, and the dashboard link a Deploy button opens for a public repository.

Source: https://www.coritan.com/docs/api/reference/client/app-deployment/

The starters a deployment can begin from, and the dashboard link a Deploy button opens for a public repository. Needs no auth.

Base URL: `https://api.coritan.com/api/v1`. Paths below are complete.

To try these requests in the browser, open the [interactive Client API reference](https://api.coritan.com/docs).

## Operations

| Method | Path | Summary |
| --- | --- | --- |
| GET | [`/api/v1/deploy-button`](#op-get-api-v1-deploy-button) | Deploy button |
| GET | [`/api/v1/deploy-presets`](#op-get-api-v1-deploy-presets) | Deploy presets |
| GET | [`/api/v1/deploy-templates`](#op-get-api-v1-deploy-templates) | List deploy templates |
| GET | [`/api/v1/deploy-templates/{slug}`](#op-get-api-v1-deploy-templates-slug) | Get deploy template |

### Deploy button {#op-get-api-v1-deploy-button}

`GET /api/v1/deploy-button`

The link a Deploy button opens for a public repository: ``path`` on
the dashboard, ``url`` on the platform storefront (null when none is
configured), and the repository as the order will read it.

#### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `repo` | query | string | yes | The repository's https address |
| `branch` | query | string or null | no | The branch to deploy; main when left out |
| `root` | query | string or null | no | The app's directory in the repository |

#### Responses

| Status | Meaning |
| --- | --- |
| `200` | Success. |
| `422` | The request is not valid. `detail` lists each problem. |

### Deploy presets {#op-get-api-v1-deploy-presets}

`GET /api/v1/deploy-presets`

#### Responses

| Status | Meaning |
| --- | --- |
| `200` | Success. |

### List deploy templates {#op-get-api-v1-deploy-templates}

`GET /api/v1/deploy-templates`

Every starter whose repository is known: its repository, build and
runtime settings, the variables it reads, the Deploy button's link
(``deploy_path``, and ``deploy_url`` on the platform storefront) and the
part of an order's ``config`` it decides (``order``).

#### Responses

| Status | Meaning |
| --- | --- |
| `200` | Success. |

### Get deploy template {#op-get-api-v1-deploy-templates-slug}

`GET /api/v1/deploy-templates/{slug}`

One starter, as the list answers it; 404 for a name the gallery does
not offer, or a starter whose repository is not set on this platform.

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `slug` | path | string | yes |

#### Responses

| Status | Meaning |
| --- | --- |
| `200` | Success. |
| `422` | The request is not valid. `detail` lists each problem. |