Update a Flows Vault connection

PATCH https://{tenantDomain}/api/v2/flows/vault/connections/{id}

Update a Flows Vault connection

cURL

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/flows/vault/connections/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "setup": {
    "type": "API_KEY",
    "api_key": "<string>",
    "base_url": "<string>"
  }
}
'

import requests

url = "https://{tenantDomain}/api/v2/flows/vault/connections/{id}"

payload = {
    "name": "<string>",
    "setup": {
        "type": "API_KEY",
        "api_key": "<string>",
        "base_url": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    setup: {type: 'API_KEY', api_key: '<string>', base_url: '<string>'}
  })
};

fetch('https://{tenantDomain}/api/v2/flows/vault/connections/{id}', 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://{tenantDomain}/api/v2/flows/vault/connections/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'setup' => [
        'type' => 'API_KEY',
        'api_key' => '<string>',
        'base_url' => '<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://{tenantDomain}/api/v2/flows/vault/connections/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"setup\": {\n    \"type\": \"API_KEY\",\n    \"api_key\": \"<string>\",\n    \"base_url\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://{tenantDomain}/api/v2/flows/vault/connections/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"setup\": {\n    \"type\": \"API_KEY\",\n    \"api_key\": \"<string>\",\n    \"base_url\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/flows/vault/connections/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"setup\": {\n    \"type\": \"API_KEY\",\n    \"api_key\": \"<string>\",\n    \"base_url\": \"<string>\"\n  }\n}"

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

200

{
  "id": "<string>",
  "app_id": "<string>",
  "name": "<string>",
  "ready": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "fingerprint": "<string>",
  "environment": "<string>",
  "account_name": "<string>",
  "refreshed_at": "2023-11-07T05:31:56Z"
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de chemin

id · string · requis

Flows Vault connection ID

Maximum string length: 30

Corps

application/jsonapplication/x-www-form-urlencoded

name · string

Flows Vault Connection name.

Required string length: 1 - 150

setup · object

Flows Vault Connection configuration.

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Option 9

Option 10

Option 11

Option 12

Option 13

Option 14

Option 15

Option 16

Option 17

Show child attributes

Réponse

200

application/json

Flow vault connection successfully updated.

id · string<flows-vault-connections-id> · requis

Flows Vault Connection identifier.

Maximum string length: 30

app_id · string · requis

Flows Vault Connection app identifier.

Required string length: 1 - 55

name · string · requis

Flows Vault Connection name.

Required string length: 1 - 150

ready · boolean · requis

Whether the Flows Vault Connection is configured.

created_at · string<date-time> · requis

The ISO 8601 formatted date when this Flows Vault Connection was created.

updated_at · string<date-time> · requis

The ISO 8601 formatted date when this Flows Vault Connection was updated.

fingerprint · string · requis

Minimum string length: 1

environment · string

Flows Vault Connection environment.

Required string length: 1 - 55

account_name · string

Flows Vault Connection custom account name.

Required string length: 1 - 150

refreshed_at · string<date-time>

The ISO 8601 formatted date when this Flows Vault Connection was refreshed.