You can use the Metadata API to import and export table schema and whole workspaces.
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.
Last updated
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
Success!
const response = await fetch('https://xxfo-0dml-kzcl.dev.xano.io/api:meta/workspace/{workspace_id}/export-schema', {
method: 'POST',
headers: {
"Authorization": "Bearer JWT",
"Content-Type": "application/json"
},
body: JSON.stringify({
"branch": "",
"password": ""
}),
});
const data = await response.json();{}import schema into a new branch and optionally set it live Authentication: required Required API Scope: Instance Workspace: Read
Success!
const response = await fetch('https://xxfo-0dml-kzcl.dev.xano.io/api:meta/workspace/{workspace_id}/import-schema', {
method: 'POST',
headers: {
"Authorization": "Bearer JWT",
"Content-Type": "multipart/form-data"
},
body: JSON.stringify({
"file": "binary",
"newbranch": "text"
}),
});
const data = await response.json();{}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
Success!
const response = await fetch('https://xxfo-0dml-kzcl.dev.xano.io/api:meta/workspace/{workspace_id}/export', {
method: 'POST',
headers: {
"Authorization": "Bearer JWT",
"Content-Type": "application/json"
},
body: JSON.stringify({
"branch": "",
"password": ""
}),
});
const data = await response.json();{}If the file is encrypted, the correct password is required to decrypt.
Required API Scope:
Instance Workspace: Update
Success!
const response = await fetch('https://xxfo-0dml-kzcl.dev.xano.io/api:meta/workspace/{workspace_id}/import', {
method: 'POST',
headers: {
"Authorization": "Bearer JWT",
"Content-Type": "multipart/form-data"
},
body: JSON.stringify({
"file": "binary"
}),
});
const data = await response.json();{
"name": "text",
"description": "text",
"branch": {
"created_at": "text",
"updated_at": "text",
"description": "text",
"label": "text",
"backup": false,
"color": "#ebc346",
"guid": "text",
"workspace": {},
"user": {
"name": "text",
"email": "name@gmail.com"
},
"history": {
"function_enabled": false,
"middleware_enabled": false,
"query_enabled": true,
"trigger_enabled": false,
"task_enabled": true
},
"middleware": {
"function_pre": [
{
"name": "text",
"as": "text",
"description": "text",
"disabled": false,
"_xsid": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"ignore": false,
"expand": false,
"children": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
],
"ignore": false,
"expand": false,
"children": []
}
],
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": false,
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
]
}
]
}
],
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": []
}
]
}
]
},
"addon": [
{
"offset": "text",
"as": "text",
"children": [
{
"offset": "text",
"as": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
],
"ignore": false,
"expand": false,
"children": []
}
],
"output": {
"customize": false,
"items": [
{
"name": "text",
"children": []
}
]
},
"children": []
}
],
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"ignore": false,
"expand": false,
"children": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
],
"ignore": false,
"expand": false,
"children": []
}
],
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": false,
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": []
}
]
}
]
}
}
]
}
],
"function_post": [
{
"name": "text",
"as": "text",
"description": "text",
"disabled": false,
"_xsid": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"ignore": false,
"expand": false,
"children": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
],
"ignore": false,
"expand": false,
"children": []
}
],
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": false,
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
]
}
]
}
],
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": []
}
]
}
]
},
"addon": [
{
"offset": "text",
"as": "text",
"children": [
{
"offset": "text",
"as": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
],
"ignore": false,
"expand": false,
"children": []
}
],
"output": {
"customize": false,
"items": [
{
"name": "text",
"children": []
}
]
},
"children": []
}
],
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"ignore": false,
"expand": false,
"children": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
],
"ignore": false,
"expand": false,
"children": []
}
],
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": false,
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": []
}
]
}
]
}
}
]
}
],
"query_pre": [
{
"name": "text",
"as": "text",
"description": "text",
"disabled": false,
"_xsid": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"ignore": false,
"expand": false,
"children": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
],
"ignore": false,
"expand": false,
"children": []
}
],
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": false,
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
]
}
]
}
],
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": []
}
]
}
]
},
"addon": [
{
"offset": "text",
"as": "text",
"children": [
{
"offset": "text",
"as": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
],
"ignore": false,
"expand": false,
"children": []
}
],
"output": {
"customize": false,
"items": [
{
"name": "text",
"children": []
}
]
},
"children": []
}
],
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"ignore": false,
"expand": false,
"children": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
],
"ignore": false,
"expand": false,
"children": []
}
],
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": false,
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": []
}
]
}
]
}
}
]
}
],
"query_post": [
{
"name": "text",
"as": "text",
"description": "text",
"disabled": false,
"_xsid": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"ignore": false,
"expand": false,
"children": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
],
"ignore": false,
"expand": false,
"children": []
}
],
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": false,
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
]
}
]
}
],
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": []
}
]
}
]
},
"addon": [
{
"offset": "text",
"as": "text",
"children": [
{
"offset": "text",
"as": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
],
"ignore": false,
"expand": false,
"children": []
}
],
"output": {
"customize": false,
"items": [
{
"name": "text",
"children": []
}
]
},
"children": []
}
],
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"ignore": false,
"expand": false,
"children": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
],
"ignore": false,
"expand": false,
"children": []
}
],
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": false,
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": []
}
]
}
]
}
}
]
}
],
"task_pre": [
{
"name": "text",
"as": "text",
"description": "text",
"disabled": false,
"_xsid": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"ignore": false,
"expand": false,
"children": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
],
"ignore": false,
"expand": false,
"children": []
}
],
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": false,
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
]
}
]
}
],
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": []
}
]
}
]
},
"addon": [
{
"offset": "text",
"as": "text",
"children": [
{
"offset": "text",
"as": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
],
"ignore": false,
"expand": false,
"children": []
}
],
"output": {
"customize": false,
"items": [
{
"name": "text",
"children": []
}
]
},
"children": []
}
],
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"ignore": false,
"expand": false,
"children": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
],
"ignore": false,
"expand": false,
"children": []
}
],
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": false,
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": []
}
]
}
]
}
}
]
}
],
"task_post": [
{
"name": "text",
"as": "text",
"description": "text",
"disabled": false,
"_xsid": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"ignore": false,
"expand": false,
"children": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
],
"ignore": false,
"expand": false,
"children": []
}
],
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": false,
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
]
}
]
}
],
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": []
}
]
}
]
},
"addon": [
{
"offset": "text",
"as": "text",
"children": [
{
"offset": "text",
"as": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
],
"ignore": false,
"expand": false,
"children": []
}
],
"output": {
"customize": false,
"items": [
{
"name": "text",
"children": []
}
]
},
"children": []
}
],
"input": [
{
"name": "text",
"value": "text",
"tag": "const",
"ignore": false,
"expand": false,
"children": [
{
"name": "text",
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
],
"ignore": false,
"expand": false,
"children": []
}
],
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": [
{
"name": "text",
"disabled": false,
"arg": [
{
"value": "text",
"tag": "const",
"filters": []
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": false,
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": []
}
]
}
]
}
}
]
}
]
},
"defaults": {
"db_primary_key": "int"
}
}
}