title | linkTitle | description |
---|---|---|
Add |
Add |
Learn how to create a deployment.
|
POST /api/v1/deployments/:org/:repo
The following parameters are used to configure the endpoint:
Name | Description |
---|---|
org |
name of organization |
repo |
name of repository |
COMING SOON!
Status Code | Description |
---|---|
200 |
indicates the request has succeeded |
401 |
indicates the user does not have proper permissions |
{{% alert color="warning" %}} This section assumes you already know how to authenticate to the API.
To authenticate to the API, please review the authentication documentation. {{% /alert %}}
{
"ref": "main",
"target": "production"
}
curl \
-X POST \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "@data.json" \
"http://127.0.0.1:8080/api/v1/deployments/github/octocat"
{
"id": 1,
"repo_id": 1,
"url": "https://api.github.com/repos/github/octocat/deployments/1",
"user": "octocat",
"commit": "48afb5bdc41ad69bf22588491333f7cf71135163",
"ref": "main",
"task": "deploy:vela",
"target": "production",
"description": "Deployment request from Vela"
}