cURL
curl --request POST \
--url https://cloud.nrai.io/api/v1/app-connections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalId": "<string>",
"displayName": "<string>",
"pieceName": "<string>",
"projectId": "<string>",
"type": "SECRET_TEXT",
"value": {
"type": "SECRET_TEXT",
"secret_text": "<string>"
},
"metadata": {}
}
'import requests
url = "https://cloud.nrai.io/api/v1/app-connections"
payload = {
"externalId": "<string>",
"displayName": "<string>",
"pieceName": "<string>",
"projectId": "<string>",
"type": "SECRET_TEXT",
"value": {
"type": "SECRET_TEXT",
"secret_text": "<string>"
},
"metadata": {}
}
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({
externalId: '<string>',
displayName: '<string>',
pieceName: '<string>',
projectId: '<string>',
type: 'SECRET_TEXT',
value: {type: 'SECRET_TEXT', secret_text: '<string>'},
metadata: {}
})
};
fetch('https://cloud.nrai.io/api/v1/app-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/app-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([
'externalId' => '<string>',
'displayName' => '<string>',
'pieceName' => '<string>',
'projectId' => '<string>',
'type' => 'SECRET_TEXT',
'value' => [
'type' => 'SECRET_TEXT',
'secret_text' => '<string>'
],
'metadata' => [
]
]),
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/app-connections"
payload := strings.NewReader("{\n \"externalId\": \"<string>\",\n \"displayName\": \"<string>\",\n \"pieceName\": \"<string>\",\n \"projectId\": \"<string>\",\n \"type\": \"SECRET_TEXT\",\n \"value\": {\n \"type\": \"SECRET_TEXT\",\n \"secret_text\": \"<string>\"\n },\n \"metadata\": {}\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/app-connections")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"externalId\": \"<string>\",\n \"displayName\": \"<string>\",\n \"pieceName\": \"<string>\",\n \"projectId\": \"<string>\",\n \"type\": \"SECRET_TEXT\",\n \"value\": {\n \"type\": \"SECRET_TEXT\",\n \"secret_text\": \"<string>\"\n },\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.nrai.io/api/v1/app-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 \"externalId\": \"<string>\",\n \"displayName\": \"<string>\",\n \"pieceName\": \"<string>\",\n \"projectId\": \"<string>\",\n \"type\": \"SECRET_TEXT\",\n \"value\": {\n \"type\": \"SECRET_TEXT\",\n \"secret_text\": \"<string>\"\n },\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_bodyConnections
Upsert Connection
Upsert an app connection based on the app name
POST
/
v1
/
app-connections
cURL
curl --request POST \
--url https://cloud.nrai.io/api/v1/app-connections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalId": "<string>",
"displayName": "<string>",
"pieceName": "<string>",
"projectId": "<string>",
"type": "SECRET_TEXT",
"value": {
"type": "SECRET_TEXT",
"secret_text": "<string>"
},
"metadata": {}
}
'import requests
url = "https://cloud.nrai.io/api/v1/app-connections"
payload = {
"externalId": "<string>",
"displayName": "<string>",
"pieceName": "<string>",
"projectId": "<string>",
"type": "SECRET_TEXT",
"value": {
"type": "SECRET_TEXT",
"secret_text": "<string>"
},
"metadata": {}
}
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({
externalId: '<string>',
displayName: '<string>',
pieceName: '<string>',
projectId: '<string>',
type: 'SECRET_TEXT',
value: {type: 'SECRET_TEXT', secret_text: '<string>'},
metadata: {}
})
};
fetch('https://cloud.nrai.io/api/v1/app-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/app-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([
'externalId' => '<string>',
'displayName' => '<string>',
'pieceName' => '<string>',
'projectId' => '<string>',
'type' => 'SECRET_TEXT',
'value' => [
'type' => 'SECRET_TEXT',
'secret_text' => '<string>'
],
'metadata' => [
]
]),
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/app-connections"
payload := strings.NewReader("{\n \"externalId\": \"<string>\",\n \"displayName\": \"<string>\",\n \"pieceName\": \"<string>\",\n \"projectId\": \"<string>\",\n \"type\": \"SECRET_TEXT\",\n \"value\": {\n \"type\": \"SECRET_TEXT\",\n \"secret_text\": \"<string>\"\n },\n \"metadata\": {}\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/app-connections")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"externalId\": \"<string>\",\n \"displayName\": \"<string>\",\n \"pieceName\": \"<string>\",\n \"projectId\": \"<string>\",\n \"type\": \"SECRET_TEXT\",\n \"value\": {\n \"type\": \"SECRET_TEXT\",\n \"secret_text\": \"<string>\"\n },\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.nrai.io/api/v1/app-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 \"externalId\": \"<string>\",\n \"displayName\": \"<string>\",\n \"pieceName\": \"<string>\",\n \"projectId\": \"<string>\",\n \"type\": \"SECRET_TEXT\",\n \"value\": {\n \"type\": \"SECRET_TEXT\",\n \"secret_text\": \"<string>\"\n },\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Use your api key generated from the admin console
Body
application/json
- Secret Text
- OAuth2
- Cloud OAuth2
- Platform OAuth2
- Basic Auth
- Custom Auth
- No Auth
Secret Text
Response
200
Default Response
⌘I