Update API group security settings
Update security settings for an API group. Configure access permissions and authentication requirements.
Authentication: required
PUT
/
workspace
/
{workspace_id}
/
apigroup
/
{apigroup_id}
/
security
Update API group security settings
curl --request PUT \
--url https://your-xano-instance.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/security \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"guid": "<string>",
"canonical": "<string>",
"include_xanoscript": true
}
'import requests
url = "https://your-xano-instance.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/security"
payload = {
"guid": "<string>",
"canonical": "<string>",
"include_xanoscript": True
}
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({guid: '<string>', canonical: '<string>', include_xanoscript: true})
};
fetch('https://your-xano-instance.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/security', 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://your-xano-instance.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/security",
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([
'guid' => '<string>',
'canonical' => '<string>',
'include_xanoscript' => true
]),
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://your-xano-instance.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/security"
payload := strings.NewReader("{\n \"guid\": \"<string>\",\n \"canonical\": \"<string>\",\n \"include_xanoscript\": true\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://your-xano-instance.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/security")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"guid\": \"<string>\",\n \"canonical\": \"<string>\",\n \"include_xanoscript\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-xano-instance.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/security")
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 \"guid\": \"<string>\",\n \"canonical\": \"<string>\",\n \"include_xanoscript\": true\n}"
response = http.request(request)
puts response.read_body{
"id": 1,
"created_at": "2023-04-19 21:01:32+0000",
"updated_at": "2023-04-19 21:01:32+0000",
"name": "API Group Test",
"description": "My API groups description",
"docs": "Documentation",
"guid": "YE1fwVhQ-enRlc6Sb42Gqru58-0",
"canonical": "FRzyRdY0",
"swagger": true,
"documentation": {
"link": "<string>"
},
"branch": "v1",
"tag": [
"example tag"
],
"xanoscript": {
"value": "<string>",
"message": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/jsonmultipart/form-data
Response
Success!
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Related topics
Update security settings for an API group. Configure access permissions and authentication requirements.Update API endpoint security settingsUpdate an API groupWas this page helpful?
⌘I
Update API group security settings
curl --request PUT \
--url https://your-xano-instance.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/security \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"guid": "<string>",
"canonical": "<string>",
"include_xanoscript": true
}
'import requests
url = "https://your-xano-instance.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/security"
payload = {
"guid": "<string>",
"canonical": "<string>",
"include_xanoscript": True
}
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({guid: '<string>', canonical: '<string>', include_xanoscript: true})
};
fetch('https://your-xano-instance.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/security', 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://your-xano-instance.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/security",
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([
'guid' => '<string>',
'canonical' => '<string>',
'include_xanoscript' => true
]),
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://your-xano-instance.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/security"
payload := strings.NewReader("{\n \"guid\": \"<string>\",\n \"canonical\": \"<string>\",\n \"include_xanoscript\": true\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://your-xano-instance.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/security")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"guid\": \"<string>\",\n \"canonical\": \"<string>\",\n \"include_xanoscript\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-xano-instance.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/security")
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 \"guid\": \"<string>\",\n \"canonical\": \"<string>\",\n \"include_xanoscript\": true\n}"
response = http.request(request)
puts response.read_body{
"id": 1,
"created_at": "2023-04-19 21:01:32+0000",
"updated_at": "2023-04-19 21:01:32+0000",
"name": "API Group Test",
"description": "My API groups description",
"docs": "Documentation",
"guid": "YE1fwVhQ-enRlc6Sb42Gqru58-0",
"canonical": "FRzyRdY0",
"swagger": true,
"documentation": {
"link": "<string>"
},
"branch": "v1",
"tag": [
"example tag"
],
"xanoscript": {
"value": "<string>",
"message": "<string>"
}
}