Skip to main content
POST
/
v1
/
global-connections
cURL
curl --request POST \
  --url https://cloud.nrai.io/api/v1/global-connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "pieceName": "<string>",
  "type": "SECRET_TEXT",
  "value": {
    "type": "SECRET_TEXT",
    "secret_text": "<string>"
  },
  "scope": "PLATFORM",
  "projectIds": [
    "<string>"
  ],
  "metadata": {},
  "externalId": "<string>"
}
'
import requests

url = "https://cloud.nrai.io/api/v1/global-connections"

payload = {
    "displayName": "<string>",
    "pieceName": "<string>",
    "type": "SECRET_TEXT",
    "value": {
        "type": "SECRET_TEXT",
        "secret_text": "<string>"
    },
    "scope": "PLATFORM",
    "projectIds": ["<string>"],
    "metadata": {},
    "externalId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    displayName: '<string>',
    pieceName: '<string>',
    type: 'SECRET_TEXT',
    value: {type: 'SECRET_TEXT', secret_text: '<string>'},
    scope: 'PLATFORM',
    projectIds: ['<string>'],
    metadata: {},
    externalId: '<string>'
  })
};

fetch('https://cloud.nrai.io/api/v1/global-connections', 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://cloud.nrai.io/api/v1/global-connections",
  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([
    'displayName' => '<string>',
    'pieceName' => '<string>',
    'type' => 'SECRET_TEXT',
    'value' => [
        'type' => 'SECRET_TEXT',
        'secret_text' => '<string>'
    ],
    'scope' => 'PLATFORM',
    'projectIds' => [
        '<string>'
    ],
    'metadata' => [
        
    ],
    'externalId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://cloud.nrai.io/api/v1/global-connections"

	payload := strings.NewReader("{\n  \"displayName\": \"<string>\",\n  \"pieceName\": \"<string>\",\n  \"type\": \"SECRET_TEXT\",\n  \"value\": {\n    \"type\": \"SECRET_TEXT\",\n    \"secret_text\": \"<string>\"\n  },\n  \"scope\": \"PLATFORM\",\n  \"projectIds\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"externalId\": \"<string>\"\n}")

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

	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.post("https://cloud.nrai.io/api/v1/global-connections")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"displayName\": \"<string>\",\n  \"pieceName\": \"<string>\",\n  \"type\": \"SECRET_TEXT\",\n  \"value\": {\n    \"type\": \"SECRET_TEXT\",\n    \"secret_text\": \"<string>\"\n  },\n  \"scope\": \"PLATFORM\",\n  \"projectIds\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"externalId\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://cloud.nrai.io/api/v1/global-connections")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"displayName\": \"<string>\",\n  \"pieceName\": \"<string>\",\n  \"type\": \"SECRET_TEXT\",\n  \"value\": {\n    \"type\": \"SECRET_TEXT\",\n    \"secret_text\": \"<string>\"\n  },\n  \"scope\": \"PLATFORM\",\n  \"projectIds\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"externalId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "created": "<string>",
  "updated": "<string>",
  "externalId": "<string>",
  "displayName": "<string>",
  "type": "OAUTH2",
  "pieceName": "<string>",
  "projectIds": [
    "<string>"
  ],
  "scope": "PROJECT",
  "status": "ACTIVE",
  "platformId": "<string>",
  "ownerId": "<string>",
  "owner": {
    "id": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "status": "ACTIVE",
    "platformRole": "ADMIN",
    "lastName": "<string>",
    "created": "<string>",
    "updated": "<string>",
    "externalId": "<string>",
    "lastChangelogDismissed": "<string>",
    "platformId": "<string>"
  },
  "metadata": {},
  "flowIds": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

Use your api key generated from the admin console

Body

application/json
displayName
string
required
pieceName
string
required
type
enum<string>
required
Available options:
SECRET_TEXT
value
object
required
scope
enum<string>
required
Available options:
PLATFORM
projectIds
string[]
required
metadata
object
externalId
string

Response

201 - application/json

App connection is a connection to an external app.

App connection is a connection to an external app.

id
string
required
created
string
required
updated
string
required
externalId
string
required
displayName
string
required
type
required
Available options:
OAUTH2
pieceName
string
required
projectIds
string[]
required
Pattern: ^[0-9a-zA-Z]{21}$
scope
required
Available options:
PROJECT
status
required
Available options:
ACTIVE
platformId
string | null
ownerId
string | null
owner
object | null
metadata
object | null
flowIds
string[] | null
Pattern: ^[0-9a-zA-Z]{21}$