Update tool

Update a tool

PUT /orchestration/tools/{uuid}

Update tool

cURL

curl --request PUT \
  --url https://api.getcargo.io/v1/orchestration/tools/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "icon": {
    "kind": "<string>",
    "data": "<string>"
  },
  "description": "<string>",
  "folderUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "triggers": [
    {
      "name": "<string>",
      "description": "<string>",
      "type": "<string>",
      "cron": "<string>",
      "data": {}
    }
  ],
  "publicForm": {
    "isEnabled": true,
    "allowedOrigins": [
      "<string>"
    ],
    "spam": {
      "captchaSiteKey": "<string>",
      "captchaSecret": "<string>",
      "minFillMillis": 4503599627370495
    },
    "presentation": {
      "theme": {
        "primaryColor": "<string>",
        "primaryTextColor": "<string>",
        "primaryHoverColor": "<string>",
        "textColor": "<string>",
        "mutedColor": "<string>",
        "backgroundColor": "<string>",
        "borderColor": "<string>",
        "borderFocusColor": "<string>",
        "radius": "<string>",
        "fontFamily": "<string>"
      }
    }
  }
}
'

import requests

url = "https://api.getcargo.io/v1/orchestration/tools/{uuid}"

payload = {
    "name": "<string>",
    "icon": {
        "kind": "<string>",
        "data": "<string>"
    },
    "description": "<string>",
    "folderUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "triggers": [
        {
            "name": "<string>",
            "description": "<string>",
            "type": "<string>",
            "cron": "<string>",
            "data": {}
        }
    ],
    "publicForm": {
        "isEnabled": True,
        "allowedOrigins": ["<string>"],
        "spam": {
            "captchaSiteKey": "<string>",
            "captchaSecret": "<string>",
            "minFillMillis": 4503599627370495
        },
        "presentation": { "theme": {
                "primaryColor": "<string>",
                "primaryTextColor": "<string>",
                "primaryHoverColor": "<string>",
                "textColor": "<string>",
                "mutedColor": "<string>",
                "backgroundColor": "<string>",
                "borderColor": "<string>",
                "borderFocusColor": "<string>",
                "radius": "<string>",
                "fontFamily": "<string>"
            } }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    icon: {kind: '<string>', data: '<string>'},
    description: '<string>',
    folderUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    triggers: [
      {
        name: '<string>',
        description: '<string>',
        type: '<string>',
        cron: '<string>',
        data: {}
      }
    ],
    publicForm: {
      isEnabled: true,
      allowedOrigins: ['<string>'],
      spam: {
        captchaSiteKey: '<string>',
        captchaSecret: '<string>',
        minFillMillis: 4503599627370495
      },
      presentation: {
        theme: {
          primaryColor: '<string>',
          primaryTextColor: '<string>',
          primaryHoverColor: '<string>',
          textColor: '<string>',
          mutedColor: '<string>',
          backgroundColor: '<string>',
          borderColor: '<string>',
          borderFocusColor: '<string>',
          radius: '<string>',
          fontFamily: '<string>'
        }
      }
    }
  })
};

fetch('https://api.getcargo.io/v1/orchestration/tools/{uuid}', 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/orchestration/tools/{uuid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'icon' => [
        'kind' => '<string>',
        'data' => '<string>'
    ],
    'description' => '<string>',
    'folderUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'triggers' => [
        [
                'name' => '<string>',
                'description' => '<string>',
                'type' => '<string>',
                'cron' => '<string>',
                'data' => [
                                
                ]
        ]
    ],
    'publicForm' => [
        'isEnabled' => true,
        'allowedOrigins' => [
                '<string>'
        ],
        'spam' => [
                'captchaSiteKey' => '<string>',
                'captchaSecret' => '<string>',
                'minFillMillis' => 4503599627370495
        ],
        'presentation' => [
                'theme' => [
                                'primaryColor' => '<string>',
                                'primaryTextColor' => '<string>',
                                'primaryHoverColor' => '<string>',
                                'textColor' => '<string>',
                                'mutedColor' => '<string>',
                                'backgroundColor' => '<string>',
                                'borderColor' => '<string>',
                                'borderFocusColor' => '<string>',
                                'radius' => '<string>',
                                'fontFamily' => '<string>'
                ]
        ]
    ]
  ]),
  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/orchestration/tools/{uuid}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"icon\": {\n    \"kind\": \"<string>\",\n    \"data\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"folderUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"triggers\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"type\": \"<string>\",\n      \"cron\": \"<string>\",\n      \"data\": {}\n    }\n  ],\n  \"publicForm\": {\n    \"isEnabled\": true,\n    \"allowedOrigins\": [\n      \"<string>\"\n    ],\n    \"spam\": {\n      \"captchaSiteKey\": \"<string>\",\n      \"captchaSecret\": \"<string>\",\n      \"minFillMillis\": 4503599627370495\n    },\n    \"presentation\": {\n      \"theme\": {\n        \"primaryColor\": \"<string>\",\n        \"primaryTextColor\": \"<string>\",\n        \"primaryHoverColor\": \"<string>\",\n        \"textColor\": \"<string>\",\n        \"mutedColor\": \"<string>\",\n        \"backgroundColor\": \"<string>\",\n        \"borderColor\": \"<string>\",\n        \"borderFocusColor\": \"<string>\",\n        \"radius\": \"<string>\",\n        \"fontFamily\": \"<string>\"\n      }\n    }\n  }\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.getcargo.io/v1/orchestration/tools/{uuid}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"icon\": {\n    \"kind\": \"<string>\",\n    \"data\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"folderUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"triggers\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"type\": \"<string>\",\n      \"cron\": \"<string>\",\n      \"data\": {}\n    }\n  ],\n  \"publicForm\": {\n    \"isEnabled\": true,\n    \"allowedOrigins\": [\n      \"<string>\"\n    ],\n    \"spam\": {\n      \"captchaSiteKey\": \"<string>\",\n      \"captchaSecret\": \"<string>\",\n      \"minFillMillis\": 4503599627370495\n    },\n    \"presentation\": {\n      \"theme\": {\n        \"primaryColor\": \"<string>\",\n        \"primaryTextColor\": \"<string>\",\n        \"primaryHoverColor\": \"<string>\",\n        \"textColor\": \"<string>\",\n        \"mutedColor\": \"<string>\",\n        \"backgroundColor\": \"<string>\",\n        \"borderColor\": \"<string>\",\n        \"borderFocusColor\": \"<string>\",\n        \"radius\": \"<string>\",\n        \"fontFamily\": \"<string>\"\n      }\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcargo.io/v1/orchestration/tools/{uuid}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"icon\": {\n    \"kind\": \"<string>\",\n    \"data\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"folderUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"triggers\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"type\": \"<string>\",\n      \"cron\": \"<string>\",\n      \"data\": {}\n    }\n  ],\n  \"publicForm\": {\n    \"isEnabled\": true,\n    \"allowedOrigins\": [\n      \"<string>\"\n    ],\n    \"spam\": {\n      \"captchaSiteKey\": \"<string>\",\n      \"captchaSecret\": \"<string>\",\n      \"minFillMillis\": 4503599627370495\n    },\n    \"presentation\": {\n      \"theme\": {\n        \"primaryColor\": \"<string>\",\n        \"primaryTextColor\": \"<string>\",\n        \"primaryHoverColor\": \"<string>\",\n        \"textColor\": \"<string>\",\n        \"mutedColor\": \"<string>\",\n        \"backgroundColor\": \"<string>\",\n        \"borderColor\": \"<string>\",\n        \"borderFocusColor\": \"<string>\",\n        \"radius\": \"<string>\",\n        \"fontFamily\": \"<string>\"\n      }\n    }\n  }\n}"

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

200

{
  "tool": {
    "uuid": "<string>",
    "icon": {
      "kind": "<string>",
      "data": "<string>"
    },
    "workspaceUuid": "<string>",
    "workflowUuid": "<string>",
    "userUuid": "<string>",
    "name": "<string>",
    "folderUuid": "<string>",
    "creditsCost": {
      "kind": "<string>"
    },
    "description": "<string>",
    "isReadOnly": true,
    "triggers": [
      {
        "name": "<string>",
        "description": "<string>",
        "type": "<string>",
        "cron": "<string>",
        "temporalScheduleWorkflowId": "<string>",
        "data": {}
      }
    ],
    "publicForm": {
      "isEnabled": true,
      "allowedOrigins": [
        "<string>"
      ],
      "spam": {
        "captchaSiteKey": "<string>",
        "captchaSecret": "<string>",
        "minFillMillis": 4503599627370495
      },
      "presentation": {
        "theme": {
          "primaryColor": "<string>",
          "primaryTextColor": "<string>",
          "primaryHoverColor": "<string>",
          "textColor": "<string>",
          "mutedColor": "<string>",
          "backgroundColor": "<string>",
          "borderColor": "<string>",
          "borderFocusColor": "<string>",
          "radius": "<string>",
          "fontFamily": "<string>"
        }
      }
    },
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>"
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

uuid · string<uuid> · required

Tool identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Body

application/json

Request body schema.

name · string

Tool name.

icon · Icon · object

Tool icon.

Icon

Icon

Show child attributes

description · string | null

Tool description.

folderUuid · string<uuid> | null

Folder identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

triggers · Triggers · object[]

Tool cron triggers.

Show child attributes

publicForm · Public form · object | null

Public, embeddable form configuration. Set to null to disable.

Show child attributes

template · Template · object

Template publishing configuration.

Show child attributes

Response

200

application/json

Successful response

tool · Tool · object · required

Updated tool details.

Show child attributes