Create App Configuration
curl --request POST \
--url https://api.example.com/v1/app-configurations \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"app_name": "<string>",
"security_scheme_overrides": {},
"all_functions_enabled": true,
"enabled_functions": [
"<string>"
]
}
'import requests
url = "https://api.example.com/v1/app-configurations"
payload = {
"app_name": "<string>",
"security_scheme_overrides": {},
"all_functions_enabled": True,
"enabled_functions": ["<string>"]
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
app_name: '<string>',
security_scheme_overrides: {},
all_functions_enabled: true,
enabled_functions: ['<string>']
})
};
fetch('https://api.example.com/v1/app-configurations', 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/v1/app-configurations",
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([
'app_name' => '<string>',
'security_scheme_overrides' => [
],
'all_functions_enabled' => true,
'enabled_functions' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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.example.com/v1/app-configurations"
payload := strings.NewReader("{\n \"app_name\": \"<string>\",\n \"security_scheme_overrides\": {},\n \"all_functions_enabled\": true,\n \"enabled_functions\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("https://api.example.com/v1/app-configurations")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"app_name\": \"<string>\",\n \"security_scheme_overrides\": {},\n \"all_functions_enabled\": true,\n \"enabled_functions\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/app-configurations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"app_name\": \"<string>\",\n \"security_scheme_overrides\": {},\n \"all_functions_enabled\": true,\n \"enabled_functions\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"app_name": "<string>",
"security_scheme": "no_auth",
"security_scheme_overrides": {},
"enabled": true,
"all_functions_enabled": true,
"enabled_functions": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}App Configurations
Create App Configuration
Create an app configuration for a project
POST
/
v1
/
app-configurations
Create App Configuration
curl --request POST \
--url https://api.example.com/v1/app-configurations \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"app_name": "<string>",
"security_scheme_overrides": {},
"all_functions_enabled": true,
"enabled_functions": [
"<string>"
]
}
'import requests
url = "https://api.example.com/v1/app-configurations"
payload = {
"app_name": "<string>",
"security_scheme_overrides": {},
"all_functions_enabled": True,
"enabled_functions": ["<string>"]
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
app_name: '<string>',
security_scheme_overrides: {},
all_functions_enabled: true,
enabled_functions: ['<string>']
})
};
fetch('https://api.example.com/v1/app-configurations', 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/v1/app-configurations",
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([
'app_name' => '<string>',
'security_scheme_overrides' => [
],
'all_functions_enabled' => true,
'enabled_functions' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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.example.com/v1/app-configurations"
payload := strings.NewReader("{\n \"app_name\": \"<string>\",\n \"security_scheme_overrides\": {},\n \"all_functions_enabled\": true,\n \"enabled_functions\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("https://api.example.com/v1/app-configurations")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"app_name\": \"<string>\",\n \"security_scheme_overrides\": {},\n \"all_functions_enabled\": true,\n \"enabled_functions\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/app-configurations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"app_name\": \"<string>\",\n \"security_scheme_overrides\": {},\n \"all_functions_enabled\": true,\n \"enabled_functions\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"app_name": "<string>",
"security_scheme": "no_auth",
"security_scheme_overrides": {},
"enabled": true,
"all_functions_enabled": true,
"enabled_functions": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
API key for authentication
Body
application/json
Create a new app configuration “all_functions_enabled=True” → ignore enabled_functions. “all_functions_enabled=False” AND non-empty enabled_functions → selectively enable that list. “all_functions_enabled=False” AND empty enabled_functions → all functions disabled.
security scheme type for an app (or function if support override)
Available options:
no_auth, api_key, http_basic, http_bearer, oauth2 Response
Successful Response
security scheme type for an app (or function if support override)
Available options:
no_auth, api_key, http_basic, http_bearer, oauth2