POST

Try POST /repos/{owner}/{repo}/pages/deployments — GitHub API

GitHub playground

Create a GitHub Pages deployment

Credentials

GitHub token · sent as Authorization

Kept in this tab only. Requests go through apicheats.dev's same-origin proxy straight to api.github.com; the proxy stores and logs nothing about them.

Headers

Accept · fixedX-GitHub-Api-Version · fixed

Path

owner · required · string The account owner of the repository. The name is not case sensitive. repo · required · string The name of the repository without the `.git` extension. The name is not case sensitive.

Body application/json

5 body fields

artifact_id · optional · number — The ID of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required.
artifact_url · optional · string — The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required.
environment · optional · string — The target environment for this GitHub Pages deployment.
pages_build_version · required · string — A unique string that represents the version of the build for this deployment.
oidc_token · required · string — The OIDC token issued by GitHub Actions certifying the origin of the deployment.