curl --request GET \
--url https://api.stackone.com/v2/connectors/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.stackone.com/v2/connectors/{id}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.stackone.com/v2/connectors/{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/connectors/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.stackone.com/v2/connectors/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.stackone.com/v2/connectors/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stackone.com/v2/connectors/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"key": "<string>",
"name": "<string>",
"logo_url": "<string>",
"description": "<string>",
"categories": [
"<string>"
],
"authentication_methods": [
{
"key": "<string>",
"label": "<string>",
"type": "<string>"
}
],
"version": "<string>",
"owner": "<string>",
"release_stage": "<string>",
"actions_count": 123,
"events_count": 123,
"documentation_url": "<string>",
"authentication": {},
"actions": [
{
"id": "<string>",
"label": "<string>",
"description": "<string>",
"schema_type": "<string>",
"authentication": [
{
"type": "<string>",
"label": "<string>",
"key": "<string>",
"required_scopes": [
"<string>"
],
"description": "<string>"
}
],
"tags": [
"<string>"
],
"required_scopes": [
"<string>"
],
"release_stage": "<string>",
"effects": [
"<string>"
],
"annotations": {
"title": "<string>",
"readOnlyHint": true,
"destructiveHint": true,
"idempotentHint": true,
"openWorldHint": true
},
"action_details": {},
"syncable": true,
"supports_incremental": true,
"has_required_parameters": true,
"lookback_default_window": "<string>",
"supports_verify_deletions": true,
"enabled": true
}
],
"enabled_actions_count": 123,
"event_actions": [
{
"id": "<string>",
"label": "<string>",
"description": "<string>",
"tags": [
"<string>"
],
"release_stage": "<string>",
"requires_manual_setup": true,
"authentication": [
{
"type": "<string>",
"label": "<string>",
"key": "<string>",
"required_scopes": [
"<string>"
],
"description": "<string>"
}
]
}
],
"scope_definitions": [
{
"name": "<string>",
"description": "<string>",
"includes": [
"<string>"
]
}
],
"versions": [
{
"version": "<string>",
"owner": "<string>",
"builtin": true,
"release_stage": "<string>"
}
],
"changelog": {
"current_version": "<string>",
"entries": [
{
"version": "<string>",
"summary": "<string>",
"labels": [
"<string>"
],
"released_at": "2023-11-07T05:31:56Z",
"affected_actions": {
"added": [
"<string>"
],
"removed": [
"<string>"
],
"changed": [
"<string>"
]
}
}
]
},
"accounts_count": 123,
"connector_profiles_count": 123
}{
"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"
}Get connector
Returns the details of a single connector, including its description, documentation URL and authentication methods.
curl --request GET \
--url https://api.stackone.com/v2/connectors/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.stackone.com/v2/connectors/{id}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.stackone.com/v2/connectors/{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/connectors/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.stackone.com/v2/connectors/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.stackone.com/v2/connectors/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stackone.com/v2/connectors/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"key": "<string>",
"name": "<string>",
"logo_url": "<string>",
"description": "<string>",
"categories": [
"<string>"
],
"authentication_methods": [
{
"key": "<string>",
"label": "<string>",
"type": "<string>"
}
],
"version": "<string>",
"owner": "<string>",
"release_stage": "<string>",
"actions_count": 123,
"events_count": 123,
"documentation_url": "<string>",
"authentication": {},
"actions": [
{
"id": "<string>",
"label": "<string>",
"description": "<string>",
"schema_type": "<string>",
"authentication": [
{
"type": "<string>",
"label": "<string>",
"key": "<string>",
"required_scopes": [
"<string>"
],
"description": "<string>"
}
],
"tags": [
"<string>"
],
"required_scopes": [
"<string>"
],
"release_stage": "<string>",
"effects": [
"<string>"
],
"annotations": {
"title": "<string>",
"readOnlyHint": true,
"destructiveHint": true,
"idempotentHint": true,
"openWorldHint": true
},
"action_details": {},
"syncable": true,
"supports_incremental": true,
"has_required_parameters": true,
"lookback_default_window": "<string>",
"supports_verify_deletions": true,
"enabled": true
}
],
"enabled_actions_count": 123,
"event_actions": [
{
"id": "<string>",
"label": "<string>",
"description": "<string>",
"tags": [
"<string>"
],
"release_stage": "<string>",
"requires_manual_setup": true,
"authentication": [
{
"type": "<string>",
"label": "<string>",
"key": "<string>",
"required_scopes": [
"<string>"
],
"description": "<string>"
}
]
}
],
"scope_definitions": [
{
"name": "<string>",
"description": "<string>",
"includes": [
"<string>"
]
}
],
"versions": [
{
"version": "<string>",
"owner": "<string>",
"builtin": true,
"release_stage": "<string>"
}
],
"changelog": {
"current_version": "<string>",
"entries": [
{
"version": "<string>",
"summary": "<string>",
"labels": [
"<string>"
],
"released_at": "2023-11-07T05:31:56Z",
"affected_actions": {
"added": [
"<string>"
],
"removed": [
"<string>"
],
"changed": [
"<string>"
]
}
}
]
},
"accounts_count": 123,
"connector_profiles_count": 123
}{
"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
Path Parameters
Query Parameters
The id of a connector profile to report the actions against. Every action returned by expand=actions then carries enabled, the actions the profile enables are listed first, and enabled_actions_count reports how many of them it enables. Requires expand=actions; supplying it without that is a 400. Omit it to receive the connector as configured for no profile.
A comma-separated list of additional fields to expand. Supported values: actions (the actions, event-actions and scope-definitions metadata — a large payload; empty arrays when the connector exposes no actions metadata), versions (the registry versions of the connector, newest first — the version options a connector profile can be pinned to), changelog (the connector's release history, newest first — one entry per published version with its summary, labels, release date and affected actions; StackOne's built-in Falcon connectors only), accounts_count (the number of accounts linked to the connector) and connector_profiles_count (the number of connector profiles configured for the connector). These are expensive to resolve, so they are returned as null unless requested.
"accounts_count,connector_profiles_count"
Response
The connector was retrieved.
The metadata of the actions the connector exposes (id, label, description, tags, required scopes…). Only resolved when expand=actions is requested; null otherwise. When connector_profile_id is supplied, the actions that profile enables come first and every action carries enabled.
Show child attributes
Show child attributes
The connector's release history: one entry per published version, newest first, with its summary, labels, release date and affected actions. Only resolved when expand=changelog is requested, and only for StackOne's built-in Falcon connectors; null otherwise, including connectors with no published changelog.
Show child attributes
Show child attributes
Was this page helpful?