Update credential

curl --request PATCH \
  --url https://flows.super.ai/api/integrations/credentials/{credential_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "credentials": {},
  "name": "<string>"
}
'

import requests

url = "https://flows.super.ai/api/integrations/credentials/{credential_id}"

payload = {
    "credentials": {},
    "name": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'X-API-Key': '<api-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({credentials: {}, name: '<string>'})
};

fetch('https://flows.super.ai/api/integrations/credentials/{credential_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://flows.super.ai/api/integrations/credentials/{credential_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([
    'credentials' => [
        
    ],
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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://flows.super.ai/api/integrations/credentials/{credential_id}"

	payload := strings.NewReader("{\n  \"credentials\": {},\n  \"name\": \"<string>\"\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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://flows.super.ai/api/integrations/credentials/{credential_id}")
  .header("X-API-Key", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"credentials\": {},\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://flows.super.ai/api/integrations/credentials/{credential_id}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"credentials\": {},\n  \"name\": \"<string>\"\n}"

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "modified_by": "<string>",
  "name": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

integrations

Update credential

Update existing integration credentials with new values.

Replaces credential data (passwords, tokens, connection details) for an existing credential. Use this endpoint to rotate passwords, update connection strings, or refresh OAuth tokens.

Context: Credential updates are necessary for several operational scenarios:

Password rotation policies require periodic credential updates
SFTP server configuration changes (hostname, port)
Database connection string modifications
SSH key rotation for key-based authentication
OAuth token refresh (though typically handled automatically)

Updates preserve credential_id, allowing workflows to continue using the same reference.

Use Cases: Rotate SFTP password after security audit requires credential changes.

Update PostgreSQL connection string after database server migration.

Replace SSH private key after key compromise detected. Related Endpoints:

GET /integrations/credentials/ - Get credential metadata before updating
POST /integrations/sftp/test-connection - Test new SFTP credentials before updating
POST /integrations/postgres/test-connection - Test new PostgreSQL credentials before updating
DELETE /integrations/credentials/ - Delete credential instead of updating

Security:

New credentials are encrypted before storage (same as creation)
Old credential data is overwritten (not preserved in database)
Audit trail tracks who performed the update via modified_by field
Test new credentials before updating to prevent workflow disruption

Notes:

Always test new credentials before updating to avoid breaking workflows
Workflows using this credential will use new values immediately
OAuth credentials are typically auto-refreshed (manual update rarely needed)
Consider creating new credential instead of updating if provider changes

PATCH

api

integrations

credentials

{credential_id}

Update credential

curl --request PATCH \
  --url https://flows.super.ai/api/integrations/credentials/{credential_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "credentials": {},
  "name": "<string>"
}
'

import requests

url = "https://flows.super.ai/api/integrations/credentials/{credential_id}"

payload = {
    "credentials": {},
    "name": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'X-API-Key': '<api-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({credentials: {}, name: '<string>'})
};

fetch('https://flows.super.ai/api/integrations/credentials/{credential_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://flows.super.ai/api/integrations/credentials/{credential_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([
    'credentials' => [
        
    ],
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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://flows.super.ai/api/integrations/credentials/{credential_id}"

	payload := strings.NewReader("{\n  \"credentials\": {},\n  \"name\": \"<string>\"\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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://flows.super.ai/api/integrations/credentials/{credential_id}")
  .header("X-API-Key", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"credentials\": {},\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://flows.super.ai/api/integrations/credentials/{credential_id}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"credentials\": {},\n  \"name\": \"<string>\"\n}"

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "modified_by": "<string>",
  "name": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

X-API-Key

string

header

required

API key authentication. Include your API key in the X-API-Key header as: X-API-Key YOUR_API_KEY

Example:

X-API-Key: saf_1234567890

Authorization

string

header

required

JWT Bearer token authentication. Include your access token in the Authorization header as: Bearer YOUR_ACCESS_TOKEN

Example:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Path Parameters

credential_id

string<uuid>

required

UUID of the credential to update. Must belong to the authenticated user's organization.

Body

application/json

Request model for updating user integration credentials

credential_type

enum<string>

required

Available options:

api_key,

oauth2,

user_password,

key_file,

client_credentials,

sharepoint_receive,

google_drive_receive

credentials

Credentials · object

required

name

string | null

Response

Credential updated successfully

created_at

string<date-time>

required

string<uuid>

required

modified_by

string

required

name

string

required

provider

enum<string>

required

Available options:

microsoft,

sftp,

aws_ses,

google,

postgresql,

internal_postgresql,

file_storage,

sharepoint_client_secret

updated_at

string<date-time>

required

user_id

string<uuid> | null

Delete credential Get credential secrets