Gets a Connection by id
curl --request GET \
--url https://app.blinkops.com/api/v1/workspace/{ws_id}/connections/{id} \
--header 'BLINK-API-KEY: <api-key>'import requests
url = "https://app.blinkops.com/api/v1/workspace/{ws_id}/connections/{id}"
headers = {"BLINK-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'BLINK-API-KEY': '<api-key>'}};
fetch('https://app.blinkops.com/api/v1/workspace/{ws_id}/connections/{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://app.blinkops.com/api/v1/workspace/{ws_id}/connections/{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 => [
"BLINK-API-KEY: <api-key>"
],
]);
$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://app.blinkops.com/api/v1/workspace/{ws_id}/connections/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("BLINK-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.blinkops.com/api/v1/workspace/{ws_id}/connections/{id}")
.header("BLINK-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.blinkops.com/api/v1/workspace/{ws_id}/connections/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["BLINK-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"attributes": {},
"connection_type_id": "<string>",
"created_at": 123,
"created_by": "<string>",
"created_with_o_auth": true,
"creation_location": "<string>",
"creation_method": "<string>",
"description": "<string>",
"display_name": "<string>",
"external_id": "<string>",
"full_name": "<string>",
"id": "<string>",
"name": "<string>",
"secret_manager": "<string>",
"status": "<string>",
"tenant_id": "<string>",
"updated_at": 123,
"updated_by": "<string>",
"workspace_id": "<string>"
}
]{
"data": {},
"details": "<string>",
"identifier": "<string>",
"message": "<string>",
"status": 404,
"user_error": {}
}Connections
Gets a Connection by id
API endpoint to retrieve a specific connection by its unique identifier in Blink.
GET
/
workspace
/
{ws_id}
/
connections
/
{id}
Gets a Connection by id
curl --request GET \
--url https://app.blinkops.com/api/v1/workspace/{ws_id}/connections/{id} \
--header 'BLINK-API-KEY: <api-key>'import requests
url = "https://app.blinkops.com/api/v1/workspace/{ws_id}/connections/{id}"
headers = {"BLINK-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'BLINK-API-KEY': '<api-key>'}};
fetch('https://app.blinkops.com/api/v1/workspace/{ws_id}/connections/{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://app.blinkops.com/api/v1/workspace/{ws_id}/connections/{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 => [
"BLINK-API-KEY: <api-key>"
],
]);
$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://app.blinkops.com/api/v1/workspace/{ws_id}/connections/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("BLINK-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.blinkops.com/api/v1/workspace/{ws_id}/connections/{id}")
.header("BLINK-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.blinkops.com/api/v1/workspace/{ws_id}/connections/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["BLINK-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"attributes": {},
"connection_type_id": "<string>",
"created_at": 123,
"created_by": "<string>",
"created_with_o_auth": true,
"creation_location": "<string>",
"creation_method": "<string>",
"description": "<string>",
"display_name": "<string>",
"external_id": "<string>",
"full_name": "<string>",
"id": "<string>",
"name": "<string>",
"secret_manager": "<string>",
"status": "<string>",
"tenant_id": "<string>",
"updated_at": 123,
"updated_by": "<string>",
"workspace_id": "<string>"
}
]{
"data": {},
"details": "<string>",
"identifier": "<string>",
"message": "<string>",
"status": 404,
"user_error": {}
}Authorizations
Use your API key to access BlinkOps API. To generate an API key, please log in to your BlinkOps account and navigate to the API Keys section in the user settings page. Add the generated key to your request headers as BLINK-API-KEY.
Response
ok
Show child attributes
Show child attributes
ExternalId mapping to external entity identifier associated with this connection (used on revoke/uninstall events e.g.)
Connection names are unique per tenant as they are used in playbook YAML
Was this page helpful?