curl --request POST \
--url https://api.getcargo.io/v1/workspaceManagement/states/{uuid}/connection \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"autoDeploy": true,
"runAsUserUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.getcargo.io/v1/workspaceManagement/states/{uuid}/connection"
payload = {
"autoDeploy": True,
"runAsUserUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({autoDeploy: true, runAsUserUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};
fetch('https://api.getcargo.io/v1/workspaceManagement/states/{uuid}/connection', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getcargo.io/v1/workspaceManagement/states/{uuid}/connection",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'autoDeploy' => true,
'runAsUserUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getcargo.io/v1/workspaceManagement/states/{uuid}/connection"
payload := strings.NewReader("{\n \"autoDeploy\": true,\n \"runAsUserUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getcargo.io/v1/workspaceManagement/states/{uuid}/connection")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"autoDeploy\": true,\n \"runAsUserUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/workspaceManagement/states/{uuid}/connection")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"autoDeploy\": true,\n \"runAsUserUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"state": {
"uuid": "<string>",
"workspaceUuid": "<string>",
"gitProvider": "github",
"gitOwner": "<string>",
"gitRepo": "<string>",
"directory": "<string>",
"productionBranch": "<string>",
"isManaged": true,
"connection": {
"autoDeploy": true,
"userUuid": "<string>",
"runAsUserUuid": "<string>",
"gitRepositoryId": "<string>",
"gitAccountId": "<string>",
"createdAt": "<string>"
},
"contents": {},
"previousContents": {},
"meta": {},
"endpoint": {
"url": "<string>",
"triggers": [
{
"type": "native",
"agentSlug": "state",
"config": {}
}
]
},
"contentsVersion": 123,
"lock": {
"holderId": "<string>",
"host": "<string>",
"command": "<string>",
"acquiredAt": "<string>",
"expiresAt": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>"
},
"stateRun": {
"uuid": "<string>",
"workspaceUuid": "<string>",
"stateUuid": "<string>",
"kind": "plan",
"trigger": "pullRequest",
"status": "queued",
"headSha": "<string>",
"branch": "<string>",
"pullRequestNumber": 123,
"summary": {
"create": 123,
"update": 123,
"noop": 123,
"delete": 123,
"resources": [
{
"id": "<string>",
"kind": "<string>",
"slug": "<string>",
"change": "create",
"name": "<string>",
"uuid": "<string>"
}
],
"impact": {
"entries": [
{
"kind": "play",
"id": "<string>",
"name": "<string>",
"records": 123,
"effects": [
{
"effect": "email",
"count": 123
}
],
"credits": 123,
"notes": [
"<string>"
]
}
],
"requiresApproval": true,
"isApproved": true
},
"executions": [
{
"id": "<string>",
"status": "started",
"batchUuid": "<string>",
"runUuid": "<string>"
}
]
},
"errorMessage": "<string>",
"logs": "<string>",
"checkRunId": 123,
"commentId": 123,
"temporalWorkflowId": "<string>",
"startedAt": "<string>",
"finishedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}Connect repository
Connect this project’s repository (the one the state names) to Cargo, so Cargo plans its pull requests and deploys its production branch as a service user. Refused unless the Cargo GitHub app is installed on the repository through an installation linked to this workspace, except in Cargo’s managed org, where the repository is the one Cargo created for this project. Refused when the project has no repository or production branch, when it is already connected, and when that repository directory is connected elsewhere. (POST /workspaceManagement/states//connection).
curl --request POST \
--url https://api.getcargo.io/v1/workspaceManagement/states/{uuid}/connection \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"autoDeploy": true,
"runAsUserUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.getcargo.io/v1/workspaceManagement/states/{uuid}/connection"
payload = {
"autoDeploy": True,
"runAsUserUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({autoDeploy: true, runAsUserUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};
fetch('https://api.getcargo.io/v1/workspaceManagement/states/{uuid}/connection', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getcargo.io/v1/workspaceManagement/states/{uuid}/connection",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'autoDeploy' => true,
'runAsUserUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getcargo.io/v1/workspaceManagement/states/{uuid}/connection"
payload := strings.NewReader("{\n \"autoDeploy\": true,\n \"runAsUserUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getcargo.io/v1/workspaceManagement/states/{uuid}/connection")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"autoDeploy\": true,\n \"runAsUserUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/workspaceManagement/states/{uuid}/connection")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"autoDeploy\": true,\n \"runAsUserUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"state": {
"uuid": "<string>",
"workspaceUuid": "<string>",
"gitProvider": "github",
"gitOwner": "<string>",
"gitRepo": "<string>",
"directory": "<string>",
"productionBranch": "<string>",
"isManaged": true,
"connection": {
"autoDeploy": true,
"userUuid": "<string>",
"runAsUserUuid": "<string>",
"gitRepositoryId": "<string>",
"gitAccountId": "<string>",
"createdAt": "<string>"
},
"contents": {},
"previousContents": {},
"meta": {},
"endpoint": {
"url": "<string>",
"triggers": [
{
"type": "native",
"agentSlug": "state",
"config": {}
}
]
},
"contentsVersion": 123,
"lock": {
"holderId": "<string>",
"host": "<string>",
"command": "<string>",
"acquiredAt": "<string>",
"expiresAt": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>"
},
"stateRun": {
"uuid": "<string>",
"workspaceUuid": "<string>",
"stateUuid": "<string>",
"kind": "plan",
"trigger": "pullRequest",
"status": "queued",
"headSha": "<string>",
"branch": "<string>",
"pullRequestNumber": 123,
"summary": {
"create": 123,
"update": 123,
"noop": 123,
"delete": 123,
"resources": [
{
"id": "<string>",
"kind": "<string>",
"slug": "<string>",
"change": "create",
"name": "<string>",
"uuid": "<string>"
}
],
"impact": {
"entries": [
{
"kind": "play",
"id": "<string>",
"name": "<string>",
"records": 123,
"effects": [
{
"effect": "email",
"count": 123
}
],
"credits": 123,
"notes": [
"<string>"
]
}
],
"requiresApproval": true,
"isApproved": true
},
"executions": [
{
"id": "<string>",
"status": "started",
"batchUuid": "<string>",
"runUuid": "<string>"
}
]
},
"errorMessage": "<string>",
"logs": "<string>",
"checkRunId": 123,
"commentId": 123,
"temporalWorkflowId": "<string>",
"startedAt": "<string>",
"finishedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}Authorizations
Scopes
Headers
Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.
255"8e03978e-40d5-43e8-bc93-6894a57f9324"
Body
Request body schema.
Service user a deploy runs as, whose permissions must be covered by the caller's. Each deploy gets a temporary CARGO_API_TOKEN for that user. Without one, a service user is created for this repository with the caller's permissions.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Was this page helpful?

