POST /repos/{owner}/{repo}/pages/deployments
Create a GitHub Pages deployment for a repository.
The authenticated user must have write permission to the repository.
Servers
- https://api.github.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
repo |
String | Yes |
The name of the repository without the |
owner |
String | Yes |
The account owner of the repository. The name is not case sensitive. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
oidc_token |
String | Yes |
The OIDC token issued by GitHub Actions certifying the origin of the deployment. |
artifact_url |
String | No |
The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either |
pages_build_version |
String | Yes |
A unique string that represents the version of the build for this deployment. Default value: "GITHUB_SHA" |
artifact_id |
Number | No |
The ID of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either |
environment |
String | No |
The target environment for this GitHub Pages deployment. Default value: "github-pages" |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.