Workspace Import and Export
Last updated
Was this helpful?
Last updated
Was this helpful?
Before you proceed...
Workspace exports will only contain one branch which defaults to live unless you specify a branch in the request.
Drafts are not exported.
Imports overwrite the entire contents of the destination workspace.
These endpoints will only function properly on paid Xano plans.
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.
Required API Scope:
Instance Workspace: Read
curl -L \
--request POST \
--url 'https://xxfo-0dml-kzcl.dev.xano.io/api:meta/workspace/{workspace_id}/export-schema' \
--header 'Authorization: Bearer JWT' \
--header 'Content-Type: application/json' \
--data '{
"branch": "",
"password": ""
}'{}Success!
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.
Required API Scope:
Instance Workspace: Read
curl -L \
--request POST \
--url 'https://xxfo-0dml-kzcl.dev.xano.io/api:meta/workspace/{workspace_id}/export' \
--header 'Authorization: Bearer JWT' \
--header 'Content-Type: application/json' \
--data '{
"branch": "",
"password": ""
}'{}Success!
import schema into a new branch and optionally set it live Authentication: required Required API Scope: Instance Workspace: Read
curl -L \
--request POST \
--url 'https://xxfo-0dml-kzcl.dev.xano.io/api:meta/workspace/{workspace_id}/import-schema' \
--header 'Authorization: Bearer JWT' \
--header 'Content-Type: multipart/form-data' \
--form 'file=binary' \
--form 'newbranch=text' \
--form 'setlive=true' \
--form 'password=text'{}Success!
If the file is encrypted, the correct password is required to decrypt.
Required API Scope:
Instance Workspace: Update
curl -L \
--request POST \
--url 'https://xxfo-0dml-kzcl.dev.xano.io/api:meta/workspace/{workspace_id}/import' \
--header 'Authorization: Bearer JWT' \
--header 'Content-Type: multipart/form-data' \
--form 'password=text' \
--form 'file=binary'{
"id": 1,
"name": "text",
"description": "text",
"branch": {
"id": 1,
"created_at": "text",
"updated_at": "text",
"description": "text",
"label": "text",
"backup": true,
"color": "text",
"parent_id": 1,
"guid": "text",
"workspace": {
"id": 1
},
"user": {
"id": 1,
"name": "text",
"email": "name@gmail.com"
},
"history": {
"function_enabled": true,
"function_limit": 1,
"middleware_enabled": true,
"middleware_limit": 1,
"query_enabled": true,
"query_limit": 1,
"trigger_enabled": true,
"trigger_limit": 1,
"task_enabled": true,
"task_limit": 1
},
"middleware": {
"function_pre": [
{
"name": "text",
"as": "text",
"context": {},
"description": "text",
"disabled": true,
"_xsid": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"ignore": true,
"expand": true,
"children": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": true,
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
]
}
]
}
],
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": [
{}
]
}
]
}
]
},
"addon": [
{
"id": {},
"offset": "text",
"as": "text",
"children": [
{
"id": {},
"offset": "text",
"as": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"output": {
"customize": true,
"items": [
{
"name": "text",
"children": [
{}
]
}
]
},
"children": [
{}
]
}
],
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"ignore": true,
"expand": true,
"children": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": true,
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": [
{}
]
}
]
}
]
}
}
]
}
],
"function_post": [
{
"name": "text",
"as": "text",
"context": {},
"description": "text",
"disabled": true,
"_xsid": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"ignore": true,
"expand": true,
"children": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": true,
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
]
}
]
}
],
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": [
{}
]
}
]
}
]
},
"addon": [
{
"id": {},
"offset": "text",
"as": "text",
"children": [
{
"id": {},
"offset": "text",
"as": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"output": {
"customize": true,
"items": [
{
"name": "text",
"children": [
{}
]
}
]
},
"children": [
{}
]
}
],
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"ignore": true,
"expand": true,
"children": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": true,
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": [
{}
]
}
]
}
]
}
}
]
}
],
"query_pre": [
{
"name": "text",
"as": "text",
"context": {},
"description": "text",
"disabled": true,
"_xsid": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"ignore": true,
"expand": true,
"children": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": true,
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
]
}
]
}
],
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": [
{}
]
}
]
}
]
},
"addon": [
{
"id": {},
"offset": "text",
"as": "text",
"children": [
{
"id": {},
"offset": "text",
"as": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"output": {
"customize": true,
"items": [
{
"name": "text",
"children": [
{}
]
}
]
},
"children": [
{}
]
}
],
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"ignore": true,
"expand": true,
"children": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": true,
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": [
{}
]
}
]
}
]
}
}
]
}
],
"query_post": [
{
"name": "text",
"as": "text",
"context": {},
"description": "text",
"disabled": true,
"_xsid": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"ignore": true,
"expand": true,
"children": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": true,
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
]
}
]
}
],
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": [
{}
]
}
]
}
]
},
"addon": [
{
"id": {},
"offset": "text",
"as": "text",
"children": [
{
"id": {},
"offset": "text",
"as": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"output": {
"customize": true,
"items": [
{
"name": "text",
"children": [
{}
]
}
]
},
"children": [
{}
]
}
],
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"ignore": true,
"expand": true,
"children": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": true,
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": [
{}
]
}
]
}
]
}
}
]
}
],
"task_pre": [
{
"name": "text",
"as": "text",
"context": {},
"description": "text",
"disabled": true,
"_xsid": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"ignore": true,
"expand": true,
"children": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": true,
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
]
}
]
}
],
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": [
{}
]
}
]
}
]
},
"addon": [
{
"id": {},
"offset": "text",
"as": "text",
"children": [
{
"id": {},
"offset": "text",
"as": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"output": {
"customize": true,
"items": [
{
"name": "text",
"children": [
{}
]
}
]
},
"children": [
{}
]
}
],
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"ignore": true,
"expand": true,
"children": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": true,
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": [
{}
]
}
]
}
]
}
}
]
}
],
"task_post": [
{
"name": "text",
"as": "text",
"context": {},
"description": "text",
"disabled": true,
"_xsid": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"ignore": true,
"expand": true,
"children": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": true,
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
]
}
]
}
],
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": [
{}
]
}
]
}
]
},
"addon": [
{
"id": {},
"offset": "text",
"as": "text",
"children": [
{
"id": {},
"offset": "text",
"as": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"output": {
"customize": true,
"items": [
{
"name": "text",
"children": [
{}
]
}
]
},
"children": [
{}
]
}
],
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"ignore": true,
"expand": true,
"children": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{}
]
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": true,
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": [
{}
]
}
]
}
]
}
}
]
}
]
},
"defaults": {
"db_primary_key": "int"
}
}
}Success!