Set credentials on one connection
curl --request PUT \
--url https://api.flowforma.com/v1/apiConnections/{connectionFfuuid}/credentials \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"Type": "apiKey",
"Key": "x-api-key",
"Value": "abc123",
"Location": "header"
}
'import requests
url = "https://api.flowforma.com/v1/apiConnections/{connectionFfuuid}/credentials"
payload = {
"Type": "apiKey",
"Key": "x-api-key",
"Value": "abc123",
"Location": "header"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({Type: 'apiKey', Key: 'x-api-key', Value: 'abc123', Location: 'header'})
};
fetch('https://api.flowforma.com/v1/apiConnections/{connectionFfuuid}/credentials', 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.flowforma.com/v1/apiConnections/{connectionFfuuid}/credentials",
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([
'Type' => 'apiKey',
'Key' => 'x-api-key',
'Value' => 'abc123',
'Location' => 'header'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.flowforma.com/v1/apiConnections/{connectionFfuuid}/credentials"
payload := strings.NewReader("{\n \"Type\": \"apiKey\",\n \"Key\": \"x-api-key\",\n \"Value\": \"abc123\",\n \"Location\": \"header\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.flowforma.com/v1/apiConnections/{connectionFfuuid}/credentials")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Type\": \"apiKey\",\n \"Key\": \"x-api-key\",\n \"Value\": \"abc123\",\n \"Location\": \"header\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flowforma.com/v1/apiConnections/{connectionFfuuid}/credentials")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"Type\": \"apiKey\",\n \"Key\": \"x-api-key\",\n \"Value\": \"abc123\",\n \"Location\": \"header\"\n}"
response = http.request(request)
puts response.read_body{
"code": "400",
"message": "Page does not exist."
}{
"code": "400",
"message": "Page does not exist."
}{
"code": "400",
"message": "Page does not exist."
}API Connections
Set credentials on one connection
Applies the supplied credentials to every request within the API connection identified by connectionFfuuid. This endpoint requires a FlowForma integration access token (not an Azure AD bearer token).
PUT
/
v1
/
apiConnections
/
{connectionFfuuid}
/
credentials
Set credentials on one connection
curl --request PUT \
--url https://api.flowforma.com/v1/apiConnections/{connectionFfuuid}/credentials \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"Type": "apiKey",
"Key": "x-api-key",
"Value": "abc123",
"Location": "header"
}
'import requests
url = "https://api.flowforma.com/v1/apiConnections/{connectionFfuuid}/credentials"
payload = {
"Type": "apiKey",
"Key": "x-api-key",
"Value": "abc123",
"Location": "header"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({Type: 'apiKey', Key: 'x-api-key', Value: 'abc123', Location: 'header'})
};
fetch('https://api.flowforma.com/v1/apiConnections/{connectionFfuuid}/credentials', 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.flowforma.com/v1/apiConnections/{connectionFfuuid}/credentials",
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([
'Type' => 'apiKey',
'Key' => 'x-api-key',
'Value' => 'abc123',
'Location' => 'header'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.flowforma.com/v1/apiConnections/{connectionFfuuid}/credentials"
payload := strings.NewReader("{\n \"Type\": \"apiKey\",\n \"Key\": \"x-api-key\",\n \"Value\": \"abc123\",\n \"Location\": \"header\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.flowforma.com/v1/apiConnections/{connectionFfuuid}/credentials")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Type\": \"apiKey\",\n \"Key\": \"x-api-key\",\n \"Value\": \"abc123\",\n \"Location\": \"header\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flowforma.com/v1/apiConnections/{connectionFfuuid}/credentials")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"Type\": \"apiKey\",\n \"Key\": \"x-api-key\",\n \"Value\": \"abc123\",\n \"Location\": \"header\"\n}"
response = http.request(request)
puts response.read_body{
"code": "400",
"message": "Page does not exist."
}{
"code": "400",
"message": "Page does not exist."
}{
"code": "400",
"message": "Page does not exist."
}Authorizations
Body
application/json
Credentials to store against API connection requests. Provide the fields that match Type: basic uses Username and Password; apiKey uses Key, Value, and Location; bearerToken uses Token. Secret values are encrypted at rest.
Response
Successful operation

