Workspace Import and Export
For large workspaces, import may not function properly using the Metadata API. In these cases, reach out to support and we can assist with the import process.
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
Authorizations
Path parameters
workspace_idinteger · int64Required
Body
passwordstringOptional
branchstringOptional
Responses
200
Success!
application/json
Responseobject
400
Input Error. Check the request payload for issues.
401
Unauthorized
403
Access denied. Additional privileges are needed access the requested resource.
404
Not Found. The requested resource does not exist.
429
Rate Limited. Too many requests.
500
Unexpected error
post
POST /api:meta/workspace/{workspace_id}/export-schema HTTP/1.1
Host: xxfo-0dml-kzcl.dev.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 27
{
"branch": "",
"password": ""
}{}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
Authorizations
Path parameters
workspace_idinteger · int64Required
Body
passwordstringOptional
branchstringOptional
Responses
200
Success!
application/json
Responseobject
400
Input Error. Check the request payload for issues.
401
Unauthorized
403
Access denied. Additional privileges are needed access the requested resource.
404
Not Found. The requested resource does not exist.
429
Rate Limited. Too many requests.
500
Unexpected error
post
POST /api:meta/workspace/{workspace_id}/export HTTP/1.1
Host: xxfo-0dml-kzcl.dev.xano.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 27
{
"branch": "",
"password": ""
}{}import schema into a new branch and optionally set it live Authentication: required Required API Scope: Instance Workspace: Read
Authorizations
Path parameters
workspace_idinteger · int64Required
Body
filestring · binaryRequired
newbranchstringRequired
setlivebooleanOptional
passwordstringOptional
Responses
200
Success!
application/json
Responseobject
400
Input Error. Check the request payload for issues.
401
Unauthorized
403
Access denied. Additional privileges are needed access the requested resource.
404
Not Found. The requested resource does not exist.
429
Rate Limited. Too many requests.
500
Unexpected error
post
POST /api:meta/workspace/{workspace_id}/import-schema HTTP/1.1
Host: xxfo-0dml-kzcl.dev.xano.io
Authorization: Bearer JWT
Content-Type: multipart/form-data
Accept: */*
Content-Length: 69
{
"file": "binary",
"newbranch": "text",
"setlive": true,
"password": "text"
}{}import the archive into the specified workspace and replace it with supplied content and configuration
post
If the file is encrypted, the correct password is required to decrypt.
Required API Scope:
Instance Workspace: Update
Authorizations
Path parameters
workspace_idinteger · int64Required
Body
passwordstringOptional
filestring · binaryRequired
Responses
200
Success!
application/json
400
Input Error. Check the request payload for issues.
401
Unauthorized
403
Access denied. Additional privileges are needed access the requested resource.
404
Not Found. The requested resource does not exist.
429
Rate Limited. Too many requests.
500
Unexpected error
post
POST /api:meta/workspace/{workspace_id}/import HTTP/1.1
Host: xxfo-0dml-kzcl.dev.xano.io
Authorization: Bearer JWT
Content-Type: multipart/form-data
Accept: */*
Content-Length: 35
{
"password": "text",
"file": "binary"
}{
"id": 1,
"name": "text",
"description": "text",
"branch": {
"id": 1,
"created_at": "text",
"updated_at": "text",
"description": "text",
"label": "text",
"backup": true,
"color": "#ebc346",
"parent_id": 1,
"guid": "text",
"workspace": {
"id": 1
},
"user": {
"id": 1,
"name": "text",
"email": "[email protected]"
},
"history": {
"function_enabled": true,
"function_limit": 100,
"middleware_enabled": true,
"middleware_limit": 100,
"query_enabled": true,
"query_limit": 100,
"trigger_enabled": true,
"trigger_limit": 100,
"task_enabled": true,
"task_limit": 100
},
"middleware": {
"function_pre": [
{
"name": "text",
"as": "text",
"context": {},
"description": "text",
"disabled": true,
"_xsid": "text",
"input": [
{
"name": "text",
"value": "text",
"tag": "input",
"ignore": true,
"expand": true,
"children": [
{
"name": "text",
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": true,
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"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": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"output": {
"customize": true,
"items": [
{
"name": "text",
"children": [
{}
]
}
]
},
"children": [
{}
]
}
],
"input": [
{
"name": "text",
"value": "text",
"tag": "input",
"ignore": true,
"expand": true,
"children": [
{
"name": "text",
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"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": "input",
"ignore": true,
"expand": true,
"children": [
{
"name": "text",
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": true,
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"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": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"output": {
"customize": true,
"items": [
{
"name": "text",
"children": [
{}
]
}
]
},
"children": [
{}
]
}
],
"input": [
{
"name": "text",
"value": "text",
"tag": "input",
"ignore": true,
"expand": true,
"children": [
{
"name": "text",
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"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": "input",
"ignore": true,
"expand": true,
"children": [
{
"name": "text",
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": true,
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"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": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"output": {
"customize": true,
"items": [
{
"name": "text",
"children": [
{}
]
}
]
},
"children": [
{}
]
}
],
"input": [
{
"name": "text",
"value": "text",
"tag": "input",
"ignore": true,
"expand": true,
"children": [
{
"name": "text",
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"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": "input",
"ignore": true,
"expand": true,
"children": [
{
"name": "text",
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": true,
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"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": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"output": {
"customize": true,
"items": [
{
"name": "text",
"children": [
{}
]
}
]
},
"children": [
{}
]
}
],
"input": [
{
"name": "text",
"value": "text",
"tag": "input",
"ignore": true,
"expand": true,
"children": [
{
"name": "text",
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"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": "input",
"ignore": true,
"expand": true,
"children": [
{
"name": "text",
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": true,
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"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": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"output": {
"customize": true,
"items": [
{
"name": "text",
"children": [
{}
]
}
]
},
"children": [
{}
]
}
],
"input": [
{
"name": "text",
"value": "text",
"tag": "input",
"ignore": true,
"expand": true,
"children": [
{
"name": "text",
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"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": "input",
"ignore": true,
"expand": true,
"children": [
{
"name": "text",
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": true,
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"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": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"output": {
"customize": true,
"items": [
{
"name": "text",
"children": [
{}
]
}
]
},
"children": [
{}
]
}
],
"input": [
{
"name": "text",
"value": "text",
"tag": "input",
"ignore": true,
"expand": true,
"children": [
{
"name": "text",
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
],
"ignore": true,
"expand": true,
"children": [
{}
]
}
],
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{
"name": "text",
"disabled": true,
"arg": [
{
"value": "text",
"tag": "input",
"filters": [
{}
]
}
]
}
]
}
]
}
]
}
],
"output": {
"customize": true,
"items": [
{
"name": "text",
"children": [
{
"name": "text",
"children": [
{}
]
}
]
}
]
}
}
]
}
]
},
"defaults": {
"db_primary_key": "int"
}
}
}Last updated
Was this helpful?