{
"openapi": "3.0.0",
"info": {
"title": "Xano Metadata API (beta)",
"description": "The Metadata API\nis currently in beta and is the next\n evolution of the Developer API. It provides support\nto programatically manage your Xano instance and uses Access Tokens to\ncontrol access.",
"version": "0.0.1"
},
"servers": [
{
"url": "https://x8ki-letl-twmt.n7.xano.io/api:meta"
}
],
"components": {
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
},
"schemas": {}
},
"paths": {
"/audit_log/search": {
"post": {
"summary": "search audit logs across all workspaces with support for complex filtering and sorting",
"description": "search audit logs across all workspaces with support for complex filtering and sorting\n
\nAuthentication: required",
"tags": [
"audit logs"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": ""
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": ""
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": ""
},
"type": {
"type": "string",
"description": ""
},
"msg": {
"type": "string",
"description": ""
},
"label": {
"type": "array",
"items": {
"type": "string",
"description": ""
}
},
"data": {
"type": "object",
"description": "",
"nullable": true
},
"obj": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": ""
},
"id": {
"type": "integer",
"format": "int64",
"description": ""
}
}
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": ""
},
"email": {
"type": "string",
"description": "",
"format": "email",
"nullable": true
}
},
"nullable": true
},
"workspace": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": ""
},
"name": {
"type": "string",
"description": ""
}
},
"nullable": true
},
"branch": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": ""
},
"label": {
"type": "string",
"description": "",
"nullable": true
}
},
"nullable": true
}
}
}
},
"itemsReceived": {
"type": "integer",
"format": "int64",
"description": ""
},
"curPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"nextPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"prevPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"offset": {
"type": "integer",
"format": "int64",
"description": ""
},
"perPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"itemsTotal": {
"type": "integer",
"format": "int64",
"description": ""
},
"pageTotal": {
"type": "integer",
"format": "int64",
"description": ""
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"per_page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 50
},
"include_data": {
"type": "boolean",
"description": ""
},
"sort": {
"type": "object",
"description": ""
},
"search": {
"type": "object",
"description": ""
}
},
"example": {
"page": 1,
"per_page": 50,
"sort": {
"id": "desc"
},
"search": []
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"per_page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 50
},
"include_data": {
"type": "boolean",
"description": ""
},
"sort": {
"type": "object",
"description": ""
},
"search": {
"type": "object",
"description": ""
}
},
"example": {
"page": 1,
"per_page": 50,
"sort": {
"id": "desc"
},
"search": []
}
}
}
}
}
}
},
"/audit_log": {
"get": {
"summary": "browse audit logs across all workspaces",
"description": "browse audit logs across all workspaces\n
\nAuthentication: required",
"tags": [
"audit logs"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 50
}
},
{
"name": "include_data",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": ""
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": ""
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": ""
},
"type": {
"type": "string",
"description": ""
},
"msg": {
"type": "string",
"description": ""
},
"label": {
"type": "array",
"items": {
"type": "string",
"description": ""
}
},
"data": {
"type": "object",
"description": "",
"nullable": true
},
"obj": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": ""
},
"id": {
"type": "integer",
"format": "int64",
"description": ""
}
}
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": ""
},
"email": {
"type": "string",
"description": "",
"format": "email",
"nullable": true
}
},
"nullable": true
},
"workspace": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": ""
},
"name": {
"type": "string",
"description": ""
}
},
"nullable": true
},
"branch": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": ""
},
"label": {
"type": "string",
"description": "",
"nullable": true
}
},
"nullable": true
}
}
}
},
"itemsReceived": {
"type": "integer",
"format": "int64",
"description": ""
},
"curPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"nextPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"prevPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"offset": {
"type": "integer",
"format": "int64",
"description": ""
},
"perPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"itemsTotal": {
"type": "integer",
"format": "int64",
"description": ""
},
"pageTotal": {
"type": "integer",
"format": "int64",
"description": ""
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
}
},
"/auth/me": {
"get": {
"summary": "Retrieve information about the authenticated user including ID, name, and email address.",
"description": "Retrieve information about the authenticated user including ID, name, and email address.\n
\nAuthentication: required",
"tags": [
"authentication"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"extras": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
}
},
"/workspace/{workspace_id}/apigroup/{apigroup_id}/api/{api_id}/openapi": {
"get": {
"summary": "Generate OpenAPI specification for a specific API endpoint",
"description": "Generate OpenAPI specification for a specific API endpoint\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Api: Read",
"tags": [
"api group / api"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "apigroup_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "api_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
}
},
"/workspace/{workspace_id}/apigroup/{apigroup_id}/api/{api_id}/security": {
"put": {
"summary": "Update API endpoint security configuration and access controls",
"description": "Update API endpoint security configuration and access controls\n
\nAuthentication: required",
"tags": [
"api group / api"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "apigroup_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "api_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": ""
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"description": ""
}
},
"required": [
"guid"
]
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"description": ""
}
},
"required": [
"guid"
]
}
}
}
}
}
},
"/workspace/{workspace_id}/apigroup/{apigroup_id}/api/{api_id}": {
"delete": {
"summary": "Delete an API endpoint permanently. This action cannot be undone",
"description": "Delete an API endpoint permanently. This action cannot be undone\n
\nAuthentication: required",
"tags": [
"api group / api"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "apigroup_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "api_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"get": {
"summary": "Retrieve a specific API endpoint by ID",
"description": "Retrieve a specific API endpoint by ID\n
\nAuthentication: required",
"tags": [
"api group / api"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "apigroup_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "api_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "include_draft",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "API Test"
},
"description": {
"type": "string",
"description": "",
"default": "My APIs description"
},
"docs": {
"type": "string",
"description": "",
"default": "Documentation"
},
"guid": {
"type": "string",
"description": "",
"default": "YE1fwVhQ-enRlc6Sb42Gqru58-0"
},
"cache": {
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": ""
},
"ttl": {
"type": "integer",
"format": "int64",
"description": "",
"default": 3600
},
"input": {
"type": "boolean",
"description": "",
"default": true
},
"auth": {
"type": "boolean",
"description": "",
"default": true
},
"datasource": {
"type": "boolean",
"description": "",
"default": true
},
"ip": {
"type": "boolean",
"description": ""
},
"headers": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
""
]
},
"env": {
"type": "array",
"items": {
"type": "string",
"description": ""
}
}
}
},
"auth": {
"type": "object",
"description": ""
},
"verb": {
"type": "string",
"description": "",
"enum": [
"GET",
"POST",
"DELETE",
"PUT",
"PATCH",
"HEAD"
],
"default": "GET"
},
"input": {
"type": "array",
"items": {
"type": "object",
"description": ""
},
"default": [
""
]
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"example tag"
]
},
"xanoscript": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "",
"enum": [
"ok",
"error"
]
},
"value": {
"type": "string",
"description": ""
},
"message": {
"type": "string",
"description": ""
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"put": {
"summary": "Update API endpoint code, settings, and authentication rules",
"description": "Update API endpoint code, settings, and authentication rules\n
\nAuthentication: required",
"tags": [
"api group / api"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "apigroup_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "api_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "publish",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": ""
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"text/x-xanoscript": {
"schema": {
"type": "string",
"example": "query foo verb=GET {\n input {\n int score\n }\n stack {\n var $x1 {\n value = $input.score + 1\n }\n }\n response {\n value = $x1\n }\n}\n"
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"docs": {
"type": "string",
"description": ""
},
"verb": {
"type": "string",
"description": "",
"enum": [
"GET",
"POST",
"DELETE",
"PUT",
"PATCH",
"HEAD"
]
},
"auth": {
"type": "object",
"description": ""
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"nullable": true
},
"publish": {
"type": "boolean",
"description": "",
"default": true
},
"cache": {
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": ""
},
"ttl": {
"type": "integer",
"format": "int64",
"description": "",
"default": 3600
},
"input": {
"type": "boolean",
"description": "",
"default": true
},
"auth": {
"type": "boolean",
"description": "",
"default": true
},
"datasource": {
"type": "boolean",
"description": "",
"default": true
},
"ip": {
"type": "boolean",
"description": ""
},
"headers": {
"type": "array",
"items": {
"type": "string",
"description": ""
}
},
"env": {
"type": "array",
"items": {
"type": "string",
"description": ""
}
}
}
}
},
"required": [
"name",
"description",
"verb"
]
}
},
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"docs": {
"type": "string",
"description": ""
},
"verb": {
"type": "string",
"description": "",
"enum": [
"GET",
"POST",
"DELETE",
"PUT",
"PATCH",
"HEAD"
]
},
"auth": {
"type": "object",
"description": ""
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"nullable": true
},
"publish": {
"type": "boolean",
"description": "",
"default": true
},
"cache": {
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": ""
},
"ttl": {
"type": "integer",
"format": "int64",
"description": "",
"default": 3600
},
"input": {
"type": "boolean",
"description": "",
"default": true
},
"auth": {
"type": "boolean",
"description": "",
"default": true
},
"datasource": {
"type": "boolean",
"description": "",
"default": true
},
"ip": {
"type": "boolean",
"description": ""
},
"headers": {
"type": "array",
"items": {
"type": "string",
"description": ""
}
},
"env": {
"type": "array",
"items": {
"type": "string",
"description": ""
}
}
}
}
},
"required": [
"name",
"description",
"verb"
]
}
}
}
}
}
},
"/workspace/{workspace_id}/apigroup/{apigroup_id}/api": {
"get": {
"summary": "Retrieve all API endpoints in a group with optional filtering and pagination",
"description": "Retrieve all API endpoints in a group with optional filtering and pagination\n
\nAuthentication: required",
"tags": [
"api group / api"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "apigroup_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "include_draft",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 50
}
},
{
"name": "search",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "sort",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"enum": [
"created_at",
"updated_at",
"name"
],
"default": "created_at"
}
},
{
"name": "order",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "desc"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"curPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"nextPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"prevPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "API Test"
},
"description": {
"type": "string",
"description": "",
"default": "My APIs description"
},
"docs": {
"type": "string",
"description": "",
"default": "Documentation"
},
"guid": {
"type": "string",
"description": "",
"default": "YE1fwVhQ-enRlc6Sb42Gqru58-0"
},
"cache": {
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": ""
},
"ttl": {
"type": "integer",
"format": "int64",
"description": "",
"default": 3600
},
"input": {
"type": "boolean",
"description": "",
"default": true
},
"auth": {
"type": "boolean",
"description": "",
"default": true
},
"datasource": {
"type": "boolean",
"description": "",
"default": true
},
"ip": {
"type": "boolean",
"description": ""
},
"headers": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
""
]
},
"env": {
"type": "array",
"items": {
"type": "string",
"description": ""
}
}
}
},
"auth": {
"type": "object",
"description": ""
},
"verb": {
"type": "string",
"description": "",
"enum": [
"GET",
"POST",
"DELETE",
"PUT",
"PATCH",
"HEAD"
],
"default": "GET"
},
"input": {
"type": "array",
"items": {
"type": "object",
"description": ""
},
"default": [
""
]
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"example tag"
]
},
"xanoscript": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "",
"enum": [
"ok",
"error"
]
},
"value": {
"type": "string",
"description": ""
},
"message": {
"type": "string",
"description": ""
}
}
}
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"post": {
"summary": "Create a new API endpoint using XanoScript",
"description": "Create a new API endpoint using XanoScript\n
\nAuthentication: required",
"tags": [
"api group / api"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "apigroup_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "branch",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "API Test"
},
"description": {
"type": "string",
"description": "",
"default": "My APIs description"
},
"docs": {
"type": "string",
"description": "",
"default": "Documentation"
},
"guid": {
"type": "string",
"description": "",
"default": "YE1fwVhQ-enRlc6Sb42Gqru58-0"
},
"cache": {
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": ""
},
"ttl": {
"type": "integer",
"format": "int64",
"description": "",
"default": 3600
},
"input": {
"type": "boolean",
"description": "",
"default": true
},
"auth": {
"type": "boolean",
"description": "",
"default": true
},
"datasource": {
"type": "boolean",
"description": "",
"default": true
},
"ip": {
"type": "boolean",
"description": ""
},
"headers": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
""
]
},
"env": {
"type": "array",
"items": {
"type": "string",
"description": ""
}
}
}
},
"auth": {
"type": "object",
"description": ""
},
"verb": {
"type": "string",
"description": "",
"enum": [
"GET",
"POST",
"DELETE",
"PUT",
"PATCH",
"HEAD"
],
"default": "GET"
},
"input": {
"type": "array",
"items": {
"type": "object",
"description": ""
},
"default": [
""
]
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"example tag"
]
},
"xanoscript": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "",
"enum": [
"ok",
"error"
]
},
"value": {
"type": "string",
"description": ""
},
"message": {
"type": "string",
"description": ""
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"text/x-xanoscript": {
"schema": {
"type": "string",
"example": "query foo verb=GET {\n input {\n int score\n }\n stack {\n var $x1 {\n value = $input.score + 1\n }\n }\n response {\n value = $x1\n }\n}\n"
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"docs": {
"type": "string",
"description": ""
},
"verb": {
"type": "string",
"description": "",
"enum": [
"GET",
"POST",
"DELETE",
"PUT",
"PATCH",
"HEAD"
]
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"nullable": true
}
},
"required": [
"name",
"description",
"verb"
]
}
},
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"docs": {
"type": "string",
"description": ""
},
"verb": {
"type": "string",
"description": "",
"enum": [
"GET",
"POST",
"DELETE",
"PUT",
"PATCH",
"HEAD"
]
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"nullable": true
}
},
"required": [
"name",
"description",
"verb"
]
}
}
}
}
}
},
"/workspace/{workspace_id}/apigroup/{apigroup_id}/openapi": {
"get": {
"summary": "Get the OpenAPI specification for an API group. Returns the complete Swagger JSON for all endpoints.",
"description": "Get the OpenAPI specification for an API group. Returns the complete Swagger JSON for all endpoints.\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Api: Read",
"tags": [
"api group"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "apigroup_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
}
},
"/workspace/{workspace_id}/apigroup/{apigroup_id}/security": {
"put": {
"summary": "Update security settings for an API group. Configure access permissions and authentication requirements.",
"description": "Update security settings for an API group. Configure access permissions and authentication requirements.\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Api: Update",
"tags": [
"api group"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "apigroup_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "API Group Test"
},
"description": {
"type": "string",
"description": "",
"default": "My API groups description"
},
"docs": {
"type": "string",
"description": "",
"default": "Documentation"
},
"guid": {
"type": "string",
"description": "",
"default": "YE1fwVhQ-enRlc6Sb42Gqru58-0"
},
"canonical": {
"type": "string",
"description": "",
"default": "FRzyRdY0"
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"example tag"
]
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"description": ""
},
"canonical": {
"type": "string",
"description": ""
}
},
"required": [
"guid",
"canonical"
]
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"description": ""
},
"canonical": {
"type": "string",
"description": ""
}
},
"required": [
"guid",
"canonical"
]
}
}
}
}
}
},
"/workspace/{workspace_id}/apigroup/{apigroup_id}": {
"delete": {
"summary": "Delete an API group and all its endpoints. This action cannot be undone.",
"description": "Delete an API group and all its endpoints. This action cannot be undone.\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Api: Delete",
"tags": [
"api group"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "apigroup_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"get": {
"summary": "Get detailed information for a specific API group. Returns complete metadata and configuration.",
"description": "Get detailed information for a specific API group. Returns complete metadata and configuration.\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Api: Read",
"tags": [
"api group"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "apigroup_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "API Group Test"
},
"description": {
"type": "string",
"description": "",
"default": "My API groups description"
},
"docs": {
"type": "string",
"description": "",
"default": "Documentation"
},
"guid": {
"type": "string",
"description": "",
"default": "YE1fwVhQ-enRlc6Sb42Gqru58-0"
},
"canonical": {
"type": "string",
"description": "",
"default": "FRzyRdY0"
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"example tag"
]
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"put": {
"summary": "Update an existing API group. Modify name, description, documentation settings, or tags.",
"description": "Update an existing API group. Modify name, description, documentation settings, or tags.\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Api: Update",
"tags": [
"api group"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "apigroup_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "API Group Test"
},
"description": {
"type": "string",
"description": "",
"default": "My API groups description"
},
"docs": {
"type": "string",
"description": "",
"default": "Documentation"
},
"guid": {
"type": "string",
"description": "",
"default": "YE1fwVhQ-enRlc6Sb42Gqru58-0"
},
"canonical": {
"type": "string",
"description": "",
"default": "FRzyRdY0"
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"example tag"
]
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"docs": {
"type": "string",
"description": ""
},
"swagger": {
"type": "boolean",
"description": ""
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"nullable": true
}
},
"required": [
"name",
"description",
"swagger"
]
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"docs": {
"type": "string",
"description": ""
},
"swagger": {
"type": "boolean",
"description": ""
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"nullable": true
}
},
"required": [
"name",
"description",
"swagger"
]
}
}
}
}
}
},
"/workspace/{workspace_id}/apigroup": {
"get": {
"summary": "Retrieve a list of API groups inside of a workspace. Use the optional filtering and sorting parameters for more granular returns.",
"description": "Retrieve a list of API groups inside of a workspace. Use the optional filtering and sorting parameters for more granular returns.\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Api: Read",
"tags": [
"api group"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "branch",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 50
}
},
{
"name": "search",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"enum": [
"created_at",
"updated_at",
"name"
],
"default": "created_at"
}
},
{
"name": "order",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "desc"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"curPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"nextPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"prevPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "API Group Test"
},
"description": {
"type": "string",
"description": "",
"default": "My API groups description"
},
"docs": {
"type": "string",
"description": "",
"default": "Documentation"
},
"guid": {
"type": "string",
"description": "",
"default": "YE1fwVhQ-enRlc6Sb42Gqru58-0"
},
"canonical": {
"type": "string",
"description": "",
"default": "FRzyRdY0"
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"example tag"
]
}
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"post": {
"summary": "Create a new API group in a workspace. Include name, description, and optional tags.",
"description": "Create a new API group in a workspace. Include name, description, and optional tags.\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Api: Create",
"tags": [
"api group"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "API Group Test"
},
"description": {
"type": "string",
"description": "",
"default": "My API groups description"
},
"docs": {
"type": "string",
"description": "",
"default": "Documentation"
},
"guid": {
"type": "string",
"description": "",
"default": "YE1fwVhQ-enRlc6Sb42Gqru58-0"
},
"canonical": {
"type": "string",
"description": "",
"default": "FRzyRdY0"
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"example tag"
]
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"branch": {
"type": "string",
"description": ""
},
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"docs": {
"type": "string",
"description": ""
},
"swagger": {
"type": "boolean",
"description": ""
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"nullable": true
}
},
"required": [
"name",
"description",
"swagger"
]
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"branch": {
"type": "string",
"description": ""
},
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"docs": {
"type": "string",
"description": ""
},
"swagger": {
"type": "boolean",
"description": ""
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"nullable": true
}
},
"required": [
"name",
"description",
"swagger"
]
}
}
}
}
}
},
"/workspace/{workspace_id}/audit_log/search": {
"post": {
"summary": "Search audit logs using advanced filters and custom sorting options",
"description": "Search audit logs using advanced filters and custom sorting options\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Log: Read",
"tags": [
"audit logs"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": ""
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": ""
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": ""
},
"type": {
"type": "string",
"description": ""
},
"msg": {
"type": "string",
"description": ""
},
"label": {
"type": "array",
"items": {
"type": "string",
"description": ""
}
},
"data": {
"type": "object",
"description": "",
"nullable": true
},
"obj": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": ""
},
"id": {
"type": "integer",
"format": "int64",
"description": ""
}
}
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": ""
},
"email": {
"type": "string",
"description": "",
"format": "email",
"nullable": true
}
},
"nullable": true
},
"workspace": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": ""
},
"name": {
"type": "string",
"description": ""
}
},
"nullable": true
},
"branch": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": ""
},
"label": {
"type": "string",
"description": "",
"nullable": true
}
},
"nullable": true
}
}
}
},
"itemsReceived": {
"type": "integer",
"format": "int64",
"description": ""
},
"curPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"nextPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"prevPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"offset": {
"type": "integer",
"format": "int64",
"description": ""
},
"perPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"itemsTotal": {
"type": "integer",
"format": "int64",
"description": ""
},
"pageTotal": {
"type": "integer",
"format": "int64",
"description": ""
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"per_page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 50
},
"include_data": {
"type": "boolean",
"description": ""
},
"sort": {
"type": "object",
"description": ""
},
"search": {
"type": "object",
"description": ""
}
},
"example": {
"page": 1,
"per_page": 50,
"sort": {
"id": "desc"
},
"search": []
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"per_page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 50
},
"include_data": {
"type": "boolean",
"description": ""
},
"sort": {
"type": "object",
"description": ""
},
"search": {
"type": "object",
"description": ""
}
},
"example": {
"page": 1,
"per_page": 50,
"sort": {
"id": "desc"
},
"search": []
}
}
}
}
}
}
},
"/workspace/{workspace_id}/audit_log": {
"get": {
"summary": "Retrieve workspace audit logs with pagination support",
"description": "Retrieve workspace audit logs with pagination support\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Log: Read",
"tags": [
"audit logs"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 50
}
},
{
"name": "include_data",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": ""
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": ""
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": ""
},
"type": {
"type": "string",
"description": ""
},
"msg": {
"type": "string",
"description": ""
},
"label": {
"type": "array",
"items": {
"type": "string",
"description": ""
}
},
"data": {
"type": "object",
"description": "",
"nullable": true
},
"obj": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": ""
},
"id": {
"type": "integer",
"format": "int64",
"description": ""
}
}
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": ""
},
"email": {
"type": "string",
"description": "",
"format": "email",
"nullable": true
}
},
"nullable": true
},
"workspace": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": ""
},
"name": {
"type": "string",
"description": ""
}
},
"nullable": true
},
"branch": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": ""
},
"label": {
"type": "string",
"description": "",
"nullable": true
}
},
"nullable": true
}
}
}
},
"itemsReceived": {
"type": "integer",
"format": "int64",
"description": ""
},
"curPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"nextPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"prevPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"offset": {
"type": "integer",
"format": "int64",
"description": ""
},
"perPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"itemsTotal": {
"type": "integer",
"format": "int64",
"description": ""
},
"pageTotal": {
"type": "integer",
"format": "int64",
"description": ""
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
}
},
"/workspace/{workspace_id}/branch/{branch_label}": {
"delete": {
"summary": "Delete a workspace branch. Cannot delete the default branch or currently live branch.",
"description": "Delete a workspace branch. Cannot delete the default branch or currently live branch.\n
\nAuthentication: required\n
\nRequired API Scope:\nInstance Workspace: Update",
"tags": [
"workspace / branch"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "branch_label",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
}
},
"/workspace/{workspace_id}/branch": {
"get": {
"summary": "Retrieve all branches in a workspace.",
"description": "Retrieve all branches in a workspace.\n
\nAuthentication: required\n
\nRequired API Scope:\nInstance Workspace: Read",
"tags": [
"workspace / branch"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"created_at": {
"type": "string",
"description": "",
"default": "2023-06-22 22:59:11+0000"
},
"label": {
"type": "string",
"description": "",
"default": "v1"
},
"live": {
"type": "boolean",
"description": "",
"default": true
},
"backup": {
"type": "boolean",
"description": "",
"default": "false"
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
}
},
"/workspace/{workspace_id}/datasource/{label}": {
"delete": {
"summary": "Delete a data source permanently. This action cannot be undone.",
"description": "Delete a data source permanently. This action cannot be undone.\n
\nAuthentication: required\n
\nRequired API Scope:\nInstance Workspace: Delete",
"tags": [
"workspace / datasource"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "label",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"put": {
"summary": "Update an existing data source's label and color properties",
"description": "Update an existing data source's label and color properties\n
\nAuthentication: required\n
\nRequired API Scope:\nInstance Workspace: Update",
"tags": [
"workspace / datasource"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "label",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"color": {
"type": "string",
"description": "",
"default": "#008000"
},
"label": {
"type": "string",
"description": "",
"default": "live"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"color": {
"type": "string",
"description": "",
"default": "#ebc346"
}
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"color": {
"type": "string",
"description": "",
"default": "#ebc346"
}
}
}
}
}
}
}
},
"/workspace/{workspace_id}/datasource": {
"get": {
"summary": "Retrieve all external data sources for a workspace",
"description": "Retrieve all external data sources for a workspace\n
\nAuthentication: required\n
\nRequired API Scope:\nInstance Workspace: Read",
"tags": [
"workspace / datasource"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"color": {
"type": "string",
"description": "",
"default": "#008000"
},
"label": {
"type": "string",
"description": "",
"default": "live"
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"post": {
"summary": "Create a new external data source with custom label and color",
"description": "Create a new external data source with custom label and color\n
\nAuthentication: required\n
\nRequired API Scope:\nInstance Workspace: Create",
"tags": [
"workspace / datasource"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"color": {
"type": "string",
"description": "",
"default": "#008000"
},
"label": {
"type": "string",
"description": "",
"default": "live"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": ""
},
"color": {
"type": "string",
"description": "",
"default": "#ebc346"
}
},
"required": [
"label"
]
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": ""
},
"color": {
"type": "string",
"description": "",
"default": "#ebc346"
}
},
"required": [
"label"
]
}
}
}
}
}
},
"/workspace/{workspace_id}/export-schema": {
"post": {
"summary": "Export database table schemas and branch configuration as a file",
"description": "Leave the `branch` parameter empty to indicate the current live branch. `password` is optional. If provided, will encrypt the export and will be required when importing the file.\n
\nRequired API Scope:\nInstance Workspace: Read",
"tags": [
"workspace"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"password": {
"type": "string",
"description": ""
},
"branch": {
"type": "string",
"description": ""
}
},
"example": {
"branch": "",
"password": ""
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"password": {
"type": "string",
"description": ""
},
"branch": {
"type": "string",
"description": ""
}
},
"example": {
"branch": "",
"password": ""
}
}
}
}
}
}
},
"/workspace/{workspace_id}/export": {
"post": {
"summary": "Export complete workspace data and configuration as an archive",
"description": "Leave the `branch` parameter empty to indicate the current live branch. `password` is optional. If provided, will encrypt the export and will be required when importing the file.\n
\nRequired API Scope:\nInstance Workspace: Read",
"tags": [
"workspace"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"password": {
"type": "string",
"description": ""
},
"branch": {
"type": "string",
"description": ""
}
},
"example": {
"branch": "",
"password": ""
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"password": {
"type": "string",
"description": ""
},
"branch": {
"type": "string",
"description": ""
}
},
"example": {
"branch": "",
"password": ""
}
}
}
}
}
}
},
"/workspace/{workspace_id}/file/bulk_delete": {
"delete": {
"summary": "Delete multiple files permanently. This action cannot be undone.",
"description": "Delete multiple files permanently. This action cannot be undone.\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace File: Delete",
"tags": [
"file"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": ""
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64",
"description": ""
}
}
},
"required": [
"ids"
]
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64",
"description": ""
}
}
},
"required": [
"ids"
]
}
}
}
}
}
},
"/workspace/{workspace_id}/file/{file_id}": {
"delete": {
"summary": "Delete a file permanently. This action cannot be undone.",
"description": "Delete a file permanently. This action cannot be undone.\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace File: Delete",
"tags": [
"file"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "file_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": ""
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
}
},
"/workspace/{workspace_id}/file": {
"get": {
"summary": "Retrieve workspace files with optional search, filtering, and pagination",
"description": "Retrieve workspace files with optional search, filtering, and pagination\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace File: Read",
"tags": [
"file"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 50
}
},
{
"name": "search",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "access",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"enum": [
"public",
"private"
],
"default": "public"
}
},
{
"name": "sort",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"enum": [
"created_at",
"name",
"size",
"mime"
],
"default": "created_at"
}
},
{
"name": "order",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "desc"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"curPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"nextPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"prevPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 10095
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "file_example_MP3_1MG.mp3"
},
"size": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1087849
},
"type": {
"type": "string",
"description": "",
"default": "audio"
},
"mime": {
"type": "string",
"description": "",
"default": "audio/mpeg"
},
"access": {
"type": "string",
"description": "",
"default": "public"
},
"path": {
"type": "string",
"description": "",
"default": "/vault/Ramtdv50/3TA6XKsmLe-2BigGnwxSb0v00sI/qSWtbg../file_example_MP3_1MG.mp3"
}
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"post": {
"summary": "Upload files to workspace",
"description": "Upload files to workspace\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace File: Create",
"tags": [
"file"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 10095
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "file_example_MP3_1MG.mp3"
},
"size": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1087849
},
"type": {
"type": "string",
"description": "",
"default": "audio"
},
"mime": {
"type": "string",
"description": "",
"default": "audio/mpeg"
},
"access": {
"type": "string",
"description": "",
"default": "public"
},
"path": {
"type": "string",
"description": "",
"default": "/vault/Ramtdv50/3TA6XKsmLe-2BigGnwxSb0v00sI/qSWtbg../file_example_MP3_1MG.mp3"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"content": {
"type": "string",
"format": "binary",
"description": ""
},
"type": {
"type": "string",
"description": "",
"enum": [
"image",
"video",
"audio"
]
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private"
],
"default": "public"
}
},
"required": [
"content"
]
}
}
}
}
}
},
"/workspace/{workspace_id}/function/{function_id}/security": {
"put": {
"summary": "Update function security configuration and access controls",
"description": "Update function security configuration and access controls\n
\nAuthentication: required",
"tags": [
"function"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "function_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "Function Test"
},
"description": {
"type": "string",
"description": "",
"default": "My functions description"
},
"docs": {
"type": "string",
"description": "",
"default": "Documentation"
},
"guid": {
"type": "string",
"description": "",
"default": "YE1fwVhQ-enRlc6Sb42Gqru58-0"
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
},
"cache": {
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": ""
},
"ttl": {
"type": "integer",
"format": "int64",
"description": "",
"default": 3600
},
"input": {
"type": "boolean",
"description": "",
"default": true
},
"auth": {
"type": "boolean",
"description": "",
"default": true
},
"datasource": {
"type": "boolean",
"description": "",
"default": true
},
"ip": {
"type": "boolean",
"description": ""
},
"headers": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
""
]
},
"env": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
""
]
}
}
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"example tag"
]
},
"xanoscript": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "",
"enum": [
"ok",
"error"
]
},
"value": {
"type": "string",
"description": ""
},
"message": {
"type": "string",
"description": ""
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"description": ""
}
},
"required": [
"guid"
]
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"description": ""
}
},
"required": [
"guid"
]
}
}
}
}
}
},
"/workspace/{workspace_id}/function/{function_id}": {
"delete": {
"summary": "Delete a function permanently. This action cannot be undone",
"description": "Delete a function permanently. This action cannot be undone\n
\nAuthentication: required",
"tags": [
"function"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "function_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"get": {
"summary": "Retrieve a specific function by ID",
"description": "Retrieve a specific function by ID\n
\nAuthentication: required",
"tags": [
"function"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "function_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "include_draft",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "Function Test"
},
"description": {
"type": "string",
"description": "",
"default": "My functions description"
},
"docs": {
"type": "string",
"description": "",
"default": "Documentation"
},
"guid": {
"type": "string",
"description": "",
"default": "YE1fwVhQ-enRlc6Sb42Gqru58-0"
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
},
"cache": {
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": ""
},
"ttl": {
"type": "integer",
"format": "int64",
"description": "",
"default": 3600
},
"input": {
"type": "boolean",
"description": "",
"default": true
},
"auth": {
"type": "boolean",
"description": "",
"default": true
},
"datasource": {
"type": "boolean",
"description": "",
"default": true
},
"ip": {
"type": "boolean",
"description": ""
},
"headers": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
""
]
},
"env": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
""
]
}
}
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"example tag"
]
},
"xanoscript": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "",
"enum": [
"ok",
"error"
]
},
"value": {
"type": "string",
"description": ""
},
"message": {
"type": "string",
"description": ""
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"put": {
"summary": "Update function code, metadata, and caching settings",
"description": "Update function code, metadata, and caching settings\n
\nAuthentication: required",
"tags": [
"function"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "function_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "publish",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "Function Test"
},
"description": {
"type": "string",
"description": "",
"default": "My functions description"
},
"docs": {
"type": "string",
"description": "",
"default": "Documentation"
},
"guid": {
"type": "string",
"description": "",
"default": "YE1fwVhQ-enRlc6Sb42Gqru58-0"
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
},
"cache": {
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": ""
},
"ttl": {
"type": "integer",
"format": "int64",
"description": "",
"default": 3600
},
"input": {
"type": "boolean",
"description": "",
"default": true
},
"auth": {
"type": "boolean",
"description": "",
"default": true
},
"datasource": {
"type": "boolean",
"description": "",
"default": true
},
"ip": {
"type": "boolean",
"description": ""
},
"headers": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
""
]
},
"env": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
""
]
}
}
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"example tag"
]
},
"xanoscript": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "",
"enum": [
"ok",
"error"
]
},
"value": {
"type": "string",
"description": ""
},
"message": {
"type": "string",
"description": ""
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"text/x-xanoscript": {
"schema": {
"type": "string",
"example": "function foo {\n input {\n int score\n }\n stack {\n var $x1 {\n value = $input.score + 1\n }\n }\n response {\n value = $x1\n }\n}\n"
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"docs": {
"type": "string",
"description": ""
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"nullable": true
},
"publish": {
"type": "boolean",
"description": "",
"default": true
},
"cache": {
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": ""
},
"ttl": {
"type": "integer",
"format": "int64",
"description": "",
"default": 3600
},
"input": {
"type": "boolean",
"description": "",
"default": true
},
"auth": {
"type": "boolean",
"description": "",
"default": true
},
"datasource": {
"type": "boolean",
"description": "",
"default": true
},
"ip": {
"type": "boolean",
"description": ""
},
"headers": {
"type": "array",
"items": {
"type": "string",
"description": ""
}
},
"env": {
"type": "array",
"items": {
"type": "string",
"description": ""
}
}
}
}
},
"required": [
"name",
"description"
]
}
},
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"docs": {
"type": "string",
"description": ""
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"nullable": true
},
"publish": {
"type": "boolean",
"description": "",
"default": true
},
"cache": {
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": ""
},
"ttl": {
"type": "integer",
"format": "int64",
"description": "",
"default": 3600
},
"input": {
"type": "boolean",
"description": "",
"default": true
},
"auth": {
"type": "boolean",
"description": "",
"default": true
},
"datasource": {
"type": "boolean",
"description": "",
"default": true
},
"ip": {
"type": "boolean",
"description": ""
},
"headers": {
"type": "array",
"items": {
"type": "string",
"description": ""
}
},
"env": {
"type": "array",
"items": {
"type": "string",
"description": ""
}
}
}
}
},
"required": [
"name",
"description"
]
}
}
}
}
}
},
"/workspace/{workspace_id}/function_history/search": {
"post": {
"summary": "Search function request history using advanced filters and custom sorting options",
"description": "Search function request history using advanced filters and custom sorting options\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Request History: Read",
"tags": [
"request history"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"curPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"nextPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"prevPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-12 18:34:01+0000"
},
"duration": {
"type": "number",
"description": "",
"default": 0.025
},
"input": {
"type": "object",
"description": "",
"default": {
"page": 1
}
},
"workspace_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
},
"function_id": {
"type": "integer",
"format": "int64",
"description": ""
}
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"per_page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 50
},
"branch": {
"type": "string",
"description": ""
},
"function_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"search": {
"type": "object",
"description": ""
},
"sort": {
"type": "object",
"description": ""
},
"include_output": {
"type": "boolean",
"description": ""
}
},
"example": {
"page": 1,
"per_page": 50,
"branch": null,
"function_id": null,
"sort": {
"created_at": "desc"
},
"search": []
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"per_page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 50
},
"branch": {
"type": "string",
"description": ""
},
"function_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"search": {
"type": "object",
"description": ""
},
"sort": {
"type": "object",
"description": ""
},
"include_output": {
"type": "boolean",
"description": ""
}
},
"example": {
"page": 1,
"per_page": 50,
"branch": null,
"function_id": null,
"sort": {
"created_at": "desc"
},
"search": []
}
}
}
}
}
}
},
"/workspace/{workspace_id}/function_history": {
"get": {
"summary": "Retrieve API function request history with optional filtering and pagination",
"description": "Retrieve API function request history with optional filtering and pagination\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Request History: Read",
"tags": [
"request history"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 50
}
},
{
"name": "branch",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "function_id",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 0
}
},
{
"name": "include_output",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"curPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"nextPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"prevPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-12 18:34:01+0000"
},
"duration": {
"type": "number",
"description": "",
"default": 0.025
},
"input": {
"type": "object",
"description": "",
"default": {
"page": 1
}
},
"workspace_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
},
"function_id": {
"type": "integer",
"format": "int64",
"description": ""
}
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
}
},
"/workspace/{workspace_id}/function": {
"get": {
"summary": "Retrieve all functions in a workspace with optional filtering and pagination",
"description": "Retrieve all functions in a workspace with optional filtering and pagination\n
\nAuthentication: required",
"tags": [
"function"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "branch",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "include_draft",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 50
}
},
{
"name": "search",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "sort",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"enum": [
"created_at",
"updated_at",
"name"
],
"default": "created_at"
}
},
{
"name": "order",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "desc"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"curPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"nextPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"prevPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "Function Test"
},
"description": {
"type": "string",
"description": "",
"default": "My functions description"
},
"docs": {
"type": "string",
"description": "",
"default": "Documentation"
},
"guid": {
"type": "string",
"description": "",
"default": "YE1fwVhQ-enRlc6Sb42Gqru58-0"
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
},
"cache": {
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": ""
},
"ttl": {
"type": "integer",
"format": "int64",
"description": "",
"default": 3600
},
"input": {
"type": "boolean",
"description": "",
"default": true
},
"auth": {
"type": "boolean",
"description": "",
"default": true
},
"datasource": {
"type": "boolean",
"description": "",
"default": true
},
"ip": {
"type": "boolean",
"description": ""
},
"headers": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
""
]
},
"env": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
""
]
}
}
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"example tag"
]
},
"xanoscript": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "",
"enum": [
"ok",
"error"
]
},
"value": {
"type": "string",
"description": ""
},
"message": {
"type": "string",
"description": ""
}
}
}
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"post": {
"summary": "Create a new function using XanoScript",
"description": "Create a new function using XanoScript\n
\nAuthentication: required",
"tags": [
"function"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "branch",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "Function Test"
},
"description": {
"type": "string",
"description": "",
"default": "My functions description"
},
"docs": {
"type": "string",
"description": "",
"default": "Documentation"
},
"guid": {
"type": "string",
"description": "",
"default": "YE1fwVhQ-enRlc6Sb42Gqru58-0"
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
},
"cache": {
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": ""
},
"ttl": {
"type": "integer",
"format": "int64",
"description": "",
"default": 3600
},
"input": {
"type": "boolean",
"description": "",
"default": true
},
"auth": {
"type": "boolean",
"description": "",
"default": true
},
"datasource": {
"type": "boolean",
"description": "",
"default": true
},
"ip": {
"type": "boolean",
"description": ""
},
"headers": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
""
]
},
"env": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
""
]
}
}
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"example tag"
]
},
"xanoscript": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "",
"enum": [
"ok",
"error"
]
},
"value": {
"type": "string",
"description": ""
},
"message": {
"type": "string",
"description": ""
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"text/x-xanoscript": {
"schema": {
"type": "string",
"example": "function foo {\n input {\n int score\n }\n stack {\n var $x1 {\n value = $input.score + 1\n }\n }\n response {\n value = $x1\n }\n}\n"
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"branch": {
"type": "string",
"description": ""
},
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"docs": {
"type": "string",
"description": ""
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"nullable": true
}
},
"required": [
"name",
"description"
]
}
},
"application/json": {
"schema": {
"type": "object",
"properties": {
"branch": {
"type": "string",
"description": ""
},
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"docs": {
"type": "string",
"description": ""
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"nullable": true
}
},
"required": [
"name",
"description"
]
}
}
}
}
}
},
"/workspace/{workspace_id}/import-schema": {
"post": {
"summary": "Import database schema into a new branch with optional deployment",
"description": "Import database schema into a new branch with optional deployment\n
\nAuthentication: required\n
\nRequired API Scope:\nInstance Workspace: Read",
"tags": [
"workspace"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": ""
},
"newbranch": {
"type": "string",
"description": ""
},
"setlive": {
"type": "boolean",
"description": ""
},
"password": {
"type": "string",
"description": ""
}
},
"required": [
"file",
"newbranch"
]
}
}
}
}
}
},
"/workspace/{workspace_id}/import": {
"post": {
"summary": "Replace workspace content and configuration with imported archive",
"description": "If the file is encrypted, the correct `password` is required to decrypt.\n
\nRequired API Scope:\nInstance Workspace: Update",
"tags": [
"workspace"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": ""
},
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"branch": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": ""
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": ""
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"label": {
"type": "string",
"description": "",
"nullable": true
},
"backup": {
"type": "boolean",
"description": ""
},
"color": {
"type": "string",
"description": "",
"default": "#ebc346"
},
"parent_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"guid": {
"type": "string",
"description": ""
},
"is_service": {
"type": "boolean",
"description": "",
"nullable": true
},
"workspace": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": ""
}
}
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": ""
},
"name": {
"type": "string",
"description": ""
},
"email": {
"type": "string",
"description": "",
"format": "email"
}
}
},
"history": {
"type": "object",
"properties": {
"function_enabled": {
"type": "boolean",
"description": ""
},
"function_limit": {
"type": "integer",
"format": "int64",
"description": "",
"default": 100
},
"middleware_enabled": {
"type": "boolean",
"description": ""
},
"middleware_limit": {
"type": "integer",
"format": "int64",
"description": "",
"default": 100
},
"query_enabled": {
"type": "boolean",
"description": "",
"default": true
},
"query_limit": {
"type": "integer",
"format": "int64",
"description": "",
"default": 100
},
"task_enabled": {
"type": "boolean",
"description": "",
"default": true
},
"task_limit": {
"type": "integer",
"format": "int64",
"description": "",
"default": 100
},
"tool_enabled": {
"type": "boolean",
"description": "",
"default": true
},
"tool_limit": {
"type": "integer",
"format": "int64",
"description": "",
"default": 100
},
"trigger_enabled": {
"type": "boolean",
"description": ""
},
"trigger_limit": {
"type": "integer",
"format": "int64",
"description": "",
"default": 100
}
}
},
"middleware": {
"type": "object",
"properties": {
"function_pre": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"as": {
"type": "string",
"description": ""
},
"context": {
"type": "object",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"mocks": {
"type": "object",
"description": ""
},
"_xsid": {
"type": "string",
"description": ""
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"settings_registry": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"nullable": true
},
"output": {
"type": "object",
"properties": {
"customize": {
"type": "boolean",
"description": ""
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
},
"addon": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object",
"description": ""
},
"offset": {
"type": "string",
"description": ""
},
"as": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object",
"description": ""
},
"offset": {
"type": "string",
"description": ""
},
"as": {
"type": "string",
"description": ""
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"output": {
"type": "object",
"properties": {
"customize": {
"type": "boolean",
"description": ""
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"output": {
"type": "object",
"properties": {
"customize": {
"type": "boolean",
"description": ""
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
},
"runtime": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"description": "",
"enum": [
"disabled",
"async-shared",
"async-dedicated"
],
"default": "disabled"
},
"cpu": {
"type": "string",
"description": ""
},
"memory": {
"type": "string",
"description": ""
},
"max_retry": {
"type": "integer",
"format": "int64",
"description": ""
},
"timeout": {
"type": "integer",
"format": "int64",
"description": ""
}
},
"nullable": true
}
}
}
},
"function_post": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"as": {
"type": "string",
"description": ""
},
"context": {
"type": "object",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"mocks": {
"type": "object",
"description": ""
},
"_xsid": {
"type": "string",
"description": ""
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"settings_registry": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"nullable": true
},
"output": {
"type": "object",
"properties": {
"customize": {
"type": "boolean",
"description": ""
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
},
"addon": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object",
"description": ""
},
"offset": {
"type": "string",
"description": ""
},
"as": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object",
"description": ""
},
"offset": {
"type": "string",
"description": ""
},
"as": {
"type": "string",
"description": ""
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"output": {
"type": "object",
"properties": {
"customize": {
"type": "boolean",
"description": ""
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"output": {
"type": "object",
"properties": {
"customize": {
"type": "boolean",
"description": ""
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
},
"runtime": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"description": "",
"enum": [
"disabled",
"async-shared",
"async-dedicated"
],
"default": "disabled"
},
"cpu": {
"type": "string",
"description": ""
},
"memory": {
"type": "string",
"description": ""
},
"max_retry": {
"type": "integer",
"format": "int64",
"description": ""
},
"timeout": {
"type": "integer",
"format": "int64",
"description": ""
}
},
"nullable": true
}
}
}
},
"query_pre": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"as": {
"type": "string",
"description": ""
},
"context": {
"type": "object",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"mocks": {
"type": "object",
"description": ""
},
"_xsid": {
"type": "string",
"description": ""
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"settings_registry": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"nullable": true
},
"output": {
"type": "object",
"properties": {
"customize": {
"type": "boolean",
"description": ""
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
},
"addon": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object",
"description": ""
},
"offset": {
"type": "string",
"description": ""
},
"as": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object",
"description": ""
},
"offset": {
"type": "string",
"description": ""
},
"as": {
"type": "string",
"description": ""
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"output": {
"type": "object",
"properties": {
"customize": {
"type": "boolean",
"description": ""
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"output": {
"type": "object",
"properties": {
"customize": {
"type": "boolean",
"description": ""
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
},
"runtime": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"description": "",
"enum": [
"disabled",
"async-shared",
"async-dedicated"
],
"default": "disabled"
},
"cpu": {
"type": "string",
"description": ""
},
"memory": {
"type": "string",
"description": ""
},
"max_retry": {
"type": "integer",
"format": "int64",
"description": ""
},
"timeout": {
"type": "integer",
"format": "int64",
"description": ""
}
},
"nullable": true
}
}
}
},
"query_post": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"as": {
"type": "string",
"description": ""
},
"context": {
"type": "object",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"mocks": {
"type": "object",
"description": ""
},
"_xsid": {
"type": "string",
"description": ""
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"settings_registry": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"nullable": true
},
"output": {
"type": "object",
"properties": {
"customize": {
"type": "boolean",
"description": ""
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
},
"addon": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object",
"description": ""
},
"offset": {
"type": "string",
"description": ""
},
"as": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object",
"description": ""
},
"offset": {
"type": "string",
"description": ""
},
"as": {
"type": "string",
"description": ""
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"output": {
"type": "object",
"properties": {
"customize": {
"type": "boolean",
"description": ""
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"output": {
"type": "object",
"properties": {
"customize": {
"type": "boolean",
"description": ""
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
},
"runtime": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"description": "",
"enum": [
"disabled",
"async-shared",
"async-dedicated"
],
"default": "disabled"
},
"cpu": {
"type": "string",
"description": ""
},
"memory": {
"type": "string",
"description": ""
},
"max_retry": {
"type": "integer",
"format": "int64",
"description": ""
},
"timeout": {
"type": "integer",
"format": "int64",
"description": ""
}
},
"nullable": true
}
}
}
},
"task_pre": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"as": {
"type": "string",
"description": ""
},
"context": {
"type": "object",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"mocks": {
"type": "object",
"description": ""
},
"_xsid": {
"type": "string",
"description": ""
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"settings_registry": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"nullable": true
},
"output": {
"type": "object",
"properties": {
"customize": {
"type": "boolean",
"description": ""
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
},
"addon": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object",
"description": ""
},
"offset": {
"type": "string",
"description": ""
},
"as": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object",
"description": ""
},
"offset": {
"type": "string",
"description": ""
},
"as": {
"type": "string",
"description": ""
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"output": {
"type": "object",
"properties": {
"customize": {
"type": "boolean",
"description": ""
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"output": {
"type": "object",
"properties": {
"customize": {
"type": "boolean",
"description": ""
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
},
"runtime": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"description": "",
"enum": [
"disabled",
"async-shared",
"async-dedicated"
],
"default": "disabled"
},
"cpu": {
"type": "string",
"description": ""
},
"memory": {
"type": "string",
"description": ""
},
"max_retry": {
"type": "integer",
"format": "int64",
"description": ""
},
"timeout": {
"type": "integer",
"format": "int64",
"description": ""
}
},
"nullable": true
}
}
}
},
"task_post": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"as": {
"type": "string",
"description": ""
},
"context": {
"type": "object",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"mocks": {
"type": "object",
"description": ""
},
"_xsid": {
"type": "string",
"description": ""
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"settings_registry": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"nullable": true
},
"output": {
"type": "object",
"properties": {
"customize": {
"type": "boolean",
"description": ""
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
},
"addon": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object",
"description": ""
},
"offset": {
"type": "string",
"description": ""
},
"as": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object",
"description": ""
},
"offset": {
"type": "string",
"description": ""
},
"as": {
"type": "string",
"description": ""
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"output": {
"type": "object",
"properties": {
"customize": {
"type": "boolean",
"description": ""
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"output": {
"type": "object",
"properties": {
"customize": {
"type": "boolean",
"description": ""
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
},
"runtime": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"description": "",
"enum": [
"disabled",
"async-shared",
"async-dedicated"
],
"default": "disabled"
},
"cpu": {
"type": "string",
"description": ""
},
"memory": {
"type": "string",
"description": ""
},
"max_retry": {
"type": "integer",
"format": "int64",
"description": ""
},
"timeout": {
"type": "integer",
"format": "int64",
"description": ""
}
},
"nullable": true
}
}
}
},
"tool_pre": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"as": {
"type": "string",
"description": ""
},
"context": {
"type": "object",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"mocks": {
"type": "object",
"description": ""
},
"_xsid": {
"type": "string",
"description": ""
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"settings_registry": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"nullable": true
},
"output": {
"type": "object",
"properties": {
"customize": {
"type": "boolean",
"description": ""
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
},
"addon": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object",
"description": ""
},
"offset": {
"type": "string",
"description": ""
},
"as": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object",
"description": ""
},
"offset": {
"type": "string",
"description": ""
},
"as": {
"type": "string",
"description": ""
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"output": {
"type": "object",
"properties": {
"customize": {
"type": "boolean",
"description": ""
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"output": {
"type": "object",
"properties": {
"customize": {
"type": "boolean",
"description": ""
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
},
"runtime": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"description": "",
"enum": [
"disabled",
"async-shared",
"async-dedicated"
],
"default": "disabled"
},
"cpu": {
"type": "string",
"description": ""
},
"memory": {
"type": "string",
"description": ""
},
"max_retry": {
"type": "integer",
"format": "int64",
"description": ""
},
"timeout": {
"type": "integer",
"format": "int64",
"description": ""
}
},
"nullable": true
}
}
}
},
"tool_post": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"as": {
"type": "string",
"description": ""
},
"context": {
"type": "object",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"mocks": {
"type": "object",
"description": ""
},
"_xsid": {
"type": "string",
"description": ""
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"settings_registry": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"nullable": true
},
"output": {
"type": "object",
"properties": {
"customize": {
"type": "boolean",
"description": ""
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
},
"addon": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object",
"description": ""
},
"offset": {
"type": "string",
"description": ""
},
"as": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "object",
"description": ""
},
"offset": {
"type": "string",
"description": ""
},
"as": {
"type": "string",
"description": ""
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"output": {
"type": "object",
"properties": {
"customize": {
"type": "boolean",
"description": ""
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset",
"use_default"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
},
"ignore": {
"type": "boolean",
"description": ""
},
"expand": {
"type": "boolean",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"disabled": {
"type": "boolean",
"description": ""
},
"arg": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": ""
},
"tag": {
"type": "string",
"description": "",
"enum": [
"const",
"const:encoded",
"const:int",
"const:decimal",
"const:bool",
"const:array",
"const:epochms",
"const:obj",
"const:null",
"const:expr",
"const:expr:encoded",
"const:expr2",
"const:expr2:encoded",
"input",
"reg",
"var",
"auth",
"env",
"setting",
"col",
"output",
"response",
"trycatch",
"toolset"
],
"default": "input"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"output": {
"type": "object",
"properties": {
"customize": {
"type": "boolean",
"description": ""
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
}
},
"runtime": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"description": "",
"enum": [
"disabled",
"async-shared",
"async-dedicated"
],
"default": "disabled"
},
"cpu": {
"type": "string",
"description": ""
},
"memory": {
"type": "string",
"description": ""
},
"max_retry": {
"type": "integer",
"format": "int64",
"description": ""
},
"timeout": {
"type": "integer",
"format": "int64",
"description": ""
}
},
"nullable": true
}
}
}
}
}
},
"defaults": {
"type": "object",
"properties": {
"db_primary_key": {
"type": "string",
"description": "",
"enum": [
"int",
"uuid"
]
}
}
}
},
"nullable": true
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"password": {
"type": "string",
"description": ""
},
"file": {
"type": "string",
"format": "binary",
"description": ""
}
},
"required": [
"file"
]
}
}
}
}
}
},
"/workspace/{workspace_id}/middleware_history/search": {
"post": {
"summary": "Search middleware request history using advanced filters and custom sorting options",
"description": "Search middleware request history using advanced filters and custom sorting options\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Request History: Read",
"tags": [
"request history"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"curPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"nextPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"prevPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-12 18:34:01+0000"
},
"duration": {
"type": "number",
"description": "",
"default": 0.025
},
"input": {
"type": "object",
"description": "",
"default": {
"page": 1
}
},
"workspace_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
},
"middleware_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"query_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"function_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"task_id": {
"type": "integer",
"format": "int64",
"description": ""
}
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"per_page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 50
},
"branch": {
"type": "string",
"description": ""
},
"middleware_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"query_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"function_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"task_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"search": {
"type": "object",
"description": ""
},
"sort": {
"type": "object",
"description": ""
},
"include_output": {
"type": "boolean",
"description": ""
}
},
"example": {
"page": 1,
"per_page": 50,
"branch": null,
"middleware_id": null,
"sort": {
"created_at": "desc"
},
"search": []
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"per_page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 50
},
"branch": {
"type": "string",
"description": ""
},
"middleware_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"query_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"function_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"task_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"search": {
"type": "object",
"description": ""
},
"sort": {
"type": "object",
"description": ""
},
"include_output": {
"type": "boolean",
"description": ""
}
},
"example": {
"page": 1,
"per_page": 50,
"branch": null,
"middleware_id": null,
"sort": {
"created_at": "desc"
},
"search": []
}
}
}
}
}
}
},
"/workspace/{workspace_id}/middleware_history": {
"get": {
"summary": "Retrieve middleware request history with optional filtering and pagination",
"description": "Retrieve middleware request history with optional filtering and pagination\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Request History: Read",
"tags": [
"request history"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 50
}
},
{
"name": "branch",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "middleware_id",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 0
}
},
{
"name": "query_id",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 0
}
},
{
"name": "function_id",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 0
}
},
{
"name": "task_id",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 0
}
},
{
"name": "include_output",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"curPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"nextPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"prevPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-12 18:34:01+0000"
},
"duration": {
"type": "number",
"description": "",
"default": 0.025
},
"input": {
"type": "object",
"description": "",
"default": {
"page": 1
}
},
"workspace_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
},
"middleware_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"query_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"function_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"task_id": {
"type": "integer",
"format": "int64",
"description": ""
}
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
}
},
"/workspace/{workspace_id}/realtime": {
"get": {
"summary": "Retrieve real-time operational metrics and connection details",
"description": "Retrieve real-time operational metrics and connection details\n
\nAuthentication: required\n
\nRequired API Scope:\nInstance Workspace: Read",
"tags": [
"realtime"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": ""
},
"hash": {
"type": "string",
"description": "",
"default": "Dl3HlakmBZDhezv6yml7hliTM20"
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"anonymous_clients": {
"type": "boolean",
"description": ""
},
"client_authenticated_messaging": {
"type": "boolean",
"description": ""
},
"client_private_messaging": {
"type": "boolean",
"description": ""
},
"client_private_messaging_authenticated_only": {
"type": "boolean",
"description": ""
},
"client_public_messaging": {
"type": "boolean",
"description": ""
},
"client_public_messaging_authenticated_only": {
"type": "boolean",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"enabled": {
"type": "boolean",
"description": ""
},
"id": {
"type": "integer",
"format": "int64",
"description": ""
},
"pattern": {
"type": "string",
"description": ""
},
"presence": {
"type": "boolean",
"description": ""
},
"wildcard": {
"type": "boolean",
"description": ""
}
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"put": {
"summary": "Update real-time settings and connection configuration",
"description": "Update real-time settings and connection configuration\n
\nAuthentication: required\n
\nRequired API Scope:\nInstance Workspace: Update",
"tags": [
"realtime"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": ""
},
"hash": {
"type": "string",
"description": "",
"default": "Dl3HlakmBZDhezv6yml7hliTM20"
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"anonymous_clients": {
"type": "boolean",
"description": ""
},
"client_authenticated_messaging": {
"type": "boolean",
"description": ""
},
"client_private_messaging": {
"type": "boolean",
"description": ""
},
"client_private_messaging_authenticated_only": {
"type": "boolean",
"description": ""
},
"client_public_messaging": {
"type": "boolean",
"description": ""
},
"client_public_messaging_authenticated_only": {
"type": "boolean",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"enabled": {
"type": "boolean",
"description": ""
},
"id": {
"type": "integer",
"format": "int64",
"description": ""
},
"pattern": {
"type": "string",
"description": ""
},
"presence": {
"type": "boolean",
"description": ""
},
"wildcard": {
"type": "boolean",
"description": ""
}
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": ""
},
"hash": {
"type": "string",
"description": ""
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"anonymous_clients": {
"type": "boolean",
"description": ""
},
"client_authenticated_messaging": {
"type": "boolean",
"description": ""
},
"client_private_messaging": {
"type": "boolean",
"description": ""
},
"client_private_messaging_authenticated_only": {
"type": "boolean",
"description": ""
},
"client_public_messaging": {
"type": "boolean",
"description": ""
},
"client_public_messaging_authenticated_only": {
"type": "boolean",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"enabled": {
"type": "boolean",
"description": ""
},
"history": {
"type": "string",
"description": "",
"enum": [
0,
25,
50,
100,
250,
1000
]
},
"id": {
"type": "integer",
"format": "int64",
"description": ""
},
"pattern": {
"type": "string",
"description": ""
},
"presence": {
"type": "boolean",
"description": ""
},
"wildcard": {
"type": "boolean",
"description": ""
}
},
"required": [
"pattern"
]
}
}
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": ""
},
"hash": {
"type": "string",
"description": ""
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"anonymous_clients": {
"type": "boolean",
"description": ""
},
"client_authenticated_messaging": {
"type": "boolean",
"description": ""
},
"client_private_messaging": {
"type": "boolean",
"description": ""
},
"client_private_messaging_authenticated_only": {
"type": "boolean",
"description": ""
},
"client_public_messaging": {
"type": "boolean",
"description": ""
},
"client_public_messaging_authenticated_only": {
"type": "boolean",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"enabled": {
"type": "boolean",
"description": ""
},
"history": {
"type": "string",
"description": "",
"enum": [
0,
25,
50,
100,
250,
1000
]
},
"id": {
"type": "integer",
"format": "int64",
"description": ""
},
"pattern": {
"type": "string",
"description": ""
},
"presence": {
"type": "boolean",
"description": ""
},
"wildcard": {
"type": "boolean",
"description": ""
}
},
"required": [
"pattern"
]
}
}
}
}
}
}
}
}
},
"/workspace/{workspace_id}/request_history/search": {
"post": {
"summary": "Search API request history using advanced filters and custom sorting options",
"description": "Search API request history using advanced filters and custom sorting options\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Request History: Read",
"tags": [
"request history"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"curPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"nextPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"prevPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-12 18:34:01+0000"
},
"duration": {
"type": "number",
"description": "",
"default": 0.025
},
"status": {
"type": "integer",
"format": "int64",
"description": "",
"default": 200
},
"verb": {
"type": "string",
"description": "",
"default": "GET"
},
"uri": {
"type": "string",
"description": "",
"default": "https://x1234-4567-8901.n7.xano.com/api:meta"
},
"input": {
"type": "object",
"description": "",
"default": {
"page": 1
}
},
"request_headers": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"Accept: application/json"
]
},
"response_headers": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"Content-Type: application/json"
]
},
"workspace_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"branch_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"api_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"query_id": {
"type": "integer",
"format": "int64",
"description": ""
}
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"per_page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 50
},
"branch": {
"type": "string",
"description": ""
},
"apigroup_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"query_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"search": {
"type": "object",
"description": ""
},
"sort": {
"type": "object",
"description": ""
},
"include_output": {
"type": "boolean",
"description": ""
}
},
"example": {
"page": 1,
"per_page": 50,
"branch": null,
"apigroup_id": null,
"query_id": null,
"sort": {
"created_at": "desc"
},
"search": []
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"per_page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 50
},
"branch": {
"type": "string",
"description": ""
},
"apigroup_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"query_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"search": {
"type": "object",
"description": ""
},
"sort": {
"type": "object",
"description": ""
},
"include_output": {
"type": "boolean",
"description": ""
}
},
"example": {
"page": 1,
"per_page": 50,
"branch": null,
"apigroup_id": null,
"query_id": null,
"sort": {
"created_at": "desc"
},
"search": []
}
}
}
}
}
}
},
"/workspace/{workspace_id}/request_history": {
"get": {
"summary": "Retrieve API request history with optional filtering and pagination",
"description": "Retrieve API request history with optional filtering and pagination\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Request History: Read",
"tags": [
"request history"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 50
}
},
{
"name": "branch",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "apigroup_id",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 0
}
},
{
"name": "query_id",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 0
}
},
{
"name": "include_output",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"curPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"nextPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"prevPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-12 18:34:01+0000"
},
"duration": {
"type": "number",
"description": "",
"default": 0.025
},
"status": {
"type": "integer",
"format": "int64",
"description": "",
"default": 200
},
"verb": {
"type": "string",
"description": "",
"default": "GET"
},
"uri": {
"type": "string",
"description": "",
"default": "https://x1234-4567-8901.n7.xano.com/api:meta"
},
"input": {
"type": "object",
"description": "",
"default": {
"page": 1
}
},
"request_headers": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"Accept: application/json"
]
},
"response_headers": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"Content-Type: application/json"
]
},
"workspace_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"branch_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"api_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"query_id": {
"type": "integer",
"format": "int64",
"description": ""
}
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/autocomplete": {
"put": {
"summary": "update workspace table's autocomplete",
"description": "update workspace table's autocomplete\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Update",
"tags": [
"table"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"autocomplete": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"deprecated": true,
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"autocomplete": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
}
},
"required": [
"name"
]
}
}
},
"example": {
"autocomplete": [
{
"name": "id"
}
]
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"autocomplete": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
}
},
"required": [
"name"
]
}
}
},
"example": {
"autocomplete": [
{
"name": "id"
}
]
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/content/bulk/delete": {
"post": {
"summary": "Delete multiple records by their IDs in a single operation",
"description": "The request body should contain an array of **row_ids**, where each id identifies a row to be deleted.\n
\nRequired API Scope:\nWorkspace Content: Delete",
"tags": [
"table / content"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-data-source",
"in": "header",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": "live"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "array",
"items": {
"type": "string",
"description": ""
}
},
"success_total": {
"type": "integer",
"format": "int64",
"description": ""
},
"error": {
"type": "array",
"items": {
"type": "string",
"description": ""
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"row_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {
"row_ids": [
1
]
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"row_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {
"row_ids": [
1
]
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/content/bulk/patch": {
"post": {
"summary": "Update multiple records in a single batch operation",
"description": "The request body should contain an array of **items**, where each item represents a row to be updated. For each row, provide the **row_id** and **updates** array that specifies the columns (**path**) to update and the new values (**value**).\nThe example below is assuming that the table being modified has a column labeled *name*.\n\n
\nRequired API Scope:\nWorkspace Content: Update",
"tags": [
"table / content"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "x-data-source",
"in": "header",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": "live"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "array",
"items": {
"type": "string",
"description": ""
}
},
"success_total": {
"type": "integer",
"format": "int64",
"description": ""
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"updates": {
"type": "object",
"description": ""
},
"row_id": {
"type": "string"
}
},
"required": [
"row_id"
]
}
}
},
"example": {
"items": [
{
"row_id": 1,
"updates": {
"name": "test name"
}
}
]
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"updates": {
"type": "object",
"description": ""
},
"row_id": {
"type": "string"
}
},
"required": [
"row_id"
]
}
}
},
"example": {
"items": [
{
"row_id": 1,
"updates": {
"name": "test name"
}
}
]
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/content/bulk": {
"post": {
"summary": "Create multiple records in a single batch operation",
"description": "Each table has unique schema, which means that the request body should be an array of objects with the schema relevant to the table being used.\nThe example below is assuming that the table has a column labeled \"name\".\n\n
\nRequired API Scope:\nWorkspace Content: Create",
"tags": [
"table / content"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "x-data-source",
"in": "header",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": "live"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64",
"description": ""
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"allow_id_field": {
"type": "boolean",
"description": ""
},
"items": {
"type": "object",
"description": ""
}
},
"required": [
"items"
],
"example": {
"items": [
{
"name": "test name"
}
],
"allow_id_field": false
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"allow_id_field": {
"type": "boolean",
"description": ""
},
"items": {
"type": "object",
"description": ""
}
},
"required": [
"items"
],
"example": {
"items": [
{
"name": "test name"
}
],
"allow_id_field": false
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/content/search/delete": {
"post": {
"summary": "Delete all records matching specified search criteria",
"description": "Provide search criteria to delete all matching rows.\n
\nRequired API Scope:\nWorkspace Content: Delete",
"tags": [
"table / content"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "x-data-source",
"in": "header",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": "live"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "array",
"items": {
"type": "string",
"description": ""
}
},
"success_total": {
"type": "integer",
"format": "int64",
"description": ""
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"search": {
"type": "object",
"description": ""
}
},
"example": {
"search": []
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"search": {
"type": "object",
"description": ""
}
},
"example": {
"search": []
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/content/search/patch": {
"post": {
"summary": "Update all records matching specified search criteria",
"description": "Provide search and update objects with path and new value to patch rows matching search criteria.\n
\nRequired API Scope:\nWorkspace Content: Update",
"tags": [
"table / content"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "x-data-source",
"in": "header",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": "live"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "array",
"items": {
"type": "string",
"description": ""
}
},
"success_total": {
"type": "integer",
"format": "int64",
"description": ""
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"search": {
"type": "object",
"description": ""
},
"updates": {
"type": "object",
"description": ""
}
},
"example": {
"search": [
{
"name": "test"
}
],
"updates": {
"name": "new name"
}
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"search": {
"type": "object",
"description": ""
},
"updates": {
"type": "object",
"description": ""
}
},
"example": {
"search": [
{
"name": "test"
}
],
"updates": {
"name": "new name"
}
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/content/search": {
"post": {
"summary": "Search table records with advanced filtering and sorting options",
"description": "Search table records with advanced filtering and sorting options\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Content: Read",
"tags": [
"table / content"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "x-data-source",
"in": "header",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": "live"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "object",
"description": ""
},
"itemsReceived": {
"type": "integer",
"format": "int64",
"description": ""
},
"curPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"nextPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"prevPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"offset": {
"type": "integer",
"format": "int64",
"description": ""
},
"perPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"itemsTotal": {
"type": "integer",
"format": "int64",
"description": ""
},
"pageTotal": {
"type": "integer",
"format": "int64",
"description": ""
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"per_page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 50
},
"sort": {
"type": "object",
"description": ""
},
"search": {
"type": "object",
"description": ""
}
},
"example": {
"page": 1,
"per_page": 50,
"sort": {
"id": "desc"
},
"search": []
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"per_page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 50
},
"sort": {
"type": "object",
"description": ""
},
"search": {
"type": "object",
"description": ""
}
},
"example": {
"page": 1,
"per_page": 50,
"sort": {
"id": "desc"
},
"search": []
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/content/{content_id}": {
"delete": {
"summary": "Delete a specific record by ID",
"description": "Delete a specific record by ID\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Content: Delete",
"tags": [
"table / content"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "content_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-data-source",
"in": "header",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": "live"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": ""
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"get": {
"summary": "Retrieve a specific record by ID",
"description": "Retrieve a specific record by ID\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Content: Read",
"tags": [
"table / content"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "content_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-data-source",
"in": "header",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": "live"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": ""
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"put": {
"summary": "Update a specific record by ID",
"description": "Each table has unique schema, which means that the request body should be updated with the schema relevant to the table being used.\nThe example below is assuming that the table has a column labeled \"name\".\n\n
\nRequired API Scope:\nWorkspace Content: Update",
"tags": [
"table / content"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "content_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-data-source",
"in": "header",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": "live"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": ""
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "",
"example": {
"name": "test name"
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/content": {
"get": {
"summary": "Retrieve paginated records from a table",
"description": "Retrieve paginated records from a table\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Content: Read",
"tags": [
"table / content"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "x-data-source",
"in": "header",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": "live"
}
},
{
"name": "page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 50
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "object",
"description": ""
},
"itemsReceived": {
"type": "integer",
"format": "int64",
"description": ""
},
"curPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"nextPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"prevPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"offset": {
"type": "integer",
"format": "int64",
"description": ""
},
"perPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"itemsTotal": {
"type": "integer",
"format": "int64",
"description": ""
},
"pageTotal": {
"type": "integer",
"format": "int64",
"description": ""
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"post": {
"summary": "Create a new record in the table",
"description": "Each table has unique schema, which means that the request body should be updated with the schema relevant to the table being used.\nThe example below is assuming that the table has a column labeled \"name\".\n\n
\nRequired API Scope:\nWorkspace Content: Create",
"tags": [
"table / content"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "x-data-source",
"in": "header",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": "live"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": ""
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "",
"example": {
"name": "test name"
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/index/btree": {
"post": {
"summary": "Create a btree index on table columns to optimize query performance",
"description": "Create a btree index on table columns to optimize query performance\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / index"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"op": {
"type": "string",
"description": "",
"enum": [
"asc",
"desc"
]
}
},
"required": [
"name",
"op"
]
}
}
},
"required": [
"fields"
],
"example": {
"fields": [
{
"name": "name",
"op": "desc"
}
]
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"op": {
"type": "string",
"description": "",
"enum": [
"asc",
"desc"
]
}
},
"required": [
"name",
"op"
]
}
}
},
"required": [
"fields"
],
"example": {
"fields": [
{
"name": "name",
"op": "desc"
}
]
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/index/search": {
"post": {
"summary": "Create a full-text search index for table columns with language-specific optimization",
"description": "Create a full-text search index for table columns with language-specific optimization\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / index"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"lang": {
"type": "string",
"description": "",
"enum": [
"simple",
"arabic",
"danish",
"dutch",
"english",
"finnish",
"french",
"german",
"hungarian",
"indonesian",
"irish",
"italian",
"lithuanian",
"nepali",
"norwegian",
"portuguese",
"romanian",
"russian",
"spanish",
"swedish",
"tamil",
"turkish"
]
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"priority": {
"type": "integer",
"format": "int64",
"description": ""
}
},
"required": [
"name",
"priority"
]
}
}
},
"required": [
"name",
"lang",
"fields"
],
"example": {
"name": "search_label",
"lang": "english",
"fields": [
{
"name": "name",
"priority": 1
}
]
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"lang": {
"type": "string",
"description": "",
"enum": [
"simple",
"arabic",
"danish",
"dutch",
"english",
"finnish",
"french",
"german",
"hungarian",
"indonesian",
"irish",
"italian",
"lithuanian",
"nepali",
"norwegian",
"portuguese",
"romanian",
"russian",
"spanish",
"swedish",
"tamil",
"turkish"
]
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"priority": {
"type": "integer",
"format": "int64",
"description": ""
}
},
"required": [
"name",
"priority"
]
}
}
},
"required": [
"name",
"lang",
"fields"
],
"example": {
"name": "search_label",
"lang": "english",
"fields": [
{
"name": "name",
"priority": 1
}
]
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/index/spatial": {
"post": {
"summary": "Create a spatial index on a table for optimized geometry operations",
"description": "Create a spatial index on a table for optimized geometry operations\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / index"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"op": {
"type": "string",
"description": "",
"enum": [
"gist_geometry_ops_2d"
]
}
},
"required": [
"name",
"op"
]
}
}
},
"required": [
"fields"
],
"example": {
"fields": [
{
"name": "location",
"op": "gist_geometry_ops_2d"
}
]
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"op": {
"type": "string",
"description": "",
"enum": [
"gist_geometry_ops_2d"
]
}
},
"required": [
"name",
"op"
]
}
}
},
"required": [
"fields"
],
"example": {
"fields": [
{
"name": "location",
"op": "gist_geometry_ops_2d"
}
]
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/index/unique": {
"post": {
"summary": "Create a unique index on table fields to enforce data uniqueness and improve query performance",
"description": "Create a unique index on table fields to enforce data uniqueness and improve query performance\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / index"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"op": {
"type": "string",
"description": "",
"enum": [
"asc",
"desc"
]
}
},
"required": [
"name",
"op"
]
}
}
},
"required": [
"fields"
],
"example": {
"fields": [
{
"name": "name",
"op": "desc"
}
]
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"op": {
"type": "string",
"description": "",
"enum": [
"asc",
"desc"
]
}
},
"required": [
"name",
"op"
]
}
}
},
"required": [
"fields"
],
"example": {
"fields": [
{
"name": "name",
"op": "desc"
}
]
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/index/vector": {
"post": {
"summary": "Create a vector index on a table column with support for Inner Product, Cosine, L1, and L2 distance operations",
"description": "Options include `vector_ip_ops` (Inner Product), `vector_cosine_ops` (Cosine), `vector_l1_ops` (L1 Distance), `vector_l2_ops` (L2 Distance)\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / index"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"op": {
"type": "string",
"description": "",
"enum": [
"vector_ip_ops",
"vector_cosine_ops",
"vector_l1_ops",
"vector_l2_ops"
]
}
},
"required": [
"name",
"op"
]
}
}
},
"required": [
"fields"
],
"example": {
"fields": [
{
"name": "name",
"op": "vector_ip_ops"
}
]
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"op": {
"type": "string",
"description": "",
"enum": [
"vector_ip_ops",
"vector_cosine_ops",
"vector_l1_ops",
"vector_l2_ops"
]
}
},
"required": [
"name",
"op"
]
}
}
},
"required": [
"fields"
],
"example": {
"fields": [
{
"name": "name",
"op": "vector_ip_ops"
}
]
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/index/{index_id}": {
"delete": {
"summary": "Delete a specific table index. This action cannot be undone.",
"description": "Delete a specific table index. This action cannot be undone.\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Delete",
"tags": [
"table / index"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "index_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": ""
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/index": {
"get": {
"summary": "Retrieve all indexes for a database table",
"description": "Retrieve all indexes for a database table\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Read",
"tags": [
"table / index"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": ""
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"put": {
"summary": "Replace all indexes for a database table with new index configuration",
"description": "Replace all indexes for a database table with new index configuration\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Update",
"tags": [
"table / index"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": ""
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"index": {
"type": "object",
"description": ""
}
},
"required": [
"index"
],
"example": {
"index": [
{
"type": "primary",
"fields": [
{
"name": "id"
}
]
},
{
"type": "btree",
"fields": [
{
"name": "created_at",
"op": "desc"
}
]
}
]
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"index": {
"type": "object",
"description": ""
}
},
"required": [
"index"
],
"example": {
"index": [
{
"type": "primary",
"fields": [
{
"name": "id"
}
]
},
{
"type": "btree",
"fields": [
{
"name": "created_at",
"op": "desc"
}
]
}
]
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/meta": {
"put": {
"summary": "Update table properties including name, description, tags, and authentication settings",
"description": "Update table properties including name, description, tags, and authentication settings\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Update",
"tags": [
"table"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"deprecated": true,
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "",
"nullable": true
},
"description": {
"type": "string",
"description": "",
"nullable": true
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"nullable": true
},
"auth": {
"type": "boolean",
"description": "",
"nullable": true
}
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "",
"nullable": true
},
"description": {
"type": "string",
"description": "",
"nullable": true
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"nullable": true
},
"auth": {
"type": "boolean",
"description": "",
"nullable": true
}
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/rename": {
"post": {
"summary": "Rename a column in a table's schema",
"description": "Rename a column in a table's schema\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Update",
"tags": [
"table / schema"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"new_name": {
"type": "string",
"description": ""
},
"old_name": {
"type": "string",
"description": ""
}
},
"required": [
"new_name",
"old_name"
],
"example": {
"new_name": "new_field",
"old_name": "old_field"
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"new_name": {
"type": "string",
"description": ""
},
"old_name": {
"type": "string",
"description": ""
}
},
"required": [
"new_name",
"old_name"
],
"example": {
"new_name": "new_field",
"old_name": "old_field"
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/attachment": {
"post": {
"summary": "Create an attachment column for file uploads in a database table",
"description": "Create an attachment column for file uploads in a database table\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "attachment"
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "attachment"
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/audio": {
"post": {
"summary": "Create an audio file column for storing audio uploads and media",
"description": "Create an audio file column for storing audio uploads and media\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "audio"
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "audio"
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/bool": {
"post": {
"summary": "Create a boolean column with true/false values and optional default settings",
"description": "Create a boolean column with true/false values and optional default settings\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"default": {
"type": "boolean",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "finished",
"default": false
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"default": {
"type": "boolean",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "finished",
"default": false
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/date": {
"post": {
"summary": "Create a date column for storing calendar dates without time information",
"description": "Create a date column for storing calendar dates without time information\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "completed_at"
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "completed_at"
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/decimal": {
"post": {
"summary": "Create a decimal column for precise numeric values with configurable min/max limits",
"description": "Create a decimal column for precise numeric values with configurable min/max limits\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"default": {
"type": "number",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
},
"filters": {
"type": "object",
"properties": {
"min": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"max": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
}
},
"nullable": true
}
},
"required": [
"name"
],
"example": {
"name": "score",
"default": 100
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"default": {
"type": "number",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
},
"filters": {
"type": "object",
"properties": {
"min": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"max": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
}
},
"nullable": true
}
},
"required": [
"name"
],
"example": {
"name": "score",
"default": 100
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/email": {
"post": {
"summary": "Create an email column with built-in email format validation",
"description": "Create an email column with built-in email format validation\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"default": {
"type": "string",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "email"
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"default": {
"type": "string",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "email"
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/enum": {
"post": {
"summary": "Create an enum column with predefined value options for dropdown selections",
"description": "Create an enum column with predefined value options for dropdown selections\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"default": {
"type": "string",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
},
"values": {
"type": "array",
"items": {
"type": "string",
"description": ""
}
}
},
"required": [
"name"
],
"example": {
"name": "status",
"values": [
"To Do",
"In Progress",
"Done",
"Pending"
]
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"default": {
"type": "string",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
},
"values": {
"type": "array",
"items": {
"type": "string",
"description": ""
}
}
},
"required": [
"name"
],
"example": {
"name": "status",
"values": [
"To Do",
"In Progress",
"Done",
"Pending"
]
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/geo_linestring": {
"post": {
"summary": "Create a geographic linestring column for storing connected coordinate paths",
"description": "Create a geographic linestring column for storing connected coordinate paths\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "line"
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "line"
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/geo_multilinestring": {
"post": {
"summary": "Create a geographic multilinestring column for storing multiple coordinate paths",
"description": "Create a geographic multilinestring column for storing multiple coordinate paths\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "lines"
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "lines"
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/geo_multipoint": {
"post": {
"summary": "Create a geographic multipoint column for storing collections of coordinate points",
"description": "Create a geographic multipoint column for storing collections of coordinate points\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "points"
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "points"
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/geo_multipolygon": {
"post": {
"summary": "Create a geographic multipolygon column for storing complex area boundaries",
"description": "Create a geographic multipolygon column for storing complex area boundaries\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "polygons"
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "polygons"
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/geo_point": {
"post": {
"summary": "Create a geographic point column for storing latitude/longitude coordinates",
"description": "Create a geographic point column for storing latitude/longitude coordinates\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "point"
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "point"
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/geo_polygon": {
"post": {
"summary": "Create a geographic polygon column for storing area boundaries and shapes",
"description": "Create a geographic polygon column for storing area boundaries and shapes\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"required": {
"type": "boolean",
"description": ""
},
"sensitive": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "polygon"
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"required": {
"type": "boolean",
"description": ""
},
"sensitive": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "polygon"
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/image": {
"post": {
"summary": "Create an image column for storing photo uploads and visual media",
"description": "Create an image column for storing photo uploads and visual media\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "image"
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "image"
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/int": {
"post": {
"summary": "Create an integer column for whole numbers with configurable min/max limits",
"description": "Create an integer column for whole numbers with configurable min/max limits\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"default": {
"type": "integer",
"format": "int64",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
},
"filters": {
"type": "object",
"properties": {
"min": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"max": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
}
},
"nullable": true
}
},
"required": [
"name"
],
"example": {
"name": "score",
"default": 100
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"default": {
"type": "integer",
"format": "int64",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
},
"filters": {
"type": "object",
"properties": {
"min": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"max": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
}
},
"nullable": true
}
},
"required": [
"name"
],
"example": {
"name": "score",
"default": 100
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/json": {
"post": {
"summary": "Create a JSON column for storing structured data objects and arrays",
"description": "Create a JSON column for storing structured data objects and arrays\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "data"
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "data"
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/object": {
"post": {
"summary": "Create an object column with nested child fields for complex data structures",
"description": "Create an object column with nested child fields for complex data structures\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
},
"children": {
"type": "object",
"description": ""
}
},
"required": [
"name"
],
"example": {
"name": "group",
"children": [
{
"name": "name",
"type": "text"
},
{
"name": "score",
"type": "int"
}
]
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
},
"children": {
"type": "object",
"description": ""
}
},
"required": [
"name"
],
"example": {
"name": "group",
"children": [
{
"name": "name",
"type": "text"
},
{
"name": "score",
"type": "int"
}
]
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/password": {
"post": {
"summary": "Create a password column with automatic hashing and complexity validation rules",
"description": "Create a password column with automatic hashing and complexity validation rules\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
},
"filters": {
"type": "object",
"properties": {
"salt": {
"type": "string",
"description": "",
"nullable": true
},
"min": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"max": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"minAlpha": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"minLowerAlpha": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"minUpperAlpha": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"minDigit": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"minSymbol": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
}
},
"nullable": true
}
},
"required": [
"name"
],
"example": {
"name": "password",
"filters": {
"min": 8,
"max": 64,
"minAlpha": 1,
"minDigit": 1,
"minSymbol": 1
}
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
},
"filters": {
"type": "object",
"properties": {
"salt": {
"type": "string",
"description": "",
"nullable": true
},
"min": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"max": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"minAlpha": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"minLowerAlpha": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"minUpperAlpha": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"minDigit": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"minSymbol": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
}
},
"nullable": true
}
},
"required": [
"name"
],
"example": {
"name": "password",
"filters": {
"min": 8,
"max": 64,
"minAlpha": 1,
"minDigit": 1,
"minSymbol": 1
}
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/tablerefuuid": {
"post": {
"summary": "Create a UUID-based table reference column for relationships with UUID primary keys",
"description": "Create a UUID-based table reference column for relationships with UUID primary keys\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"tableref_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name",
"tableref_id"
],
"example": {
"name": "user_id",
"tableref_id": 101
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"tableref_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name",
"tableref_id"
],
"example": {
"name": "user_id",
"tableref_id": 101
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/tableref": {
"post": {
"summary": "Create a table reference column to establish relationships with other database tables",
"description": "Create a table reference column to establish relationships with other database tables\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"tableref_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
},
"filters": {
"type": "object",
"properties": {
"min": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"max": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
}
},
"nullable": true
}
},
"required": [
"name",
"tableref_id"
],
"example": {
"name": "user_id",
"tableref_id": 101
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"tableref_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
},
"filters": {
"type": "object",
"properties": {
"min": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"max": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
}
},
"nullable": true
}
},
"required": [
"name",
"tableref_id"
],
"example": {
"name": "user_id",
"tableref_id": 101
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/text": {
"post": {
"summary": "Create a text column with formatting options and customizable validation rules",
"description": "Create a text column with formatting options and customizable validation rules\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"default": {
"type": "string",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
},
"format": {
"type": "string",
"description": "",
"enum": [
"",
"plaintext",
"yaml",
"html",
"xml",
"markdown"
]
},
"filters": {
"type": "object",
"properties": {
"trim": {
"type": "boolean",
"description": "",
"nullable": true
},
"min": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"max": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"lower": {
"type": "boolean",
"description": "",
"nullable": true
},
"upper": {
"type": "boolean",
"description": "",
"nullable": true
},
"startsWith": {
"type": "string",
"description": "",
"nullable": true
},
"alphaOk": {
"type": "boolean",
"description": "",
"nullable": true
},
"digitOk": {
"type": "boolean",
"description": "",
"nullable": true
},
"pattern": {
"type": "string",
"description": "",
"nullable": true
},
"ok": {
"type": "string",
"description": "",
"nullable": true
}
},
"nullable": true
}
},
"required": [
"name"
],
"example": {
"name": "name",
"filters": {
"trim": true,
"max": 100
}
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"default": {
"type": "string",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
},
"format": {
"type": "string",
"description": "",
"enum": [
"",
"plaintext",
"yaml",
"html",
"xml",
"markdown"
]
},
"filters": {
"type": "object",
"properties": {
"trim": {
"type": "boolean",
"description": "",
"nullable": true
},
"min": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"max": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"lower": {
"type": "boolean",
"description": "",
"nullable": true
},
"upper": {
"type": "boolean",
"description": "",
"nullable": true
},
"startsWith": {
"type": "string",
"description": "",
"nullable": true
},
"alphaOk": {
"type": "boolean",
"description": "",
"nullable": true
},
"digitOk": {
"type": "boolean",
"description": "",
"nullable": true
},
"pattern": {
"type": "string",
"description": "",
"nullable": true
},
"ok": {
"type": "string",
"description": "",
"nullable": true
}
},
"nullable": true
}
},
"required": [
"name"
],
"example": {
"name": "name",
"filters": {
"trim": true,
"max": 100
}
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/timestamp": {
"post": {
"summary": "Create a timestamp column for storing precise date and time values",
"description": "Create a timestamp column for storing precise date and time values\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "completed_at"
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "completed_at"
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/uuid": {
"post": {
"summary": "Create a UUID column for generating universally unique identifiers",
"description": "Create a UUID column for generating universally unique identifiers\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"default": {
"type": "integer",
"format": "int64",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "user_id"
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"default": {
"type": "integer",
"format": "int64",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "user_id"
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/vector": {
"post": {
"summary": "Create a vector column for storing multi-dimensional data used in AI and ML applications",
"description": "Create a vector column for storing multi-dimensional data used in AI and ML applications\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"default": {
"type": "string",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
},
"vector": {
"type": "object",
"properties": {
"size": {
"type": "integer",
"format": "int64",
"description": "",
"default": 3
}
}
},
"filters": {
"type": "object",
"properties": {
"min": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"max": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
}
},
"nullable": true
}
},
"required": [
"name",
"vector"
],
"example": {
"name": "name",
"vector": {
"size": 3
}
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"default": {
"type": "string",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
},
"vector": {
"type": "object",
"properties": {
"size": {
"type": "integer",
"format": "int64",
"description": "",
"default": 3
}
}
},
"filters": {
"type": "object",
"properties": {
"min": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"max": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
}
},
"nullable": true
}
},
"required": [
"name",
"vector"
],
"example": {
"name": "name",
"vector": {
"size": 3
}
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/type/video": {
"post": {
"summary": "Create a video file column for storing video uploads and media content",
"description": "Create a video file column for storing video uploads and media content\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Create",
"tags": [
"table / schema / type"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "video"
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": "",
"default": true
},
"required": {
"type": "boolean",
"description": ""
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"sensitive": {
"type": "boolean",
"description": ""
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
}
},
"required": [
"name"
],
"example": {
"name": "video"
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema/{schema_name}": {
"delete": {
"summary": "Delete a column from a table's schema. This action cannot be undone.",
"description": "Delete a column from a table's schema. This action cannot be undone.\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Delete",
"tags": [
"table / schema"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "schema_name",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": ""
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"get": {
"summary": "Retrieve details for a specific column in a table's schema",
"description": "Retrieve details for a specific column in a table's schema\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Read",
"tags": [
"table / schema"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "schema_name",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": ""
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/schema": {
"get": {
"summary": "Retrieve the complete schema definition for a database table",
"description": "Retrieve the complete schema definition for a database table\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Read",
"tags": [
"table / schema"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": ""
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"put": {
"summary": "Replace the entire schema definition for a database table",
"description": "Replace the entire schema definition for a database table\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Database: Update",
"tags": [
"table / schema"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": ""
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"type": {
"type": "string",
"description": "",
"enum": [
"attachment",
"audio",
"bool",
"date",
"decimal",
"email",
"enum",
"geo_linestring",
"geo_multilinestring",
"geo_multipoint",
"geo_multipolygon",
"geo_point",
"geo_polygon",
"image",
"int",
"json",
"object",
"password",
"text",
"timestamp",
"uuid",
"vector",
"video"
]
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"default": {
"type": "string",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"values": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
},
"sensitive": {
"type": "boolean",
"description": ""
},
"format": {
"type": "string",
"description": "",
"enum": [
"",
"plaintext",
"yaml",
"html",
"xml",
"markdown"
],
"nullable": true
},
"tableref_id": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"type": {
"type": "string",
"description": "",
"enum": [
"attachment",
"audio",
"bool",
"date",
"decimal",
"email",
"enum",
"geo_linestring",
"geo_multilinestring",
"geo_multipoint",
"geo_multipolygon",
"geo_point",
"geo_polygon",
"image",
"int",
"json",
"object",
"password",
"text",
"timestamp",
"uuid",
"vector",
"video"
]
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"default": {
"type": "string",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"values": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
},
"sensitive": {
"type": "boolean",
"description": ""
},
"format": {
"type": "string",
"description": "",
"enum": [
"",
"plaintext",
"yaml",
"html",
"xml",
"markdown"
],
"nullable": true
},
"tableref_id": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"vector": {
"type": "object",
"properties": {
"size": {
"type": "integer",
"format": "int64",
"description": "",
"default": 3
}
}
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
},
"validators": {
"type": "object",
"properties": {
"trim": {
"type": "boolean",
"description": ""
},
"lower": {
"type": "boolean",
"description": ""
}
},
"nullable": true
}
},
"required": [
"name",
"type",
"nullable",
"required"
]
}
},
"vector": {
"type": "object",
"properties": {
"size": {
"type": "integer",
"format": "int64",
"description": "",
"default": 3
}
}
},
"validators": {
"type": "object",
"properties": {
"trim": {
"type": "boolean",
"description": ""
},
"lower": {
"type": "boolean",
"description": ""
}
},
"nullable": true
}
},
"required": [
"name",
"type",
"nullable",
"required"
]
}
}
},
"required": [
"schema"
],
"example": {
"schema": [
{
"name": "id",
"type": "int",
"description": "",
"nullable": false,
"default": "",
"required": true,
"access": "public",
"sensitive": false,
"style": "single"
},
{
"name": "created_at",
"type": "timestamp",
"description": "",
"nullable": false,
"default": "",
"required": true,
"access": "public",
"sensitive": false,
"style": "single"
},
{
"name": "name",
"type": "text",
"description": "",
"nullable": false,
"default": "",
"required": true,
"access": "public",
"sensitive": false,
"style": "single"
}
]
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"type": {
"type": "string",
"description": "",
"enum": [
"attachment",
"audio",
"bool",
"date",
"decimal",
"email",
"enum",
"geo_linestring",
"geo_multilinestring",
"geo_multipoint",
"geo_multipolygon",
"geo_point",
"geo_polygon",
"image",
"int",
"json",
"object",
"password",
"text",
"timestamp",
"uuid",
"vector",
"video"
]
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"default": {
"type": "string",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"values": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
},
"sensitive": {
"type": "boolean",
"description": ""
},
"format": {
"type": "string",
"description": "",
"enum": [
"",
"plaintext",
"yaml",
"html",
"xml",
"markdown"
],
"nullable": true
},
"tableref_id": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"type": {
"type": "string",
"description": "",
"enum": [
"attachment",
"audio",
"bool",
"date",
"decimal",
"email",
"enum",
"geo_linestring",
"geo_multilinestring",
"geo_multipoint",
"geo_multipolygon",
"geo_point",
"geo_polygon",
"image",
"int",
"json",
"object",
"password",
"text",
"timestamp",
"uuid",
"vector",
"video"
]
},
"description": {
"type": "string",
"description": ""
},
"nullable": {
"type": "boolean",
"description": ""
},
"default": {
"type": "string",
"description": ""
},
"required": {
"type": "boolean",
"description": ""
},
"values": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
},
"sensitive": {
"type": "boolean",
"description": ""
},
"format": {
"type": "string",
"description": "",
"enum": [
"",
"plaintext",
"yaml",
"html",
"xml",
"markdown"
],
"nullable": true
},
"tableref_id": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"vector": {
"type": "object",
"properties": {
"size": {
"type": "integer",
"format": "int64",
"description": "",
"default": 3
}
}
},
"access": {
"type": "string",
"description": "",
"enum": [
"public",
"private",
"internal"
],
"default": "public"
},
"style": {
"type": "string",
"description": "",
"enum": [
"single",
"list"
],
"default": "single"
},
"children": {
"type": "array",
"items": {
"type": "object",
"description": ""
}
},
"validators": {
"type": "object",
"properties": {
"trim": {
"type": "boolean",
"description": ""
},
"lower": {
"type": "boolean",
"description": ""
}
},
"nullable": true
}
},
"required": [
"name",
"type",
"nullable",
"required"
]
}
},
"vector": {
"type": "object",
"properties": {
"size": {
"type": "integer",
"format": "int64",
"description": "",
"default": 3
}
}
},
"validators": {
"type": "object",
"properties": {
"trim": {
"type": "boolean",
"description": ""
},
"lower": {
"type": "boolean",
"description": ""
}
},
"nullable": true
}
},
"required": [
"name",
"type",
"nullable",
"required"
]
}
}
},
"required": [
"schema"
],
"example": {
"schema": [
{
"name": "id",
"type": "int",
"description": "",
"nullable": false,
"default": "",
"required": true,
"access": "public",
"sensitive": false,
"style": "single"
},
{
"name": "created_at",
"type": "timestamp",
"description": "",
"nullable": false,
"default": "",
"required": true,
"access": "public",
"sensitive": false,
"style": "single"
},
{
"name": "name",
"type": "text",
"description": "",
"nullable": false,
"default": "",
"required": true,
"access": "public",
"sensitive": false,
"style": "single"
}
]
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/security": {
"put": {
"summary": "Configure table security rules by assigning an API group GUID or removing restrictions",
"description": "Configure table security rules by assigning an API group GUID or removing restrictions\n
\nAuthentication: required",
"tags": [
"table"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "Test Database"
},
"description": {
"type": "string",
"description": "",
"default": "My test database description"
},
"docs": {
"type": "string",
"description": "",
"default": "Documentation"
},
"guid": {
"type": "string",
"description": "",
"default": "YE1fwVhQ-enRlc6Sb42Gqru58-0"
},
"auth": {
"type": "boolean",
"description": "",
"default": true
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"example tag"
]
},
"xanoscript": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "",
"enum": [
"ok",
"error"
]
},
"value": {
"type": "string",
"description": ""
},
"message": {
"type": "string",
"description": ""
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"description": ""
}
},
"required": [
"guid"
]
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"description": ""
}
},
"required": [
"guid"
]
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}/truncate": {
"delete": {
"summary": "Delete all records from the table and optionally reset the primary key",
"description": "Delete all records from the table and optionally reset the primary key\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Content: Delete",
"tags": [
"table / content"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "x-data-source",
"in": "header",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": "live"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": ""
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"reset": {
"type": "boolean",
"description": ""
}
},
"required": [
"reset"
]
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"reset": {
"type": "boolean",
"description": ""
}
},
"required": [
"reset"
]
}
}
}
}
}
},
"/workspace/{workspace_id}/table/{table_id}": {
"delete": {
"summary": "Delete a database table and all its data permanently",
"description": "Delete a database table and all its data permanently\n
\nAuthentication: required",
"tags": [
"table"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"get": {
"summary": "Retrieve detailed information for a specific table",
"description": "Retrieve detailed information for a specific table\n
\nAuthentication: required",
"tags": [
"table"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "Test Database"
},
"description": {
"type": "string",
"description": "",
"default": "My test database description"
},
"docs": {
"type": "string",
"description": "",
"default": "Documentation"
},
"guid": {
"type": "string",
"description": "",
"default": "YE1fwVhQ-enRlc6Sb42Gqru58-0"
},
"auth": {
"type": "boolean",
"description": "",
"default": true
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"example tag"
]
},
"xanoscript": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "",
"enum": [
"ok",
"error"
]
},
"value": {
"type": "string",
"description": ""
},
"message": {
"type": "string",
"description": ""
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"put": {
"summary": "update workspace table",
"description": "update workspace table\n
\nAuthentication: required",
"tags": [
"table"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "table_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "Test Database"
},
"description": {
"type": "string",
"description": "",
"default": "My test database description"
},
"docs": {
"type": "string",
"description": "",
"default": "Documentation"
},
"guid": {
"type": "string",
"description": "",
"default": "YE1fwVhQ-enRlc6Sb42Gqru58-0"
},
"auth": {
"type": "boolean",
"description": "",
"default": true
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"example tag"
]
},
"xanoscript": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "",
"enum": [
"ok",
"error"
]
},
"value": {
"type": "string",
"description": ""
},
"message": {
"type": "string",
"description": ""
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"text/x-xanoscript": {
"schema": {
"type": "string",
"example": "table book {\n schema {\n int id\n text title\n text description\n }\n index = [\n {type: \"primary\", field: [{name: \"id\"}]}\n ]\n}\n"
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"docs": {
"type": "string",
"description": ""
},
"auth": {
"type": "boolean",
"description": ""
},
"guid": {
"type": "string",
"description": "",
"nullable": true
},
"schema": {
"type": "object",
"description": "",
"nullable": true
},
"index": {
"type": "object",
"description": "",
"nullable": true
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"nullable": true
},
"autocomplete": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
}
},
"required": [
"name"
]
},
"nullable": true
}
},
"example": {
"name": "table 123",
"description": "",
"docs": "",
"auth": null,
"guid": null,
"schema": null,
"index": null,
"autocomplete": [],
"tag": []
}
}
},
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"docs": {
"type": "string",
"description": ""
},
"auth": {
"type": "boolean",
"description": ""
},
"guid": {
"type": "string",
"description": "",
"nullable": true
},
"schema": {
"type": "object",
"description": "",
"nullable": true
},
"index": {
"type": "object",
"description": "",
"nullable": true
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"nullable": true
},
"autocomplete": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
}
},
"required": [
"name"
]
},
"nullable": true
}
},
"example": {
"name": "table 123",
"description": "",
"docs": "",
"auth": null,
"guid": null,
"schema": null,
"index": null,
"autocomplete": [],
"tag": []
}
}
}
}
}
}
},
"/workspace/{workspace_id}/table": {
"get": {
"summary": "Retrieve all tables in a workspace with optional filtering and pagination",
"description": "Retrieve all tables in a workspace with optional filtering and pagination\n
\nAuthentication: required",
"tags": [
"table"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 50
}
},
{
"name": "search",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "sort",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"enum": [
"created_at",
"updated_at",
"name"
],
"default": "name"
}
},
{
"name": "order",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "asc"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"curPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"nextPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"prevPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "Test Database"
},
"description": {
"type": "string",
"description": "",
"default": "My test database description"
},
"docs": {
"type": "string",
"description": "",
"default": "Documentation"
},
"guid": {
"type": "string",
"description": "",
"default": "YE1fwVhQ-enRlc6Sb42Gqru58-0"
},
"auth": {
"type": "boolean",
"description": "",
"default": true
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"example tag"
]
},
"xanoscript": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "",
"enum": [
"ok",
"error"
]
},
"value": {
"type": "string",
"description": ""
},
"message": {
"type": "string",
"description": ""
}
}
}
}
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"post": {
"summary": "Create a new database table with optional schema definition",
"description": "This endpoint can create a complete table in a single API request, as long as all values below are fully fleshed out. If you want to create the table in multiple steps, then just fill out the name field as shown in the example.",
"tags": [
"table"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "Test Database"
},
"description": {
"type": "string",
"description": "",
"default": "My test database description"
},
"docs": {
"type": "string",
"description": "",
"default": "Documentation"
},
"guid": {
"type": "string",
"description": "",
"default": "YE1fwVhQ-enRlc6Sb42Gqru58-0"
},
"auth": {
"type": "boolean",
"description": "",
"default": true
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"example tag"
]
},
"xanoscript": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "",
"enum": [
"ok",
"error"
]
},
"value": {
"type": "string",
"description": ""
},
"message": {
"type": "string",
"description": ""
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"text/x-xanoscript": {
"schema": {
"type": "string",
"example": "table book {\n schema {\n int id\n text title\n text description\n }\n index = [\n {type: \"primary\", field: [{name: \"id\"}]}\n ]\n}\n"
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"docs": {
"type": "string",
"description": ""
},
"auth": {
"type": "boolean",
"description": ""
},
"guid": {
"type": "string",
"description": "",
"nullable": true
},
"schema": {
"type": "object",
"description": "",
"nullable": true
},
"index": {
"type": "object",
"description": "",
"nullable": true
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"nullable": true
},
"autocomplete": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
}
},
"required": [
"name"
]
},
"nullable": true
}
},
"required": [
"name"
],
"example": {
"name": "new table 123",
"description": "",
"docs": "",
"auth": null,
"guid": null,
"schema": null,
"index": null,
"autocomplete": [],
"tag": []
}
}
},
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"docs": {
"type": "string",
"description": ""
},
"auth": {
"type": "boolean",
"description": ""
},
"guid": {
"type": "string",
"description": "",
"nullable": true
},
"schema": {
"type": "object",
"description": "",
"nullable": true
},
"index": {
"type": "object",
"description": "",
"nullable": true
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"nullable": true
},
"autocomplete": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
}
},
"required": [
"name"
]
},
"nullable": true
}
},
"required": [
"name"
],
"example": {
"name": "new table 123",
"description": "",
"docs": "",
"auth": null,
"guid": null,
"schema": null,
"index": null,
"autocomplete": [],
"tag": []
}
}
}
}
}
}
},
"/workspace/{workspace_id}/task/{task_id}/security": {
"put": {
"summary": "Update scheduled task security configuration and access controls",
"description": "Update scheduled task security configuration and access controls\n
\nAuthentication: required",
"tags": [
"task"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "Task Test"
},
"description": {
"type": "string",
"description": "",
"default": "My tasks description"
},
"docs": {
"type": "string",
"description": "",
"default": "Documentation"
},
"guid": {
"type": "string",
"description": "",
"default": "YE1fwVhQ-enRlc6Sb42Gqru58-0"
},
"datasource": {
"type": "string",
"description": "",
"default": "test"
},
"active": {
"type": "boolean",
"description": "",
"default": true
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"example tag"
]
},
"xanoscript": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "",
"enum": [
"ok",
"error"
]
},
"value": {
"type": "string",
"description": ""
},
"message": {
"type": "string",
"description": ""
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"description": ""
}
},
"required": [
"guid"
]
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"description": ""
}
},
"required": [
"guid"
]
}
}
}
}
}
},
"/workspace/{workspace_id}/task/{task_id}": {
"delete": {
"summary": "Delete a scheduled task permanently. This action cannot be undone",
"description": "Delete a scheduled task permanently. This action cannot be undone\n
\nAuthentication: required",
"tags": [
"task"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"get": {
"summary": "Retrieve a specific scheduled task by ID",
"description": "Retrieve a specific scheduled task by ID\n
\nAuthentication: required",
"tags": [
"task"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "include_draft",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "Task Test"
},
"description": {
"type": "string",
"description": "",
"default": "My tasks description"
},
"docs": {
"type": "string",
"description": "",
"default": "Documentation"
},
"guid": {
"type": "string",
"description": "",
"default": "YE1fwVhQ-enRlc6Sb42Gqru58-0"
},
"datasource": {
"type": "string",
"description": "",
"default": "test"
},
"active": {
"type": "boolean",
"description": "",
"default": true
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"example tag"
]
},
"xanoscript": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "",
"enum": [
"ok",
"error"
]
},
"value": {
"type": "string",
"description": ""
},
"message": {
"type": "string",
"description": ""
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"put": {
"summary": "Update task code, schedule settings, and activation status",
"description": "Update task code, schedule settings, and activation status\n
\nAuthentication: required",
"tags": [
"task"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "publish",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "Task Test"
},
"description": {
"type": "string",
"description": "",
"default": "My tasks description"
},
"docs": {
"type": "string",
"description": "",
"default": "Documentation"
},
"guid": {
"type": "string",
"description": "",
"default": "YE1fwVhQ-enRlc6Sb42Gqru58-0"
},
"datasource": {
"type": "string",
"description": "",
"default": "test"
},
"active": {
"type": "boolean",
"description": "",
"default": true
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"example tag"
]
},
"xanoscript": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "",
"enum": [
"ok",
"error"
]
},
"value": {
"type": "string",
"description": ""
},
"message": {
"type": "string",
"description": ""
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"text/x-xanoscript": {
"schema": {
"type": "string",
"example": "task foo {\n stack {\n var $x1 {\n value = $input.score + 1\n }\n }\n schedule {\n events = [{starts_on: 2025-07-25 20:00:12+0000, freq: 900}]\n }\n}\n"
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"docs": {
"type": "string",
"description": ""
},
"datasource": {
"type": "string",
"description": ""
},
"active": {
"type": "boolean",
"description": ""
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"nullable": true
},
"publish": {
"type": "boolean",
"description": "",
"default": true
}
},
"required": [
"name",
"description",
"datasource",
"active"
]
}
},
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"docs": {
"type": "string",
"description": ""
},
"datasource": {
"type": "string",
"description": ""
},
"active": {
"type": "boolean",
"description": ""
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"nullable": true
},
"publish": {
"type": "boolean",
"description": "",
"default": true
}
},
"required": [
"name",
"description",
"datasource",
"active"
]
}
}
}
}
}
},
"/workspace/{workspace_id}/task_history/search": {
"post": {
"summary": "Search task request history using advanced filters and custom sorting options",
"description": "Search task request history using advanced filters and custom sorting options\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Request History: Read",
"tags": [
"request history"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"curPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"nextPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"prevPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-12 18:34:01+0000"
},
"duration": {
"type": "number",
"description": "",
"default": 0.025
},
"input": {
"type": "object",
"description": "",
"default": {
"page": 1
}
},
"workspace_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
},
"task_id": {
"type": "integer",
"format": "int64",
"description": ""
}
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"per_page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 50
},
"branch": {
"type": "string",
"description": ""
},
"task_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"search": {
"type": "object",
"description": ""
},
"sort": {
"type": "object",
"description": ""
},
"include_output": {
"type": "boolean",
"description": ""
}
},
"example": {
"page": 1,
"per_page": 50,
"branch_id": null,
"task_id": null,
"sort": {
"created_at": "desc"
},
"search": []
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"per_page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 50
},
"branch": {
"type": "string",
"description": ""
},
"task_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"search": {
"type": "object",
"description": ""
},
"sort": {
"type": "object",
"description": ""
},
"include_output": {
"type": "boolean",
"description": ""
}
},
"example": {
"page": 1,
"per_page": 50,
"branch_id": null,
"task_id": null,
"sort": {
"created_at": "desc"
},
"search": []
}
}
}
}
}
}
},
"/workspace/{workspace_id}/task_history": {
"get": {
"summary": "Retrieve task request history with optional filtering and pagination",
"description": "Retrieve task request history with optional filtering and pagination\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Request History: Read",
"tags": [
"request history"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 50
}
},
{
"name": "branch",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "task_id",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 0
}
},
{
"name": "include_output",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"curPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"nextPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"prevPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-12 18:34:01+0000"
},
"duration": {
"type": "number",
"description": "",
"default": 0.025
},
"input": {
"type": "object",
"description": "",
"default": {
"page": 1
}
},
"workspace_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
},
"task_id": {
"type": "integer",
"format": "int64",
"description": ""
}
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
}
},
"/workspace/{workspace_id}/task": {
"get": {
"summary": "Retrieve all scheduled tasks in a workspace with optional filtering and pagination",
"description": "Retrieve all scheduled tasks in a workspace with optional filtering and pagination\n
\nAuthentication: required",
"tags": [
"task"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "branch",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "include_draft",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 50
}
},
{
"name": "search",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "sort",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"enum": [
"created_at",
"updated_at",
"name"
],
"default": "created_at"
}
},
{
"name": "order",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "desc"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"curPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"nextPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"prevPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "Task Test"
},
"description": {
"type": "string",
"description": "",
"default": "My tasks description"
},
"docs": {
"type": "string",
"description": "",
"default": "Documentation"
},
"guid": {
"type": "string",
"description": "",
"default": "YE1fwVhQ-enRlc6Sb42Gqru58-0"
},
"datasource": {
"type": "string",
"description": "",
"default": "test"
},
"active": {
"type": "boolean",
"description": "",
"default": true
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"example tag"
]
},
"xanoscript": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "",
"enum": [
"ok",
"error"
]
},
"value": {
"type": "string",
"description": ""
},
"message": {
"type": "string",
"description": ""
}
}
}
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
},
"post": {
"summary": "Create a new scheduled task using XanoScript",
"description": "Create a new scheduled task using XanoScript\n
\nAuthentication: required",
"tags": [
"task"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "branch",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"updated_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-19 21:01:32+0000"
},
"name": {
"type": "string",
"description": "",
"default": "Task Test"
},
"description": {
"type": "string",
"description": "",
"default": "My tasks description"
},
"docs": {
"type": "string",
"description": "",
"default": "Documentation"
},
"guid": {
"type": "string",
"description": "",
"default": "YE1fwVhQ-enRlc6Sb42Gqru58-0"
},
"datasource": {
"type": "string",
"description": "",
"default": "test"
},
"active": {
"type": "boolean",
"description": "",
"default": true
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"default": [
"example tag"
]
},
"xanoscript": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "",
"enum": [
"ok",
"error"
]
},
"value": {
"type": "string",
"description": ""
},
"message": {
"type": "string",
"description": ""
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"text/x-xanoscript": {
"schema": {
"type": "string",
"example": "task foo {\n stack {\n var $x1 {\n value = $input.score + 1\n }\n }\n schedule {\n events = [{starts_on: 2025-07-25 20:00:12+0000, freq: 900}]\n }\n}\n"
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"branch": {
"type": "string",
"description": ""
},
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"docs": {
"type": "string",
"description": ""
},
"datasource": {
"type": "string",
"description": ""
},
"active": {
"type": "boolean",
"description": ""
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"nullable": true
}
},
"required": [
"name",
"description",
"datasource",
"active"
]
}
},
"application/json": {
"schema": {
"type": "object",
"properties": {
"branch": {
"type": "string",
"description": ""
},
"name": {
"type": "string",
"description": ""
},
"description": {
"type": "string",
"description": ""
},
"docs": {
"type": "string",
"description": ""
},
"datasource": {
"type": "string",
"description": ""
},
"active": {
"type": "boolean",
"description": ""
},
"tag": {
"type": "array",
"items": {
"type": "string",
"description": ""
},
"nullable": true
}
},
"required": [
"name",
"description",
"datasource",
"active"
]
}
}
}
}
}
},
"/workspace/{workspace_id}/tool_history/search": {
"post": {
"summary": "Search tool request history using advanced filters and custom sorting options",
"description": "Search tool request history using advanced filters and custom sorting options\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Request History: Read",
"tags": [
"request history"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"curPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"nextPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"prevPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-12 18:34:01+0000"
},
"duration": {
"type": "number",
"description": "",
"default": 0.025
},
"input": {
"type": "object",
"description": "",
"default": {
"page": 1
}
},
"workspace_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
},
"tool_id": {
"type": "integer",
"format": "int64",
"description": ""
}
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"per_page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 50
},
"branch": {
"type": "string",
"description": ""
},
"tool_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"search": {
"type": "object",
"description": ""
},
"sort": {
"type": "object",
"description": ""
},
"include_output": {
"type": "boolean",
"description": ""
}
},
"example": {
"page": 1,
"per_page": 50,
"sort": {
"created_at": "desc"
},
"search": []
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"per_page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 50
},
"branch": {
"type": "string",
"description": ""
},
"tool_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"search": {
"type": "object",
"description": ""
},
"sort": {
"type": "object",
"description": ""
},
"include_output": {
"type": "boolean",
"description": ""
}
},
"example": {
"page": 1,
"per_page": 50,
"sort": {
"created_at": "desc"
},
"search": []
}
}
}
}
}
}
},
"/workspace/{workspace_id}/tool_history": {
"get": {
"summary": "Retrieve tool request history with optional filtering and pagination",
"description": "Retrieve tool request history with optional filtering and pagination\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Request History: Read",
"tags": [
"request history"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 50
}
},
{
"name": "branch",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "tool_id",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 0
}
},
{
"name": "include_output",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"curPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"nextPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"prevPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-12 18:34:01+0000"
},
"duration": {
"type": "number",
"description": "",
"default": 0.025
},
"input": {
"type": "object",
"description": "",
"default": {
"page": 1
}
},
"workspace_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
},
"tool_id": {
"type": "integer",
"format": "int64",
"description": ""
}
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
}
},
"/workspace/{workspace_id}/trigger_history/search": {
"post": {
"summary": "Search trigger request history using advanced filters and custom sorting options",
"description": "Search trigger request history using advanced filters and custom sorting options\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Request History: Read",
"tags": [
"request history"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"curPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"nextPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"prevPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-12 18:34:01+0000"
},
"duration": {
"type": "number",
"description": "",
"default": 0.025
},
"input": {
"type": "object",
"description": "",
"default": {
"page": 1
}
},
"workspace_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"trigger_id": {
"type": "integer",
"format": "int64",
"description": ""
}
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"per_page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 50
},
"trigger_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"search": {
"type": "object",
"description": ""
},
"sort": {
"type": "object",
"description": ""
},
"include_output": {
"type": "boolean",
"description": ""
}
},
"example": {
"page": 1,
"per_page": 50,
"sort": {
"created_at": "desc"
},
"search": []
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"per_page": {
"type": "integer",
"format": "int64",
"description": "",
"default": 50
},
"trigger_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"search": {
"type": "object",
"description": ""
},
"sort": {
"type": "object",
"description": ""
},
"include_output": {
"type": "boolean",
"description": ""
}
},
"example": {
"page": 1,
"per_page": 50,
"sort": {
"created_at": "desc"
},
"search": []
}
}
}
}
}
}
},
"/workspace/{workspace_id}/trigger_history": {
"get": {
"summary": "Retrieve trigger request history with optional filtering and pagination",
"description": "Retrieve trigger request history with optional filtering and pagination\n
\nAuthentication: required\n
\nRequired API Scope:\nWorkspace Request History: Read",
"tags": [
"request history"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 50
}
},
{
"name": "trigger_id",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"default": 0
}
},
{
"name": "include_output",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"curPage": {
"type": "integer",
"format": "int64",
"description": ""
},
"nextPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"prevPage": {
"type": "integer",
"format": "int64",
"description": "",
"nullable": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"created_at": {
"type": "string",
"format": "timestamptz",
"description": "",
"default": "2023-04-12 18:34:01+0000"
},
"duration": {
"type": "number",
"description": "",
"default": 0.025
},
"input": {
"type": "object",
"description": "",
"default": {
"page": 1
}
},
"workspace_id": {
"type": "integer",
"format": "int64",
"description": ""
},
"trigger_id": {
"type": "integer",
"format": "int64",
"description": ""
}
}
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
}
},
"/workspace/{workspace_id}": {
"get": {
"summary": "Retrieve detailed information about a specific workspace",
"description": "Retrieve detailed information about a specific workspace\n
\nAuthentication: required\n
\nRequired API Scope:\nInstance Workspace: Read",
"tags": [
"workspace"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "workspace_id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"name": {
"type": "string",
"description": "",
"default": "My Workspace"
},
"description": {
"type": "string",
"description": "",
"default": "My Workspace Description"
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
}
},
"/workspace": {
"get": {
"summary": "Retrieve all accessible workspaces for the authenticated user",
"description": "Retrieve all accessible workspaces for the authenticated user\n
\nAuthentication: required",
"tags": [
"workspace"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Success!",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "",
"default": 1
},
"name": {
"type": "string",
"description": "",
"default": "My Workspace"
},
"description": {
"type": "string",
"description": "",
"default": "My Workspace Description"
},
"branch": {
"type": "string",
"description": "",
"default": "v1"
}
}
}
}
}
}
},
"400": {
"description": "Input Error. Check the request payload for issues."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Access denied. Additional privileges are needed access the requested resource."
},
"404": {
"description": "Not Found. The requested resource does not exist."
},
"429": {
"description": "Rate Limited. Too many requests."
},
"500": {
"description": "Unexpected error"
}
}
}
}
}
}