Create a Branch Deployment

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/656/deployments/" \
  -X POST \
  -H "Authorization: YOUR_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"branch_id\":1,\"release_uuids\":[\"1234-4567\",\"1234-4568\"]}"

JS client

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

PHP client

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

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

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

Java

HttpResponse<String> response = Unirest.post("https://mapi.storyblok.com/v1/spaces/656/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/656/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/656/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/656/deployments/', payload)

Swift

import Foundation

let headers = [
  "Content-Type": "application/json",
  "Authorization": "YOUR_OAUTH_TOKEN"
]

let postData = NSData(data: {"branch_id":1,"release_uuids":["1234-4567","1234-4568"]}.data(using: String.Encoding.utf8)!)

let request = NSMutableURLRequest(url: NSURL(string: "https://mapi.storyblok.com/v1/spaces/656/deployments/")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0)
request.method = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()