Begin trail

Add a Trail to a Flow.

PUT /trails/{org}/{flow_name}

Begin trail

cURL

curl --request PUT \
  --url https://app.kosli.com/api/v2/trails/{org}/{flow_name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'data_json={
  "name": "<string>",
  "description": "<string>",
  "git_commit_info": {
    "sha1": "<string>",
    "message": "<string>",
    "author": "<string>",
    "author_username": "<string>",
    "branch": "<string>",
    "timestamp": 123,
    "url": "<string>",
    "parents": [
      "<string>"
    ],
    "verified": true,
    "signature_state": "<string>"
  },
  "repo_info": {
    "name": "<string>",
    "url": "<string>",
    "id": "<string>",
    "description": "<string>"
  },
  "origin_url": "<string>",
  "external_urls": {},
  "user_data": {}
}' \
  --form 'template_file=<string>'

import requests

url = "https://app.kosli.com/api/v2/trails/{org}/{flow_name}"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data_json\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"description\": \"<string>\",\r\n  \"git_commit_info\": {\r\n    \"sha1\": \"<string>\",\r\n    \"message\": \"<string>\",\r\n    \"author\": \"<string>\",\r\n    \"author_username\": \"<string>\",\r\n    \"branch\": \"<string>\",\r\n    \"timestamp\": 123,\r\n    \"url\": \"<string>\",\r\n    \"parents\": [\r\n      \"<string>\"\r\n    ],\r\n    \"verified\": true,\r\n    \"signature_state\": \"<string>\"\r\n  },\r\n  \"repo_info\": {\r\n    \"name\": \"<string>\",\r\n    \"url\": \"<string>\",\r\n    \"id\": \"<string>\",\r\n    \"description\": \"<string>\"\r\n  },\r\n  \"origin_url\": \"<string>\",\r\n  \"external_urls\": {},\r\n  \"user_data\": {}\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template_file\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "multipart/form-data"
}

response = requests.put(url, data=payload, headers=headers)

print(response.text)

const form = new FormData();
form.append('data_json', '{
  "name": "<string>",
  "description": "<string>",
  "git_commit_info": {
    "sha1": "<string>",
    "message": "<string>",
    "author": "<string>",
    "author_username": "<string>",
    "branch": "<string>",
    "timestamp": 123,
    "url": "<string>",
    "parents": [
      "<string>"
    ],
    "verified": true,
    "signature_state": "<string>"
  },
  "repo_info": {
    "name": "<string>",
    "url": "<string>",
    "id": "<string>",
    "description": "<string>"
  },
  "origin_url": "<string>",
  "external_urls": {},
  "user_data": {}
}');
form.append('template_file', '<string>');

const options = {method: 'PUT', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://app.kosli.com/api/v2/trails/{org}/{flow_name}', 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://app.kosli.com/api/v2/trails/{org}/{flow_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data_json\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"description\": \"<string>\",\r\n  \"git_commit_info\": {\r\n    \"sha1\": \"<string>\",\r\n    \"message\": \"<string>\",\r\n    \"author\": \"<string>\",\r\n    \"author_username\": \"<string>\",\r\n    \"branch\": \"<string>\",\r\n    \"timestamp\": 123,\r\n    \"url\": \"<string>\",\r\n    \"parents\": [\r\n      \"<string>\"\r\n    ],\r\n    \"verified\": true,\r\n    \"signature_state\": \"<string>\"\r\n  },\r\n  \"repo_info\": {\r\n    \"name\": \"<string>\",\r\n    \"url\": \"<string>\",\r\n    \"id\": \"<string>\",\r\n    \"description\": \"<string>\"\r\n  },\r\n  \"origin_url\": \"<string>\",\r\n  \"external_urls\": {},\r\n  \"user_data\": {}\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template_file\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$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://app.kosli.com/api/v2/trails/{org}/{flow_name}"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data_json\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"description\": \"<string>\",\r\n  \"git_commit_info\": {\r\n    \"sha1\": \"<string>\",\r\n    \"message\": \"<string>\",\r\n    \"author\": \"<string>\",\r\n    \"author_username\": \"<string>\",\r\n    \"branch\": \"<string>\",\r\n    \"timestamp\": 123,\r\n    \"url\": \"<string>\",\r\n    \"parents\": [\r\n      \"<string>\"\r\n    ],\r\n    \"verified\": true,\r\n    \"signature_state\": \"<string>\"\r\n  },\r\n  \"repo_info\": {\r\n    \"name\": \"<string>\",\r\n    \"url\": \"<string>\",\r\n    \"id\": \"<string>\",\r\n    \"description\": \"<string>\"\r\n  },\r\n  \"origin_url\": \"<string>\",\r\n  \"external_urls\": {},\r\n  \"user_data\": {}\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template_file\"\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://app.kosli.com/api/v2/trails/{org}/{flow_name}")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data_json\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"description\": \"<string>\",\r\n  \"git_commit_info\": {\r\n    \"sha1\": \"<string>\",\r\n    \"message\": \"<string>\",\r\n    \"author\": \"<string>\",\r\n    \"author_username\": \"<string>\",\r\n    \"branch\": \"<string>\",\r\n    \"timestamp\": 123,\r\n    \"url\": \"<string>\",\r\n    \"parents\": [\r\n      \"<string>\"\r\n    ],\r\n    \"verified\": true,\r\n    \"signature_state\": \"<string>\"\r\n  },\r\n  \"repo_info\": {\r\n    \"name\": \"<string>\",\r\n    \"url\": \"<string>\",\r\n    \"id\": \"<string>\",\r\n    \"description\": \"<string>\"\r\n  },\r\n  \"origin_url\": \"<string>\",\r\n  \"external_urls\": {},\r\n  \"user_data\": {}\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template_file\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.kosli.com/api/v2/trails/{org}/{flow_name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data_json\"\r\n\r\n{\r\n  \"name\": \"<string>\",\r\n  \"description\": \"<string>\",\r\n  \"git_commit_info\": {\r\n    \"sha1\": \"<string>\",\r\n    \"message\": \"<string>\",\r\n    \"author\": \"<string>\",\r\n    \"author_username\": \"<string>\",\r\n    \"branch\": \"<string>\",\r\n    \"timestamp\": 123,\r\n    \"url\": \"<string>\",\r\n    \"parents\": [\r\n      \"<string>\"\r\n    ],\r\n    \"verified\": true,\r\n    \"signature_state\": \"<string>\"\r\n  },\r\n  \"repo_info\": {\r\n    \"name\": \"<string>\",\r\n    \"url\": \"<string>\",\r\n    \"id\": \"<string>\",\r\n    \"description\": \"<string>\"\r\n  },\r\n  \"origin_url\": \"<string>\",\r\n  \"external_urls\": {},\r\n  \"user_data\": {}\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"template_file\"\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

201

"<string>"

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

flow_name · string · required

org · string · required

Body

multipart/form-data

data_json · CreateTrail · object · required

Trail metadata in JSON format

Show child attributes

template_file · string | null

Optional flow template file (max size: 10MB)

Response

201 - application/json

Successful Response

The response is of type string.