curl --request POST \
--url https://api.getcargo.io/v1/workspaceManagement/states \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"gitProvider": "github",
"gitOwner": "<string>",
"gitRepo": "<string>",
"directory": "<string>",
"productionBranch": "<string>",
"contents": {}
}
'import requests
url = "https://api.getcargo.io/v1/workspaceManagement/states"
payload = {
"gitProvider": "github",
"gitOwner": "<string>",
"gitRepo": "<string>",
"directory": "<string>",
"productionBranch": "<string>",
"contents": {}
}
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({
gitProvider: 'github',
gitOwner: '<string>',
gitRepo: '<string>',
directory: '<string>',
productionBranch: '<string>',
contents: {}
})
};
fetch('https://api.getcargo.io/v1/workspaceManagement/states', 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",
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([
'gitProvider' => 'github',
'gitOwner' => '<string>',
'gitRepo' => '<string>',
'directory' => '<string>',
'productionBranch' => '<string>',
'contents' => [
]
]),
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"
payload := strings.NewReader("{\n \"gitProvider\": \"github\",\n \"gitOwner\": \"<string>\",\n \"gitRepo\": \"<string>\",\n \"directory\": \"<string>\",\n \"productionBranch\": \"<string>\",\n \"contents\": {}\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"gitProvider\": \"github\",\n \"gitOwner\": \"<string>\",\n \"gitRepo\": \"<string>\",\n \"directory\": \"<string>\",\n \"productionBranch\": \"<string>\",\n \"contents\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/workspaceManagement/states")
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 \"gitProvider\": \"github\",\n \"gitOwner\": \"<string>\",\n \"gitRepo\": \"<string>\",\n \"directory\": \"<string>\",\n \"productionBranch\": \"<string>\",\n \"contents\": {}\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>"
}Create state
Create a deploy state for a project, with where it lives: its GitHub repository, directory and production branch. The CLI writes the returned uuid into the repo’s cargo.state.json. With a source, the project ends connected in one call: new and managed create its repository from the Cargo template (in your GitHub org, or in Cargo’s managed one), and import connects a repository that already holds a project, writing nothing to it. Refused when the workspace already holds 10 live states, and for a repository in Cargo’s managed org unless managed. (POST /workspaceManagement/states).
curl --request POST \
--url https://api.getcargo.io/v1/workspaceManagement/states \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"gitProvider": "github",
"gitOwner": "<string>",
"gitRepo": "<string>",
"directory": "<string>",
"productionBranch": "<string>",
"contents": {}
}
'import requests
url = "https://api.getcargo.io/v1/workspaceManagement/states"
payload = {
"gitProvider": "github",
"gitOwner": "<string>",
"gitRepo": "<string>",
"directory": "<string>",
"productionBranch": "<string>",
"contents": {}
}
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({
gitProvider: 'github',
gitOwner: '<string>',
gitRepo: '<string>',
directory: '<string>',
productionBranch: '<string>',
contents: {}
})
};
fetch('https://api.getcargo.io/v1/workspaceManagement/states', 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",
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([
'gitProvider' => 'github',
'gitOwner' => '<string>',
'gitRepo' => '<string>',
'directory' => '<string>',
'productionBranch' => '<string>',
'contents' => [
]
]),
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"
payload := strings.NewReader("{\n \"gitProvider\": \"github\",\n \"gitOwner\": \"<string>\",\n \"gitRepo\": \"<string>\",\n \"directory\": \"<string>\",\n \"productionBranch\": \"<string>\",\n \"contents\": {}\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"gitProvider\": \"github\",\n \"gitOwner\": \"<string>\",\n \"gitRepo\": \"<string>\",\n \"directory\": \"<string>\",\n \"productionBranch\": \"<string>\",\n \"contents\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/workspaceManagement/states")
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 \"gitProvider\": \"github\",\n \"gitOwner\": \"<string>\",\n \"gitRepo\": \"<string>\",\n \"directory\": \"<string>\",\n \"productionBranch\": \"<string>\",\n \"contents\": {}\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
- Request body
Request body schema.
Was this page helpful?

