Add
Learn how to create a deployment.
Endpoint
POST /api/v1/deployments/:org/:repo
Parameters
The following parameters are used to configure the endpoint:
| Name | Description |
|---|---|
org | name of organization |
repo | name of repository |
Permissions
COMING SOON!
Responses
| Status Code | Description |
|---|---|
200 | indicates the request has succeeded |
401 | indicates the user does not have proper permissions |
Sample
This section assumes you already know how to authenticate to the API.
To authenticate to the API, please review the authentication documentation.
File
{
"ref": "main",
"target": "production"
}
Request
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"
Response
{
"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"
}
File with Parameters
If you would like to pass parameters, which can be referenced in the pipeline as $DEPLOYMENT_PARAMETER_<KEY>, include them as a map inside the payload tag.
{
"ref": "main",
"target": "production",
"payload": {
"FIRST_EXAMPLE": "hello",
"SECOND_EXAMPLE": "goodbye"
}
}
Request with Parameters
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"
Response with Parameters
{
"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",
"payload": {
"EXAMPLE": "hello",
"SECOND_EXAMPLE": "goodbye"
}
}
Last modified September 7, 2023: chore(api/deploy): specify how parameters are passed into body (#377) (32cb5b03)