curl --request PATCH \
--url https://api.stackone.com/v2/connector_profiles/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"authentication_config_key": "<string>",
"environment": "<string>",
"active": true,
"is_default": true,
"version": "<string>",
"pinned_version": "<string>",
"owner": "<string>",
"setup_fields": {},
"secrets": {},
"action_config": {},
"event_config": {},
"sync_config": {}
}
'import requests
url = "https://api.stackone.com/v2/connector_profiles/{id}"
payload = {
"name": "<string>",
"authentication_config_key": "<string>",
"environment": "<string>",
"active": True,
"is_default": True,
"version": "<string>",
"pinned_version": "<string>",
"owner": "<string>",
"setup_fields": {},
"secrets": {},
"action_config": {},
"event_config": {},
"sync_config": {}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
authentication_config_key: '<string>',
environment: '<string>',
active: true,
is_default: true,
version: '<string>',
pinned_version: '<string>',
owner: '<string>',
setup_fields: {},
secrets: {},
action_config: {},
event_config: {},
sync_config: {}
})
};
fetch('https://api.stackone.com/v2/connector_profiles/{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://api.stackone.com/v2/connector_profiles/{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>',
'authentication_config_key' => '<string>',
'environment' => '<string>',
'active' => true,
'is_default' => true,
'version' => '<string>',
'pinned_version' => '<string>',
'owner' => '<string>',
'setup_fields' => [
],
'secrets' => [
],
'action_config' => [
],
'event_config' => [
],
'sync_config' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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.stackone.com/v2/connector_profiles/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"authentication_config_key\": \"<string>\",\n \"environment\": \"<string>\",\n \"active\": true,\n \"is_default\": true,\n \"version\": \"<string>\",\n \"pinned_version\": \"<string>\",\n \"owner\": \"<string>\",\n \"setup_fields\": {},\n \"secrets\": {},\n \"action_config\": {},\n \"event_config\": {},\n \"sync_config\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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://api.stackone.com/v2/connector_profiles/{id}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"authentication_config_key\": \"<string>\",\n \"environment\": \"<string>\",\n \"active\": true,\n \"is_default\": true,\n \"version\": \"<string>\",\n \"pinned_version\": \"<string>\",\n \"owner\": \"<string>\",\n \"setup_fields\": {},\n \"secrets\": {},\n \"action_config\": {},\n \"event_config\": {},\n \"sync_config\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stackone.com/v2/connector_profiles/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"authentication_config_key\": \"<string>\",\n \"environment\": \"<string>\",\n \"active\": true,\n \"is_default\": true,\n \"version\": \"<string>\",\n \"pinned_version\": \"<string>\",\n \"owner\": \"<string>\",\n \"setup_fields\": {},\n \"secrets\": {},\n \"action_config\": {},\n \"event_config\": {},\n \"sync_config\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"connector_key": "<string>",
"connector": {
"key": "<string>",
"name": "<string>",
"logo_url": "<string>",
"categories": [
"<string>"
],
"release_stage": "<string>",
"authentication_config_label": "<string>"
},
"version": {
"resolved": "<string>",
"pinned": "<string>",
"owner": "<string>"
},
"accounts_count": 123,
"enabled_actions_count": 123,
"active": true,
"default": true,
"environment": "<string>",
"authentication_config_key": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"setup_fields": {},
"secrets": {},
"action_config": {},
"event_config": {},
"sync_config": {}
}{
"statusCode": 400,
"message": "Bad Request",
"timestamp": "2023-05-30T00:00:00.000Z",
"data": {
"statusCode": 400,
"message": "Bad Request",
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
},
"provider_errors": [
{
"status": 400,
"url": "https://api.provider.com/v1/resource",
"raw": {
"message": "Invalid input parameters"
},
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
}
]
}{
"statusCode": 401,
"message": "Unauthorized",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 403,
"message": "Forbidden resource",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 404,
"message": "Not Found",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 408,
"message": "Request timed out",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 409,
"message": "Conflict",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 422,
"message": "Unprocessable Entity",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 429,
"message": "Too many requests",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 500,
"message": "Internal server error",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 501,
"message": "Not Implemented",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 502,
"message": "Bad Gateway",
"timestamp": "2023-05-30T00:00:00.000Z"
}Patch a connector profile
Updates a connector profile. Secrets resent as __secretvalue:-prefixed placeholders keep their stored values.
curl --request PATCH \
--url https://api.stackone.com/v2/connector_profiles/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"authentication_config_key": "<string>",
"environment": "<string>",
"active": true,
"is_default": true,
"version": "<string>",
"pinned_version": "<string>",
"owner": "<string>",
"setup_fields": {},
"secrets": {},
"action_config": {},
"event_config": {},
"sync_config": {}
}
'import requests
url = "https://api.stackone.com/v2/connector_profiles/{id}"
payload = {
"name": "<string>",
"authentication_config_key": "<string>",
"environment": "<string>",
"active": True,
"is_default": True,
"version": "<string>",
"pinned_version": "<string>",
"owner": "<string>",
"setup_fields": {},
"secrets": {},
"action_config": {},
"event_config": {},
"sync_config": {}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
authentication_config_key: '<string>',
environment: '<string>',
active: true,
is_default: true,
version: '<string>',
pinned_version: '<string>',
owner: '<string>',
setup_fields: {},
secrets: {},
action_config: {},
event_config: {},
sync_config: {}
})
};
fetch('https://api.stackone.com/v2/connector_profiles/{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://api.stackone.com/v2/connector_profiles/{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>',
'authentication_config_key' => '<string>',
'environment' => '<string>',
'active' => true,
'is_default' => true,
'version' => '<string>',
'pinned_version' => '<string>',
'owner' => '<string>',
'setup_fields' => [
],
'secrets' => [
],
'action_config' => [
],
'event_config' => [
],
'sync_config' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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.stackone.com/v2/connector_profiles/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"authentication_config_key\": \"<string>\",\n \"environment\": \"<string>\",\n \"active\": true,\n \"is_default\": true,\n \"version\": \"<string>\",\n \"pinned_version\": \"<string>\",\n \"owner\": \"<string>\",\n \"setup_fields\": {},\n \"secrets\": {},\n \"action_config\": {},\n \"event_config\": {},\n \"sync_config\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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://api.stackone.com/v2/connector_profiles/{id}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"authentication_config_key\": \"<string>\",\n \"environment\": \"<string>\",\n \"active\": true,\n \"is_default\": true,\n \"version\": \"<string>\",\n \"pinned_version\": \"<string>\",\n \"owner\": \"<string>\",\n \"setup_fields\": {},\n \"secrets\": {},\n \"action_config\": {},\n \"event_config\": {},\n \"sync_config\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stackone.com/v2/connector_profiles/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"authentication_config_key\": \"<string>\",\n \"environment\": \"<string>\",\n \"active\": true,\n \"is_default\": true,\n \"version\": \"<string>\",\n \"pinned_version\": \"<string>\",\n \"owner\": \"<string>\",\n \"setup_fields\": {},\n \"secrets\": {},\n \"action_config\": {},\n \"event_config\": {},\n \"sync_config\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"connector_key": "<string>",
"connector": {
"key": "<string>",
"name": "<string>",
"logo_url": "<string>",
"categories": [
"<string>"
],
"release_stage": "<string>",
"authentication_config_label": "<string>"
},
"version": {
"resolved": "<string>",
"pinned": "<string>",
"owner": "<string>"
},
"accounts_count": 123,
"enabled_actions_count": 123,
"active": true,
"default": true,
"environment": "<string>",
"authentication_config_key": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"setup_fields": {},
"secrets": {},
"action_config": {},
"event_config": {},
"sync_config": {}
}{
"statusCode": 400,
"message": "Bad Request",
"timestamp": "2023-05-30T00:00:00.000Z",
"data": {
"statusCode": 400,
"message": "Bad Request",
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
},
"provider_errors": [
{
"status": 400,
"url": "https://api.provider.com/v1/resource",
"raw": {
"message": "Invalid input parameters"
},
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
}
]
}{
"statusCode": 401,
"message": "Unauthorized",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 403,
"message": "Forbidden resource",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 404,
"message": "Not Found",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 408,
"message": "Request timed out",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 409,
"message": "Conflict",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 422,
"message": "Unprocessable Entity",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 429,
"message": "Too many requests",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 500,
"message": "Internal server error",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 501,
"message": "Not Implemented",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 502,
"message": "Bad Gateway",
"timestamp": "2023-05-30T00:00:00.000Z"
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
The unique identifier of the connector profile.
Query Parameters
A comma-separated list of additional fields to expand. Supported values: connector (the connector this profile configures), version (the connector version this profile resolves to), accounts_count (the number of accounts linked to this profile) and enabled_actions_count (how many of that version's actions this profile enables). These are returned as null unless requested.
"connector,version"
Body
The display name of the connector profile.
The key of the connector's authentication configuration to use. Switching it usually requires resending the setup fields and secrets of the new method.
The environment of the authentication configuration (e.g. production).
Whether the connector profile is active.
Whether this is the connector's default profile. Marking a profile as default demotes the previous one; the last remaining default cannot be demoted.
The connector version the profile uses.
The connector version to pin the profile to. Only applies to Falcon-versioned connectors; ignored otherwise.
The owner of the pinned connector version (defaults to stackone). Accepts the wildcards builtin (the global stackone owner) and custom (the organization's own connectors).
The non-secret setup field values, keyed by setup field key. Replaces the saved setup fields when provided.
The secret field values, keyed by field key. Replaces the saved secrets when provided: resend a __secretvalue:-prefixed placeholder to keep a stored secret, send an empty object to clear all secrets, or omit the field to leave them unchanged.
The per-action enablement of the profile, keyed by action id.
Show child attributes
Show child attributes
The per-event-action configuration (enablement and subscribed webhooks), keyed by event action id.
Show child attributes
Show child attributes
The per-action data-sync configuration, keyed by action id.
Show child attributes
Show child attributes
Response
The connector profile was updated.
The unique identifier of the connector profile.
The display name of the connector profile.
The connector key (e.g. workday). Always present; the full connector object requires ?expand=connector.
The connector this profile configures. Always present; null unless requested via ?expand=connector.
Show child attributes
Show child attributes
The connector version this profile resolves to. Always present; null unless requested via ?expand=version.
Show child attributes
Show child attributes
The number of accounts linked to this connector profile that are visible to you. Always present; null unless requested via ?expand=accounts_count.
How many of the connector version's actions this profile enables. For StackOne connectors only the actions in the release stages your organization can access are counted, so this can read lower than the number the profile actually enables; a connector your organization owns is counted in full. A profile that enables everything counts all of them; one naming individual actions counts only those the version still has. 0 when the profile enables nothing, and also whenever no catalogue can be resolved — an unreadable registry, or a connector whose own release stage your organization cannot access. Always present; null unless requested via ?expand=enabled_actions_count on a read endpoint, and always null on create.
Whether the connector profile is active.
Whether this is the default connector profile.
The environment of the connector profile.
The authentication configuration key.
The timestamp when the connector profile was created.
The timestamp when the connector profile was last updated.
The saved non-secret setup field values, keyed by setup field key.
The saved secret fields, keyed by field key. Values are __secretvalue:-prefixed redacted placeholders (never the plaintext); resend a placeholder unchanged to keep the stored secret.
Show child attributes
Show child attributes
The per-action enablement of the profile, keyed by action id.
Show child attributes
Show child attributes
The per-event-action configuration (enablement and subscribed webhooks), keyed by event action id.
Show child attributes
Show child attributes
The per-action data-sync configuration, keyed by action id.
Show child attributes
Show child attributes
Was this page helpful?