Add entities to workspace
curl --request POST \
--url https://app.blinkops.com/api/v1/workspaces/{ws_id}/entities \
--header 'BLINK-API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"entities": [
{
"entity_id": "<string>",
"name": "<string>",
"role": "<string>"
}
]
}
'import requests
url = "https://app.blinkops.com/api/v1/workspaces/{ws_id}/entities"
payload = { "entities": [
{
"entity_id": "<string>",
"name": "<string>",
"role": "<string>"
}
] }
headers = {
"BLINK-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'BLINK-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({entities: [{entity_id: '<string>', name: '<string>', role: '<string>'}]})
};
fetch('https://app.blinkops.com/api/v1/workspaces/{ws_id}/entities', 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/workspaces/{ws_id}/entities",
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([
'entities' => [
[
'entity_id' => '<string>',
'name' => '<string>',
'role' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"BLINK-API-KEY: <api-key>",
"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://app.blinkops.com/api/v1/workspaces/{ws_id}/entities"
payload := strings.NewReader("{\n \"entities\": [\n {\n \"entity_id\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("BLINK-API-KEY", "<api-key>")
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://app.blinkops.com/api/v1/workspaces/{ws_id}/entities")
.header("BLINK-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"entities\": [\n {\n \"entity_id\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.blinkops.com/api/v1/workspaces/{ws_id}/entities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["BLINK-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entities\": [\n {\n \"entity_id\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyThis response has no body data.{
"data": {},
"details": "<string>",
"identifier": "<string>",
"message": "<string>",
"status": 404,
"user_error": {}
}Workspaces
Add entities to workspace
API endpoint to add entities such as users or groups to a Blink workspace.
POST
/
workspaces
/
{ws_id}
/
entities
Add entities to workspace
curl --request POST \
--url https://app.blinkops.com/api/v1/workspaces/{ws_id}/entities \
--header 'BLINK-API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"entities": [
{
"entity_id": "<string>",
"name": "<string>",
"role": "<string>"
}
]
}
'import requests
url = "https://app.blinkops.com/api/v1/workspaces/{ws_id}/entities"
payload = { "entities": [
{
"entity_id": "<string>",
"name": "<string>",
"role": "<string>"
}
] }
headers = {
"BLINK-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'BLINK-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({entities: [{entity_id: '<string>', name: '<string>', role: '<string>'}]})
};
fetch('https://app.blinkops.com/api/v1/workspaces/{ws_id}/entities', 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/workspaces/{ws_id}/entities",
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([
'entities' => [
[
'entity_id' => '<string>',
'name' => '<string>',
'role' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"BLINK-API-KEY: <api-key>",
"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://app.blinkops.com/api/v1/workspaces/{ws_id}/entities"
payload := strings.NewReader("{\n \"entities\": [\n {\n \"entity_id\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("BLINK-API-KEY", "<api-key>")
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://app.blinkops.com/api/v1/workspaces/{ws_id}/entities")
.header("BLINK-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"entities\": [\n {\n \"entity_id\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.blinkops.com/api/v1/workspaces/{ws_id}/entities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["BLINK-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entities\": [\n {\n \"entity_id\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyThis response has no body data.{
"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.
Path Parameters
Workspace ID
Body
application/json
Entity list
Show child attributes
Show child attributes
Response
Was this page helpful?
⌘I