cURL
curl --request PATCH \
--url https://api.example.com/api/apps/{app_id}/collections/{collection_id} \
--header 'Content-Type: application/json' \
--data '
{
"api_config": {
"authentication": "None",
"base_url": "<string>",
"query_mapping": {
"field_mappings": {},
"method": "<string>",
"path_template": "<string>"
},
"response_mapping": {
"field_mappings": {},
"records_path": "<string>"
}
},
"collection_type": "<string>",
"default_sort_column": "<string>",
"description": "<string>",
"public": true,
"retention_days": 1
}
'import requests
url = "https://api.example.com/api/apps/{app_id}/collections/{collection_id}"
payload = {
"api_config": {
"authentication": "None",
"base_url": "<string>",
"query_mapping": {
"field_mappings": {},
"method": "<string>",
"path_template": "<string>"
},
"response_mapping": {
"field_mappings": {},
"records_path": "<string>"
}
},
"collection_type": "<string>",
"default_sort_column": "<string>",
"description": "<string>",
"public": True,
"retention_days": 1
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
api_config: {
authentication: 'None',
base_url: '<string>',
query_mapping: {field_mappings: {}, method: '<string>', path_template: '<string>'},
response_mapping: {field_mappings: {}, records_path: '<string>'}
},
collection_type: '<string>',
default_sort_column: '<string>',
description: '<string>',
public: true,
retention_days: 1
})
};
fetch('https://api.example.com/api/apps/{app_id}/collections/{collection_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://api.example.com/api/apps/{app_id}/collections/{collection_id}",
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([
'api_config' => [
'authentication' => 'None',
'base_url' => '<string>',
'query_mapping' => [
'field_mappings' => [
],
'method' => '<string>',
'path_template' => '<string>'
],
'response_mapping' => [
'field_mappings' => [
],
'records_path' => '<string>'
]
],
'collection_type' => '<string>',
'default_sort_column' => '<string>',
'description' => '<string>',
'public' => true,
'retention_days' => 1
]),
CURLOPT_HTTPHEADER => [
"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://api.example.com/api/apps/{app_id}/collections/{collection_id}"
payload := strings.NewReader("{\n \"api_config\": {\n \"authentication\": \"None\",\n \"base_url\": \"<string>\",\n \"query_mapping\": {\n \"field_mappings\": {},\n \"method\": \"<string>\",\n \"path_template\": \"<string>\"\n },\n \"response_mapping\": {\n \"field_mappings\": {},\n \"records_path\": \"<string>\"\n }\n },\n \"collection_type\": \"<string>\",\n \"default_sort_column\": \"<string>\",\n \"description\": \"<string>\",\n \"public\": true,\n \"retention_days\": 1\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.example.com/api/apps/{app_id}/collections/{collection_id}")
.header("Content-Type", "application/json")
.body("{\n \"api_config\": {\n \"authentication\": \"None\",\n \"base_url\": \"<string>\",\n \"query_mapping\": {\n \"field_mappings\": {},\n \"method\": \"<string>\",\n \"path_template\": \"<string>\"\n },\n \"response_mapping\": {\n \"field_mappings\": {},\n \"records_path\": \"<string>\"\n }\n },\n \"collection_type\": \"<string>\",\n \"default_sort_column\": \"<string>\",\n \"description\": \"<string>\",\n \"public\": true,\n \"retention_days\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/apps/{app_id}/collections/{collection_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"api_config\": {\n \"authentication\": \"None\",\n \"base_url\": \"<string>\",\n \"query_mapping\": {\n \"field_mappings\": {},\n \"method\": \"<string>\",\n \"path_template\": \"<string>\"\n },\n \"response_mapping\": {\n \"field_mappings\": {},\n \"records_path\": \"<string>\"\n }\n },\n \"collection_type\": \"<string>\",\n \"default_sort_column\": \"<string>\",\n \"description\": \"<string>\",\n \"public\": true,\n \"retention_days\": 1\n}"
response = http.request(request)
puts response.read_bodyCollections
Patch apiapps collections
PATCH
/
api
/
apps
/
{app_id}
/
collections
/
{collection_id}
cURL
curl --request PATCH \
--url https://api.example.com/api/apps/{app_id}/collections/{collection_id} \
--header 'Content-Type: application/json' \
--data '
{
"api_config": {
"authentication": "None",
"base_url": "<string>",
"query_mapping": {
"field_mappings": {},
"method": "<string>",
"path_template": "<string>"
},
"response_mapping": {
"field_mappings": {},
"records_path": "<string>"
}
},
"collection_type": "<string>",
"default_sort_column": "<string>",
"description": "<string>",
"public": true,
"retention_days": 1
}
'import requests
url = "https://api.example.com/api/apps/{app_id}/collections/{collection_id}"
payload = {
"api_config": {
"authentication": "None",
"base_url": "<string>",
"query_mapping": {
"field_mappings": {},
"method": "<string>",
"path_template": "<string>"
},
"response_mapping": {
"field_mappings": {},
"records_path": "<string>"
}
},
"collection_type": "<string>",
"default_sort_column": "<string>",
"description": "<string>",
"public": True,
"retention_days": 1
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
api_config: {
authentication: 'None',
base_url: '<string>',
query_mapping: {field_mappings: {}, method: '<string>', path_template: '<string>'},
response_mapping: {field_mappings: {}, records_path: '<string>'}
},
collection_type: '<string>',
default_sort_column: '<string>',
description: '<string>',
public: true,
retention_days: 1
})
};
fetch('https://api.example.com/api/apps/{app_id}/collections/{collection_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://api.example.com/api/apps/{app_id}/collections/{collection_id}",
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([
'api_config' => [
'authentication' => 'None',
'base_url' => '<string>',
'query_mapping' => [
'field_mappings' => [
],
'method' => '<string>',
'path_template' => '<string>'
],
'response_mapping' => [
'field_mappings' => [
],
'records_path' => '<string>'
]
],
'collection_type' => '<string>',
'default_sort_column' => '<string>',
'description' => '<string>',
'public' => true,
'retention_days' => 1
]),
CURLOPT_HTTPHEADER => [
"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://api.example.com/api/apps/{app_id}/collections/{collection_id}"
payload := strings.NewReader("{\n \"api_config\": {\n \"authentication\": \"None\",\n \"base_url\": \"<string>\",\n \"query_mapping\": {\n \"field_mappings\": {},\n \"method\": \"<string>\",\n \"path_template\": \"<string>\"\n },\n \"response_mapping\": {\n \"field_mappings\": {},\n \"records_path\": \"<string>\"\n }\n },\n \"collection_type\": \"<string>\",\n \"default_sort_column\": \"<string>\",\n \"description\": \"<string>\",\n \"public\": true,\n \"retention_days\": 1\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.example.com/api/apps/{app_id}/collections/{collection_id}")
.header("Content-Type", "application/json")
.body("{\n \"api_config\": {\n \"authentication\": \"None\",\n \"base_url\": \"<string>\",\n \"query_mapping\": {\n \"field_mappings\": {},\n \"method\": \"<string>\",\n \"path_template\": \"<string>\"\n },\n \"response_mapping\": {\n \"field_mappings\": {},\n \"records_path\": \"<string>\"\n }\n },\n \"collection_type\": \"<string>\",\n \"default_sort_column\": \"<string>\",\n \"description\": \"<string>\",\n \"public\": true,\n \"retention_days\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/apps/{app_id}/collections/{collection_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"api_config\": {\n \"authentication\": \"None\",\n \"base_url\": \"<string>\",\n \"query_mapping\": {\n \"field_mappings\": {},\n \"method\": \"<string>\",\n \"path_template\": \"<string>\"\n },\n \"response_mapping\": {\n \"field_mappings\": {},\n \"records_path\": \"<string>\"\n }\n },\n \"collection_type\": \"<string>\",\n \"default_sort_column\": \"<string>\",\n \"description\": \"<string>\",\n \"public\": true,\n \"retention_days\": 1\n}"
response = http.request(request)
puts response.read_bodyBody
application/json
Update collection properties PATCH /api/apps/:app_id/collections/:collection_name
API configuration (for API and Hybrid collections)
Show child attributes
Show child attributes
Collection type: "local", "offline", "api", or "hybrid"
Default sort column
Collection description
Whether the collection is publicly accessible through auto-generated endpoints
Data retention period in days (None = permanent)
Required range:
x >= 0Response
Collection updated successfully
⌘I