Create a connector profile

curl --request POST \
  --url https://api.stackone.com/v2/connector_profiles \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connector_key": "<string>",
  "authentication_config_key": "<string>",
  "environment": "<string>",
  "name": "<string>",
  "active": false,
  "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"

payload = {
    "connector_key": "<string>",
    "authentication_config_key": "<string>",
    "environment": "<string>",
    "name": "<string>",
    "active": False,
    "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.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    connector_key: '<string>',
    authentication_config_key: '<string>',
    environment: '<string>',
    name: '<string>',
    active: false,
    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', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'connector_key' => '<string>',
    'authentication_config_key' => '<string>',
    'environment' => '<string>',
    'name' => '<string>',
    'active' => false,
    '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"

	payload := strings.NewReader("{\n  \"connector_key\": \"<string>\",\n  \"authentication_config_key\": \"<string>\",\n  \"environment\": \"<string>\",\n  \"name\": \"<string>\",\n  \"active\": false,\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("POST", 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.post("https://api.stackone.com/v2/connector_profiles")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connector_key\": \"<string>\",\n  \"authentication_config_key\": \"<string>\",\n  \"environment\": \"<string>\",\n  \"name\": \"<string>\",\n  \"active\": false,\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")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"connector_key\": \"<string>\",\n  \"authentication_config_key\": \"<string>\",\n  \"environment\": \"<string>\",\n  \"name\": \"<string>\",\n  \"active\": false,\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"
}

POST

connector_profiles

Create a connector profile

curl --request POST \
  --url https://api.stackone.com/v2/connector_profiles \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connector_key": "<string>",
  "authentication_config_key": "<string>",
  "environment": "<string>",
  "name": "<string>",
  "active": false,
  "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"

payload = {
    "connector_key": "<string>",
    "authentication_config_key": "<string>",
    "environment": "<string>",
    "name": "<string>",
    "active": False,
    "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.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    connector_key: '<string>',
    authentication_config_key: '<string>',
    environment: '<string>',
    name: '<string>',
    active: false,
    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', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'connector_key' => '<string>',
    'authentication_config_key' => '<string>',
    'environment' => '<string>',
    'name' => '<string>',
    'active' => false,
    '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"

	payload := strings.NewReader("{\n  \"connector_key\": \"<string>\",\n  \"authentication_config_key\": \"<string>\",\n  \"environment\": \"<string>\",\n  \"name\": \"<string>\",\n  \"active\": false,\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("POST", 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.post("https://api.stackone.com/v2/connector_profiles")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connector_key\": \"<string>\",\n  \"authentication_config_key\": \"<string>\",\n  \"environment\": \"<string>\",\n  \"name\": \"<string>\",\n  \"active\": false,\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")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"connector_key\": \"<string>\",\n  \"authentication_config_key\": \"<string>\",\n  \"environment\": \"<string>\",\n  \"name\": \"<string>\",\n  \"active\": false,\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

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

expand

string | null

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) and accounts_count (the number of accounts linked to this profile). These are returned as null unless requested.

Example:

"connector,version"

Body

application/json

connector_key

string

required

The key of the connector to configure (e.g. workday).

authentication_config_key

string

required

The key of the connector's authentication configuration to use.

environment

string

required

The environment of the authentication configuration (e.g. production).

name

string

required

The display name of the connector profile.

active

boolean | null

default:false

Whether the connector profile is active.

is_default

boolean | null

Whether this is the connector's default profile. The first profile created for a connector always becomes the default; marking another profile as default demotes the previous one.

version

string | null

The connector version the profile is created for.

pinned_version

string | null

The connector version to pin the profile to. Only applies to Falcon-versioned connectors; ignored otherwise.

owner

string | null

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).

setup_fields

object | null

The non-secret setup field values, keyed by setup field key.

secrets

object | null

The secret field values, keyed by field key. Stored encrypted.

action_config

object | null

The per-action enablement of the profile, keyed by action id.

Show child attributes

event_config

object | null

The per-event-action configuration (enablement and subscribed webhooks), keyed by event action id.

Show child attributes

sync_config

object | null

The per-action data-sync configuration, keyed by action id.

Show child attributes

Response

The connector profile was created.

string

required

The unique identifier of the connector profile.

name

string

required

The display name of the connector profile.

connector_key

string

required

The connector key (e.g. workday). Always present; the full connector object requires ?expand=connector.

connector

object | null

required

The connector this profile configures. Always present; null unless requested via ?expand=connector.

Show child attributes

version

object | null

required

The connector version this profile resolves to. Always present; null unless requested via ?expand=version.

Show child attributes

accounts_count

integer | null

required

The number of accounts linked to this connector profile that are visible to you. Always present; null unless requested via ?expand=accounts_count.

enabled_actions_count

integer | null

required

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.

active

boolean

required

Whether the connector profile is active.

default

boolean

required

Whether this is the default connector profile.

environment

string | null

required

The environment of the connector profile.

authentication_config_key

string | null

required

The authentication configuration key.

created_at

string<date-time>

required

The timestamp when the connector profile was created.

updated_at

string<date-time>

required

The timestamp when the connector profile was last updated.

setup_fields

object

required

The saved non-secret setup field values, keyed by setup field key.

secrets

object

required

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

action_config

object

required

The per-action enablement of the profile, keyed by action id.

Show child attributes

event_config

object

required

The per-event-action configuration (enablement and subscribed webhooks), keyed by event action id.

Show child attributes

sync_config

object

required

The per-action data-sync configuration, keyed by action id.

Show child attributes

Accounts

Actions

Connect Sessions

Connector Profiles

Connectors

Data Sync

Logs

MCP

Webhooks

Create a connector profile

Authorizations

Query Parameters

Body

Response