Update Tenant
curl --request PUT \
--url https://platform.groundforge.ai/v1/tenants/{tenant_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"securityProfile": {
"tenantId": "<string>",
"isolationMode": "pooled",
"complianceProfile": "<string>",
"dataResidencyRegion": "<string>",
"retentionPolicyDays": 123,
"auditRetentionDays": 123,
"containsPhi": false,
"containsPii": false,
"kmsKeyRef": "<string>",
"auditLevel": "<string>",
"dataClassification": "confidential"
},
"metadata": {}
}
'import requests
url = "https://platform.groundforge.ai/v1/tenants/{tenant_id}"
payload = {
"name": "<string>",
"securityProfile": {
"tenantId": "<string>",
"isolationMode": "pooled",
"complianceProfile": "<string>",
"dataResidencyRegion": "<string>",
"retentionPolicyDays": 123,
"auditRetentionDays": 123,
"containsPhi": False,
"containsPii": False,
"kmsKeyRef": "<string>",
"auditLevel": "<string>",
"dataClassification": "confidential"
},
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
securityProfile: {
tenantId: '<string>',
isolationMode: 'pooled',
complianceProfile: '<string>',
dataResidencyRegion: '<string>',
retentionPolicyDays: 123,
auditRetentionDays: 123,
containsPhi: false,
containsPii: false,
kmsKeyRef: '<string>',
auditLevel: '<string>',
dataClassification: 'confidential'
},
metadata: {}
})
};
fetch('https://platform.groundforge.ai/v1/tenants/{tenant_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://platform.groundforge.ai/v1/tenants/{tenant_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'securityProfile' => [
'tenantId' => '<string>',
'isolationMode' => 'pooled',
'complianceProfile' => '<string>',
'dataResidencyRegion' => '<string>',
'retentionPolicyDays' => 123,
'auditRetentionDays' => 123,
'containsPhi' => false,
'containsPii' => false,
'kmsKeyRef' => '<string>',
'auditLevel' => '<string>',
'dataClassification' => 'confidential'
],
'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://platform.groundforge.ai/v1/tenants/{tenant_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"securityProfile\": {\n \"tenantId\": \"<string>\",\n \"isolationMode\": \"pooled\",\n \"complianceProfile\": \"<string>\",\n \"dataResidencyRegion\": \"<string>\",\n \"retentionPolicyDays\": 123,\n \"auditRetentionDays\": 123,\n \"containsPhi\": false,\n \"containsPii\": false,\n \"kmsKeyRef\": \"<string>\",\n \"auditLevel\": \"<string>\",\n \"dataClassification\": \"confidential\"\n },\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PUT", 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.put("https://platform.groundforge.ai/v1/tenants/{tenant_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"securityProfile\": {\n \"tenantId\": \"<string>\",\n \"isolationMode\": \"pooled\",\n \"complianceProfile\": \"<string>\",\n \"dataResidencyRegion\": \"<string>\",\n \"retentionPolicyDays\": 123,\n \"auditRetentionDays\": 123,\n \"containsPhi\": false,\n \"containsPii\": false,\n \"kmsKeyRef\": \"<string>\",\n \"auditLevel\": \"<string>\",\n \"dataClassification\": \"confidential\"\n },\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.groundforge.ai/v1/tenants/{tenant_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"securityProfile\": {\n \"tenantId\": \"<string>\",\n \"isolationMode\": \"pooled\",\n \"complianceProfile\": \"<string>\",\n \"dataResidencyRegion\": \"<string>\",\n \"retentionPolicyDays\": 123,\n \"auditRetentionDays\": 123,\n \"containsPhi\": false,\n \"containsPii\": false,\n \"kmsKeyRef\": \"<string>\",\n \"auditLevel\": \"<string>\",\n \"dataClassification\": \"confidential\"\n },\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}PUT
/
v1
/
tenants
/
{tenant_id}
Update Tenant
curl --request PUT \
--url https://platform.groundforge.ai/v1/tenants/{tenant_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"securityProfile": {
"tenantId": "<string>",
"isolationMode": "pooled",
"complianceProfile": "<string>",
"dataResidencyRegion": "<string>",
"retentionPolicyDays": 123,
"auditRetentionDays": 123,
"containsPhi": false,
"containsPii": false,
"kmsKeyRef": "<string>",
"auditLevel": "<string>",
"dataClassification": "confidential"
},
"metadata": {}
}
'import requests
url = "https://platform.groundforge.ai/v1/tenants/{tenant_id}"
payload = {
"name": "<string>",
"securityProfile": {
"tenantId": "<string>",
"isolationMode": "pooled",
"complianceProfile": "<string>",
"dataResidencyRegion": "<string>",
"retentionPolicyDays": 123,
"auditRetentionDays": 123,
"containsPhi": False,
"containsPii": False,
"kmsKeyRef": "<string>",
"auditLevel": "<string>",
"dataClassification": "confidential"
},
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
securityProfile: {
tenantId: '<string>',
isolationMode: 'pooled',
complianceProfile: '<string>',
dataResidencyRegion: '<string>',
retentionPolicyDays: 123,
auditRetentionDays: 123,
containsPhi: false,
containsPii: false,
kmsKeyRef: '<string>',
auditLevel: '<string>',
dataClassification: 'confidential'
},
metadata: {}
})
};
fetch('https://platform.groundforge.ai/v1/tenants/{tenant_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://platform.groundforge.ai/v1/tenants/{tenant_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'securityProfile' => [
'tenantId' => '<string>',
'isolationMode' => 'pooled',
'complianceProfile' => '<string>',
'dataResidencyRegion' => '<string>',
'retentionPolicyDays' => 123,
'auditRetentionDays' => 123,
'containsPhi' => false,
'containsPii' => false,
'kmsKeyRef' => '<string>',
'auditLevel' => '<string>',
'dataClassification' => 'confidential'
],
'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://platform.groundforge.ai/v1/tenants/{tenant_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"securityProfile\": {\n \"tenantId\": \"<string>\",\n \"isolationMode\": \"pooled\",\n \"complianceProfile\": \"<string>\",\n \"dataResidencyRegion\": \"<string>\",\n \"retentionPolicyDays\": 123,\n \"auditRetentionDays\": 123,\n \"containsPhi\": false,\n \"containsPii\": false,\n \"kmsKeyRef\": \"<string>\",\n \"auditLevel\": \"<string>\",\n \"dataClassification\": \"confidential\"\n },\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PUT", 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.put("https://platform.groundforge.ai/v1/tenants/{tenant_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"securityProfile\": {\n \"tenantId\": \"<string>\",\n \"isolationMode\": \"pooled\",\n \"complianceProfile\": \"<string>\",\n \"dataResidencyRegion\": \"<string>\",\n \"retentionPolicyDays\": 123,\n \"auditRetentionDays\": 123,\n \"containsPhi\": false,\n \"containsPii\": false,\n \"kmsKeyRef\": \"<string>\",\n \"auditLevel\": \"<string>\",\n \"dataClassification\": \"confidential\"\n },\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.groundforge.ai/v1/tenants/{tenant_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"securityProfile\": {\n \"tenantId\": \"<string>\",\n \"isolationMode\": \"pooled\",\n \"complianceProfile\": \"<string>\",\n \"dataResidencyRegion\": \"<string>\",\n \"retentionPolicyDays\": 123,\n \"auditRetentionDays\": 123,\n \"containsPhi\": false,\n \"containsPii\": false,\n \"kmsKeyRef\": \"<string>\",\n \"auditLevel\": \"<string>\",\n \"dataClassification\": \"confidential\"\n },\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
bearerAuthapiKeyAuth
OIDC access token for users and CLI clients.
Path Parameters
Body
application/json
Response
Successful Response
Last modified on July 29, 2026
⌘I

