curl --request PATCH \
--url https://api.rigbox.dev/api/v1/apps/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"allowed_emails": [
"<string>"
],
"custom_domain": "<string>",
"description": "<string>",
"metadata": "<unknown>",
"name": "<string>",
"port": 1,
"status": "<string>",
"swap_subdomain_with": "<string>"
}
'import requests
url = "https://api.rigbox.dev/api/v1/apps/{id}"
payload = {
"allowed_emails": ["<string>"],
"custom_domain": "<string>",
"description": "<string>",
"metadata": "<unknown>",
"name": "<string>",
"port": 1,
"status": "<string>",
"swap_subdomain_with": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
allowed_emails: ['<string>'],
custom_domain: '<string>',
description: '<string>',
metadata: '<unknown>',
name: '<string>',
port: 1,
status: '<string>',
swap_subdomain_with: '<string>'
})
};
fetch('https://api.rigbox.dev/api/v1/apps/{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.rigbox.dev/api/v1/apps/{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([
'allowed_emails' => [
'<string>'
],
'custom_domain' => '<string>',
'description' => '<string>',
'metadata' => '<unknown>',
'name' => '<string>',
'port' => 1,
'status' => '<string>',
'swap_subdomain_with' => '<string>'
]),
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://api.rigbox.dev/api/v1/apps/{id}"
payload := strings.NewReader("{\n \"allowed_emails\": [\n \"<string>\"\n ],\n \"custom_domain\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": \"<unknown>\",\n \"name\": \"<string>\",\n \"port\": 1,\n \"status\": \"<string>\",\n \"swap_subdomain_with\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.rigbox.dev/api/v1/apps/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"allowed_emails\": [\n \"<string>\"\n ],\n \"custom_domain\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": \"<unknown>\",\n \"name\": \"<string>\",\n \"port\": 1,\n \"status\": \"<string>\",\n \"swap_subdomain_with\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rigbox.dev/api/v1/apps/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"allowed_emails\": [\n \"<string>\"\n ],\n \"custom_domain\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": \"<unknown>\",\n \"name\": \"<string>\",\n \"port\": 1,\n \"status\": \"<string>\",\n \"swap_subdomain_with\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"app": {
"allowed_emails": [
"<string>"
],
"app_kind": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"custom_domain_verified": true,
"depends_on": [
"<string>"
],
"id": "<string>",
"managed": true,
"metadata": "<unknown>",
"name": "<string>",
"node_id": "<string>",
"port": 1,
"protocol": "<string>",
"subdomain": "<string>",
"system_tags": [
"<string>"
],
"updated_at": "2023-11-07T05:31:56Z",
"user_id": "<string>",
"workspace_id": "<string>",
"custom_domain": "<string>",
"description": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}Update App
Update an app’s name, port mapping, or other configuration.
curl --request PATCH \
--url https://api.rigbox.dev/api/v1/apps/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"allowed_emails": [
"<string>"
],
"custom_domain": "<string>",
"description": "<string>",
"metadata": "<unknown>",
"name": "<string>",
"port": 1,
"status": "<string>",
"swap_subdomain_with": "<string>"
}
'import requests
url = "https://api.rigbox.dev/api/v1/apps/{id}"
payload = {
"allowed_emails": ["<string>"],
"custom_domain": "<string>",
"description": "<string>",
"metadata": "<unknown>",
"name": "<string>",
"port": 1,
"status": "<string>",
"swap_subdomain_with": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
allowed_emails: ['<string>'],
custom_domain: '<string>',
description: '<string>',
metadata: '<unknown>',
name: '<string>',
port: 1,
status: '<string>',
swap_subdomain_with: '<string>'
})
};
fetch('https://api.rigbox.dev/api/v1/apps/{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.rigbox.dev/api/v1/apps/{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([
'allowed_emails' => [
'<string>'
],
'custom_domain' => '<string>',
'description' => '<string>',
'metadata' => '<unknown>',
'name' => '<string>',
'port' => 1,
'status' => '<string>',
'swap_subdomain_with' => '<string>'
]),
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://api.rigbox.dev/api/v1/apps/{id}"
payload := strings.NewReader("{\n \"allowed_emails\": [\n \"<string>\"\n ],\n \"custom_domain\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": \"<unknown>\",\n \"name\": \"<string>\",\n \"port\": 1,\n \"status\": \"<string>\",\n \"swap_subdomain_with\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.rigbox.dev/api/v1/apps/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"allowed_emails\": [\n \"<string>\"\n ],\n \"custom_domain\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": \"<unknown>\",\n \"name\": \"<string>\",\n \"port\": 1,\n \"status\": \"<string>\",\n \"swap_subdomain_with\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rigbox.dev/api/v1/apps/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"allowed_emails\": [\n \"<string>\"\n ],\n \"custom_domain\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": \"<unknown>\",\n \"name\": \"<string>\",\n \"port\": 1,\n \"status\": \"<string>\",\n \"swap_subdomain_with\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"app": {
"allowed_emails": [
"<string>"
],
"app_kind": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"custom_domain_verified": true,
"depends_on": [
"<string>"
],
"id": "<string>",
"managed": true,
"metadata": "<unknown>",
"name": "<string>",
"node_id": "<string>",
"port": 1,
"protocol": "<string>",
"subdomain": "<string>",
"system_tags": [
"<string>"
],
"updated_at": "2023-11-07T05:31:56Z",
"user_id": "<string>",
"workspace_id": "<string>",
"custom_domain": "<string>",
"description": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
App ID
Body
Custom domain (e.g. "api.example.com"). Set to empty string or null to remove.
x >= 0Toggle status: "active" or "inactive"
Atomically swap this app's subdomain with another app in the same
workspace. Both apps trade name (and therefore Caddy subdomain)
in a single DB transaction + a single Caddy resync pass. Mutually
exclusive with every other field on this body — combining them
returns 400.
The two apps must satisfy a blue-green sibling relationship
(other.name == "{app.name}-<suffix>" or vice versa), share the
same (user_id, workspace_id), agree on visibility and
allowed_emails, and neither may have a custom domain attached.
See the security checklist in the swap handler for full
rejection conditions.
private, public, privileged Response
App updated
OpenAPI-facing mirror of the canonical app payload.
Response types can keep serializing rig_data_store::models::App while
pointing schema generation at this local mirror to avoid cross-crate derive
coupling in utoipa.
Show child attributes
Show child attributes