Workspace
Update the current workspace settings
PATCH
/
api
/
v1
/
workspace
Update the current workspace settings
curl --request PATCH \
--url https://api.esheria.ai/api/v1/workspace \
--header 'Content-Type: application/json' \
--header 'idempotency-key: <idempotency-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"billing_contact_email": "billing@acme.example",
"display_name": "Acme Compliance",
"metadata": {
"dashboard_updated_by": "ops@acme.example"
},
"pack_entitlements": [
"UK-DATA-PROTECTION-PRIVACY",
"EU-GDPR-DATA-PROTECTION"
]
}
'import requests
url = "https://api.esheria.ai/api/v1/workspace"
payload = {
"billing_contact_email": "billing@acme.example",
"display_name": "Acme Compliance",
"metadata": { "dashboard_updated_by": "ops@acme.example" },
"pack_entitlements": ["UK-DATA-PROTECTION-PRIVACY", "EU-GDPR-DATA-PROTECTION"]
}
headers = {
"idempotency-key": "<idempotency-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'idempotency-key': '<idempotency-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
billing_contact_email: 'billing@acme.example',
display_name: 'Acme Compliance',
metadata: {dashboard_updated_by: 'ops@acme.example'},
pack_entitlements: ['UK-DATA-PROTECTION-PRIVACY', 'EU-GDPR-DATA-PROTECTION']
})
};
fetch('https://api.esheria.ai/api/v1/workspace', 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.esheria.ai/api/v1/workspace",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'billing_contact_email' => 'billing@acme.example',
'display_name' => 'Acme Compliance',
'metadata' => [
'dashboard_updated_by' => 'ops@acme.example'
],
'pack_entitlements' => [
'UK-DATA-PROTECTION-PRIVACY',
'EU-GDPR-DATA-PROTECTION'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"idempotency-key: <idempotency-key>",
"x-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.esheria.ai/api/v1/workspace"
payload := strings.NewReader("{\n \"billing_contact_email\": \"billing@acme.example\",\n \"display_name\": \"Acme Compliance\",\n \"metadata\": {\n \"dashboard_updated_by\": \"ops@acme.example\"\n },\n \"pack_entitlements\": [\n \"UK-DATA-PROTECTION-PRIVACY\",\n \"EU-GDPR-DATA-PROTECTION\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("idempotency-key", "<idempotency-key>")
req.Header.Add("x-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.patch("https://api.esheria.ai/api/v1/workspace")
.header("idempotency-key", "<idempotency-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"billing_contact_email\": \"billing@acme.example\",\n \"display_name\": \"Acme Compliance\",\n \"metadata\": {\n \"dashboard_updated_by\": \"ops@acme.example\"\n },\n \"pack_entitlements\": [\n \"UK-DATA-PROTECTION-PRIVACY\",\n \"EU-GDPR-DATA-PROTECTION\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.esheria.ai/api/v1/workspace")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["idempotency-key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"billing_contact_email\": \"billing@acme.example\",\n \"display_name\": \"Acme Compliance\",\n \"metadata\": {\n \"dashboard_updated_by\": \"ops@acme.example\"\n },\n \"pack_entitlements\": [\n \"UK-DATA-PROTECTION-PRIVACY\",\n \"EU-GDPR-DATA-PROTECTION\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "error",
"errors": [
{
"code": "unauthorized",
"message": "Invalid API key"
}
],
"trace_id": "trace-123"
}{
"status": "error",
"errors": [
{
"code": "credits_exhausted",
"message": "API credits exhausted"
}
],
"trace_id": "trace-123"
}{
"status": "error",
"errors": [
{
"code": "duplicate_token_name",
"message": "An active data token already uses that name."
}
],
"trace_id": "trace-123"
}{
"status": "error",
"errors": [
{
"code": "validation_error",
"message": "Invalid payload",
"field": "body.name"
}
],
"trace_id": "trace-123"
}{
"status": "error",
"errors": [
{
"code": "billing_unavailable",
"message": "Billing ledger is unavailable"
}
],
"trace_id": "trace-123"
}Authorizations
Client API key issued by Esheria.
Headers
Unique key for mutating request replay protection.
Body
application/json
Response
Successful Response
⌘I
Update the current workspace settings
curl --request PATCH \
--url https://api.esheria.ai/api/v1/workspace \
--header 'Content-Type: application/json' \
--header 'idempotency-key: <idempotency-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"billing_contact_email": "billing@acme.example",
"display_name": "Acme Compliance",
"metadata": {
"dashboard_updated_by": "ops@acme.example"
},
"pack_entitlements": [
"UK-DATA-PROTECTION-PRIVACY",
"EU-GDPR-DATA-PROTECTION"
]
}
'import requests
url = "https://api.esheria.ai/api/v1/workspace"
payload = {
"billing_contact_email": "billing@acme.example",
"display_name": "Acme Compliance",
"metadata": { "dashboard_updated_by": "ops@acme.example" },
"pack_entitlements": ["UK-DATA-PROTECTION-PRIVACY", "EU-GDPR-DATA-PROTECTION"]
}
headers = {
"idempotency-key": "<idempotency-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'idempotency-key': '<idempotency-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
billing_contact_email: 'billing@acme.example',
display_name: 'Acme Compliance',
metadata: {dashboard_updated_by: 'ops@acme.example'},
pack_entitlements: ['UK-DATA-PROTECTION-PRIVACY', 'EU-GDPR-DATA-PROTECTION']
})
};
fetch('https://api.esheria.ai/api/v1/workspace', 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.esheria.ai/api/v1/workspace",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'billing_contact_email' => 'billing@acme.example',
'display_name' => 'Acme Compliance',
'metadata' => [
'dashboard_updated_by' => 'ops@acme.example'
],
'pack_entitlements' => [
'UK-DATA-PROTECTION-PRIVACY',
'EU-GDPR-DATA-PROTECTION'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"idempotency-key: <idempotency-key>",
"x-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.esheria.ai/api/v1/workspace"
payload := strings.NewReader("{\n \"billing_contact_email\": \"billing@acme.example\",\n \"display_name\": \"Acme Compliance\",\n \"metadata\": {\n \"dashboard_updated_by\": \"ops@acme.example\"\n },\n \"pack_entitlements\": [\n \"UK-DATA-PROTECTION-PRIVACY\",\n \"EU-GDPR-DATA-PROTECTION\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("idempotency-key", "<idempotency-key>")
req.Header.Add("x-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.patch("https://api.esheria.ai/api/v1/workspace")
.header("idempotency-key", "<idempotency-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"billing_contact_email\": \"billing@acme.example\",\n \"display_name\": \"Acme Compliance\",\n \"metadata\": {\n \"dashboard_updated_by\": \"ops@acme.example\"\n },\n \"pack_entitlements\": [\n \"UK-DATA-PROTECTION-PRIVACY\",\n \"EU-GDPR-DATA-PROTECTION\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.esheria.ai/api/v1/workspace")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["idempotency-key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"billing_contact_email\": \"billing@acme.example\",\n \"display_name\": \"Acme Compliance\",\n \"metadata\": {\n \"dashboard_updated_by\": \"ops@acme.example\"\n },\n \"pack_entitlements\": [\n \"UK-DATA-PROTECTION-PRIVACY\",\n \"EU-GDPR-DATA-PROTECTION\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "error",
"errors": [
{
"code": "unauthorized",
"message": "Invalid API key"
}
],
"trace_id": "trace-123"
}{
"status": "error",
"errors": [
{
"code": "credits_exhausted",
"message": "API credits exhausted"
}
],
"trace_id": "trace-123"
}{
"status": "error",
"errors": [
{
"code": "duplicate_token_name",
"message": "An active data token already uses that name."
}
],
"trace_id": "trace-123"
}{
"status": "error",
"errors": [
{
"code": "validation_error",
"message": "Invalid payload",
"field": "body.name"
}
],
"trace_id": "trace-123"
}{
"status": "error",
"errors": [
{
"code": "billing_unavailable",
"message": "Billing ledger is unavailable"
}
],
"trace_id": "trace-123"
}