---
title: "Deploy a Pen"
method: PUT
path: "/v2/pens/{id}/deployment"
tags: ["Deployments"]
---

# Deploy a Pen

`PUT /v2/pens/{id}/deployment`

## Request

- Base URL: `https://api.codepen.io`
- URL: `https://api.codepen.io/v2/pens/{id}/deployment`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Deploys a saved version, the saved head unless `version_id` says otherwise, and answers the deployment.

## Request body

- DeployRequest
  - `version_id` string: The version to deploy; the saved head when omitted.

## Response `200`

The deployment.

- Deployment
  - `created_at` string, date-time, required
  - `custom_domains` string[], required
  - `id` string, required
  - `updated_at` string, date-time, required
  - `url` string, uri, required
  - `version_id` string, required

## Other responses

- `400`: `BAD_USER_INPUT`: an invalid parameter, body, path, setting, access level or role. `field` names the argument when known, and `details` carries structured detail (the misses of `PATCH /v2/pens/{id}/files`).
- `401`: `UNAUTHENTICATED`: a missing or invalid key, a deleted owner, or a Team key for a Team that is not PRO.
- `403`: `FORBIDDEN`: a write to a Pen made in the classic editor, or a plan limit (non-Public access, a Private Collection, file size, storage, collaborators). The message names the limit and, when a bigger plan would lift it, where to upgrade.
- `404`: `NOT_FOUND`: no such item, or one that is not the key owner's, public or not. A path that is not an endpoint at all answers `404` with the v1 body `{ "error": "not found" }` instead.
- `429`: `RATE_LIMITED`: the owner exceeded the plan's requests in an hour, its reads today, or today's allowance of Pen or Collection creates. No `Retry-After` or rate-limit headers are sent; the body carries `retry_after_seconds`, `limit` and `reset_at`.
- `500`: `INTERNAL`: unexpected, and reported; the message is generic.

---

[API](https://skmtc.dev/codepen/apis/codepen-api.md) - [All operations](https://skmtc.dev/codepen/apis/codepen-api/llms.txt) - [OpenAPI document](https://skmtc.dev/codepen/apis/codepen-api/revisions/108fe91e3ef5?raw)