Create a Branch Deployment

POST

https://mapi.storyblok.com/v1/spaces/:space_id/deployments

Path parameters

• :space_id required number

  Numeric ID of a space

Request body properties

• branch_id required number

  The branch ID to deploy

• release_uuids string[]

  An array of release UUIDs

Examples

cURL

curl "https://mapi.storyblok.com/v1/spaces/288868932106293/deployments/" \
  -X POST \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"branch_id\":1,\"release_uuids\":[\"1234-4567\",\"1234-4568\"]}"

JS

// Using the Universal JavaScript Client:
// https://github.com/storyblok/storyblok-js-client
Storyblok.post('spaces/288868932106293/deployments/', {
  "branch_id": 1,
  "release_uuids": [
    "1234-4567",
    "1234-4568"
  ]
})
  .then(response => {
    console.log(response)
  }).catch(error => {
    console.log(error)
  })

PHP

$client = new \Storyblok\ManagementClient('YOUR_OAUTH_TOKEN');

$payload = ["branch_id" => 1,"release_uuids" => ["1234-4567","1234-4568"]];

$client->post('spaces/288868932106293/deployments/', $payload)->getBody();

Java

HttpResponse<String> response = Unirest.post("https://mapi.storyblok.com/v1/spaces/288868932106293/deployments/")
  .header("Content-Type", "application/json")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .body({"branch_id":1,"release_uuids":["1234-4567","1234-4568"]})
  .asString();

C#

var client = new RestClient("https://mapi.storyblok.com/v1/spaces/288868932106293/deployments/");
var request = new RestRequest(Method.POST);

request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
request.AddParameter("application/json", "{\"branch_id\":1,\"release_uuids\":[\"1234-4567\",\"1234-4568\"]}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Python

import requests

url = "https://mapi.storyblok.com/v1/spaces/288868932106293/deployments/"

querystring = {}

payload = {"branch_id":1,"release_uuids":["1234-4567","1234-4568"]}
headers = {
  'Content-Type': "application/json",
  'Authorization': "YOUR_OAUTH_TOKEN"
}

response = requests.request("POST", url, data=payload, headers=headers, params=querystring)

print(response.text)

Ruby

require 'storyblok'
client = Storyblok::Client.new(oauth_token: 'YOUR_OAUTH_TOKEN')

payload = {"branch_id" => 1,"release_uuids" => ["1234-4567","1234-4568"]}

client.post('spaces/288868932106293/deployments/', payload)

Swift

var request = URLRequest(url: URL(string: "https://mapi.storyblok.com/v1/spaces/288868932106293/deployments/")!)
request.setValue("YOUR_OAUTH_TOKEN", forHTTPHeaderField: "Authorization")
request.httpMethod = "POST"
request.httpBody = try JSONSerialization.data(withJSONObject: [
    "branch_id": 1,
    "release_uuids": [
        "1234-4567",
        "1234-4568",
    ],
])
let (data, _) = try await URLSession.shared.data(for: request)
print(try JSONSerialization.jsonObject(with: data))

Kotlin

val client = HttpClient {
    install(ContentNegotiation) { json() }
    install(DefaultRequest) {
        url {
            takeFrom("https://mapi.storyblok.com/v1/")
            headers.append("Authorization", "YOUR_OAUTH_TOKEN")
        }
    }
}

val response = client.post("spaces/288868932106293/deployments/") {
    contentType(ContentType.Application.Json)
    setBody(buildJsonObject {
        put("branch_id", 1)
        putJsonArray("release_uuids") {
            add("1234-4567")
            add("1234-4568")
        }
    })
}

println(response.body<JsonElement>())