Metadata API

The Metadata API is in beta and is subject to changes including access.

The Metadata API (Beta) enables you to interact with your Xano workspace schema and content programmatically. The Metadata API includes a comprehensive collection of API endpoints designed to add and modify database tables, schemas, and more.

The Metadata API is also used in some cases to facilitate an integration with Xano by providing the integration partner with your Metadata API access token.

Getting Started with the Metadata API

Generate an Access Token

An access token is required for any request you send to the Metadata API.

1

Click in the lower-left corner and choose Instances

2

Click ⚙️ next to your instance and choose Metadata API from the panel that opens

3

Click

4

Click

5

Give your access token a name

Access tokens can have different scopes, or permissions, defined. Giving each access token a recognizable name is important for you to quickly recognize which access tokens are created for specific purposes.

6

Select the expiry for your access token

By default, Xano will revoke your Metadata API access token after 7 days, which means if you need to access the API again, you would have to generate a new token.

You can choose your own expiry duration; anything from 1 hour to never expire.

Use caution when defining extended expiry or setting tokens to never expire. Token rotation is good security practice.

You can always revoke a token at any time.

7

Define the scopes for your token

The scopes tell Xano what this token has access to. Each scope has 4 options:

C (Create) - Determines whether or not this token can create new data

R (Read) - Determines whether or not this token can read existing data

U (Update) - Determines whether or not this token can update existing data

D (Delete) - Determines whether or not this token can delete data.

Hint

You can hover over each permission to quickly add or remove all four types of scope.

Each scope has their own API endpoints associated with them. If you aren't sure which scopes you need for this token, use the reference below for additional information.

Scope	Description
Database	Access any of the content in your Xano database
Content	Access any content outside of the database or function stacks, such as branches, data sources, and realtime
Live Data Source	Access the data inside of your currently live data source
API Groups	Access API Groups and APIs
Functions	Access custom functions
Addons	Access addons
Task	Access background tasks
Files	Access file storage
Request History	Access request history

8

Once you've set up your token, click

You will be shown your new access token. Click the button to copy it to your clipboard.

You will only be shown this token once, so make sure to copy it and store it in a safe place.

If you lose the token, you should revoke it and create a new one.

Using your Access Token in Requests

The token should be sent as a header in the following format:

Authorization: Bearer your_token_here

Revoking an Access Token

When you access the metadata API panel, you can review all of your currently issued tokens and their scopes.

By choosing a token and clicking you can immediately revoke that token from use.

---

The Account API

The Account API allows you access to various settings and information about your Xano account.

Please use extreme caution when sharing your Metadata API access tokens, as they can provide access to all of your Xano data.

Account API Endpoints

Account Information

Validate the Access Token and identify the account details.

get

Validate the Access Token and identify the account details. Authentication: required

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.xano.com/api:meta/auth/me' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{
  "id": "text",
  "name": "text",
  "email": "text",
  "extras": "text"
}

Success!

browse instances

get

browse instances Authentication: required

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.xano.com/api:meta/instance' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

[
  {
    "name": "text",
    "display": "text",
    "xano_domain": "text",
    "custom_domain": "text",
    "rate_limit": true,
    "meta_api": "text",
    "meta_swagger": "text"
  }
]

Success!

Instances

get instance

get

get instance Authentication: required

Authorizations

Path parameters

namestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.xano.com/api:meta/instance/{name}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{
  "name": "text",
  "display": "text",
  "xano_domain": "text",
  "custom_domain": "text",
  "rate_limit": true,
  "meta_api": "text",
  "meta_swagger": "text"
}

Success!

browse instances

get

browse instances Authentication: required

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.xano.com/api:meta/instance' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

[
  {
    "name": "text",
    "display": "text",
    "xano_domain": "text",
    "custom_domain": "text",
    "rate_limit": true,
    "meta_api": "text",
    "meta_swagger": "text"
  }
]

Success!

Snippets

list snippets owned by the authenticated user

get

list snippets owned by the authenticated user Authentication: required

Authorizations

Query parameters

pageinteger · int64optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.xano.com/api:meta/snippet' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{
  "curPage": 1,
  "nextPage": 1,
  "prevPage": 1,
  "items": [
    {
      "canonical": "text",
      "created_at": "text",
      "updated_at": "text",
      "name": "text",
      "review": "text",
      "review_exception": "text",
      "install_access": "text",
      "install_access_description": "text",
      "featured": true,
      "verified": true
    }
  ]
}

Success!

update settings on the snippet

post

update settings on the snippet Authentication: required

Authorizations

Path parameters

canonicalstringrequired

Body

application/jsonmultipart/form-data

install_accessstring · enumrequired

Options: public, link, token

install_access_descriptionstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.xano.com/api:meta/snippet/{canonical}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "install_access": "public",
    "install_access_description": "text"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "canonical": "text",
  "created_at": "text",
  "updated_at": "text",
  "name": "text",
  "review": "text",
  "review_exception": "text",
  "install_access": "text",
  "install_access_description": "text",
  "featured": true,
  "verified": true
}

Success!

get a specific snippet by ID

get

get a specific snippet by ID Authentication: required

Authorizations

Path parameters

canonicalstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.xano.com/api:meta/snippet/{canonical}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{
  "canonical": "text",
  "created_at": "text",
  "updated_at": "text",
  "name": "text",
  "review": "text",
  "review_exception": "text",
  "install_access": "text",
  "install_access_description": "text",
  "featured": true,
  "verified": true
}

Success!

creates a new install token on the snippet

post

creates a new install token on the snippet Authentication: required

Authorizations

Path parameters

canonicalstringrequired

Body

application/jsonmultipart/form-data

max_installsinteger · int64required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.xano.com/api:meta/snippet/{canonical}/token' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "max_installs": 1
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "created_at": "text",
  "updated_at": "text",
  "token": "text",
  "max_installs": 1,
  "current_installs": 1
}

Success!

returns a list of tokens for a snippet

get

returns a list of tokens for a snippet Authentication: required

Authorizations

Path parameters

canonicalstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.xano.com/api:meta/snippet/{canonical}/token' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

[
  {
    "created_at": "text",
    "updated_at": "text",
    "token": "text",
    "max_installs": 1,
    "current_installs": 1
  }
]

Success!

updates a snippet token

post

updates a snippet token Authentication: required

Authorizations

Path parameters

canonicalstringrequired

tokenstringrequired

Body

application/jsonmultipart/form-data

max_installsinteger · int64required

current_installsinteger · int64required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.xano.com/api:meta/snippet/{canonical}/token/{token}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "max_installs": 1,
    "current_installs": 1
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "created_at": "text",
  "updated_at": "text",
  "token": "text",
  "max_installs": 1,
  "current_installs": 1
}

Success!

deletes a snippet token

delete

deletes a snippet token Authentication: required

Authorizations

Path parameters

canonicalstringrequired

tokenstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://app.xano.com/api:meta/snippet/{canonical}/token/{token}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{}

Success!

---

The Instance API

The Instance API allows you to access data inside of your Xano instances, such as your database, files, and function stacks.

API Groups

get workspace API group

get

get workspace API group Authentication: required Required API Scope: Workspace Api: Read

Authorizations

Path parameters

workspace_idinteger · int64required

apigroup_idinteger · int64required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{
  "id": 1,
  "created_at": "text",
  "updated_at": "text",
  "name": "text",
  "description": "text",
  "docs": "text",
  "guid": "text",
  "canonical": "text",
  "branch": "text",
  "tag": [
    "text"
  ]
}

Success!

add workspace API group

post

add workspace API group Authentication: required Required API Scope: Workspace Api: Create

Authorizations

Path parameters

workspace_idinteger · int64required

Body

application/jsonmultipart/form-data

branchstringoptional

namestringrequired

descriptionstringrequired

docsstringoptional

swaggerbooleanrequired

tagstring[] | nullableoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/apigroup' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "branch": "text",
    "name": "text",
    "description": "text",
    "docs": "text",
    "swagger": true,
    "tag": [
      "text"
    ]
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "id": 1,
  "created_at": "text",
  "updated_at": "text",
  "name": "text",
  "description": "text",
  "docs": "text",
  "guid": "text",
  "canonical": "text",
  "branch": "text",
  "tag": [
    "text"
  ]
}

Success!

delete workspace API group

delete

delete workspace API group Authentication: required Required API Scope: Workspace Api: Delete

Authorizations

Path parameters

workspace_idinteger · int64required

apigroup_idinteger · int64required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{}

Success!

update workspace API group

put

update workspace API group Authentication: required Required API Scope: Workspace Api: Update

Authorizations

Path parameters

workspace_idinteger · int64required

apigroup_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringrequired

docsstringoptional

swaggerbooleanrequired

tagstring[] | nullableoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "docs": "text",
    "swagger": true,
    "tag": [
      "text"
    ]
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "id": 1,
  "created_at": "text",
  "updated_at": "text",
  "name": "text",
  "description": "text",
  "docs": "text",
  "guid": "text",
  "canonical": "text",
  "branch": "text",
  "tag": [
    "text"
  ]
}

Success!

browse workspace API groups

get

browse workspace API groups Authentication: required Required API Scope: Workspace Api: Read

Authorizations

Path parameters

workspace_idinteger · int64required

Query parameters

branchstringoptional

pageinteger · int64optional

per_pageinteger · int64optional

searchstringoptional

sortstring · enumoptional

Options: created_at, updated_at, name

orderstring · enumoptional

Options: asc, desc

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/apigroup' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{
  "curPage": 1,
  "nextPage": 1,
  "prevPage": 1,
  "items": [
    {
      "id": 1,
      "created_at": "text",
      "updated_at": "text",
      "name": "text",
      "description": "text",
      "docs": "text",
      "guid": "text",
      "canonical": "text",
      "branch": "text",
      "tag": [
        "text"
      ]
    }
  ]
}

Success!

update workspace API group security settings

put

update workspace API group security settings Authentication: required Required API Scope: Workspace Api: Update

Authorizations

Path parameters

workspace_idinteger · int64required

apigroup_idinteger · int64required

Body

application/jsonmultipart/form-data

guidstringrequired

canonicalstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/security' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "guid": "text",
    "canonical": "text"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "id": 1,
  "created_at": "text",
  "updated_at": "text",
  "name": "text",
  "description": "text",
  "docs": "text",
  "guid": "text",
  "canonical": "text",
  "branch": "text",
  "tag": [
    "text"
  ]
}

Success!

browse API's in an API group

get

browse API's in an API group Authentication: required Required API Scope: Workspace Api: Read

Authorizations

Path parameters

workspace_idinteger · int64required

apigroup_idinteger · int64required

Query parameters

pageinteger · int64optional

per_pageinteger · int64optional

searchstringoptional

sortstring · enumoptional

Options: created_at, updated_at, name

orderstring · enumoptional

Options: asc, desc

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/api' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{
  "curPage": 1,
  "nextPage": 1,
  "prevPage": 1,
  "items": [
    {
      "id": 1,
      "created_at": "text",
      "updated_at": "text",
      "name": "text",
      "description": "text",
      "docs": "text",
      "guid": "text",
      "cache": {
        "active": true,
        "ttl": 1,
        "input": true,
        "auth": true,
        "datasource": true,
        "ip": true,
        "headers": [
          "text"
        ],
        "env": [
          "text"
        ]
      },
      "auth": {},
      "verb": "GET",
      "input": [
        {}
      ],
      "tag": [
        "text"
      ]
    }
  ]
}

Success!

APIs

get workspace API

get

get workspace API Authentication: required Required API Scope: Workspace Api: Read

Authorizations

Path parameters

workspace_idinteger · int64required

apigroup_idinteger · int64required

api_idinteger · int64required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/api/{api_id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{
  "id": 1,
  "created_at": "text",
  "updated_at": "text",
  "name": "text",
  "description": "text",
  "docs": "text",
  "guid": "text",
  "cache": {
    "active": true,
    "ttl": 1,
    "input": true,
    "auth": true,
    "datasource": true,
    "ip": true,
    "headers": [
      "text"
    ],
    "env": [
      "text"
    ]
  },
  "auth": {},
  "verb": "GET",
  "input": [
    {}
  ],
  "tag": [
    "text"
  ]
}

Success!

delete workspace API

delete

delete workspace API Authentication: required Required API Scope: Workspace Api: Delete

Authorizations

Path parameters

workspace_idinteger · int64required

apigroup_idinteger · int64required

api_idinteger · int64required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/api/{api_id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{}

Success!

update workspace api

put

update workspace api Authentication: required Required API Scope: Workspace Api: Update

Authorizations

Path parameters

workspace_idinteger · int64required

apigroup_idinteger · int64required

api_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringrequired

docsstringoptional

verbstring · enumrequired

Options: GET, POST, DELETE, PUT, PATCH, HEAD

authobjectoptional

tagstring[] | nullableoptional

cacheobjectoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/api/{api_id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "docs": "text",
    "verb": "GET",
    "auth": {},
    "tag": [
      "text"
    ],
    "cache": {
      "active": true,
      "ttl": 1,
      "input": true,
      "auth": true,
      "datasource": true,
      "ip": true,
      "headers": [
        "text"
      ],
      "env": [
        "text"
      ]
    }
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{}

Success!

add workspace API

post

add workspace API Authentication: required Required API Scope: Workspace Api: Create

Authorizations

Path parameters

workspace_idinteger · int64required

apigroup_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringrequired

docsstringoptional

verbstring · enumrequired

Options: GET, POST, DELETE, PUT, PATCH, HEAD

tagstring[] | nullableoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/api' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "docs": "text",
    "verb": "GET",
    "tag": [
      "text"
    ]
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "id": 1,
  "created_at": "text",
  "updated_at": "text",
  "name": "text",
  "description": "text",
  "docs": "text",
  "guid": "text",
  "cache": {
    "active": true,
    "ttl": 1,
    "input": true,
    "auth": true,
    "datasource": true,
    "ip": true,
    "headers": [
      "text"
    ],
    "env": [
      "text"
    ]
  },
  "auth": {},
  "verb": "GET",
  "input": [
    {}
  ],
  "tag": [
    "text"
  ]
}

Success!

update workspace api security settings

put

update workspace api security settings Authentication: required Required API Scope: Workspace Api: Update

Authorizations

Path parameters

workspace_idinteger · int64required

apigroup_idinteger · int64required

api_idinteger · int64required

Body

application/jsonmultipart/form-data

guidstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/api/{api_id}/security' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "guid": "text"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{}

Success!

Workspace

delete a workspace branch

delete

delete a workspace branch Authentication: required Required API Scope: Instance Workspace: Update

Authorizations

Path parameters

workspace_idinteger · int64required

branch_labelstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/branch/{branch_label}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{}

Success!

browse workspace branches

get

browse workspace branches Authentication: required Required API Scope: Instance Workspace: Read

Authorizations

Path parameters

workspace_idinteger · int64required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/branch' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

[
  {
    "created_at": "text",
    "label": "text",
    "live": true,
    "backup": true
  }
]

Success!

delete workspace data source

delete

delete workspace data source Authentication: required Required API Scope: Instance Workspace: Delete

Authorizations

Path parameters

workspace_idinteger · int64required

labelstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/datasource/{label}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{}

Success!

update workspace data source

put

update workspace data source Authentication: required Required API Scope: Instance Workspace: Update

Authorizations

Path parameters

workspace_idinteger · int64required

labelstringrequired

Body

application/jsonmultipart/form-data

colorstring · default: "#ebc346"optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/datasource/{label}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "color": "text"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "color": "text",
  "label": "text"
}

Success!

browse workspace data sources

get

browse workspace data sources Authentication: required Required API Scope: Instance Workspace: Read

Authorizations

Path parameters

workspace_idinteger · int64required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/datasource' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

[
  {
    "color": "text",
    "label": "text"
  }
]

Success!

create workspace data source

post

create workspace data source Authentication: required Required API Scope: Instance Workspace: Create

Authorizations

Path parameters

workspace_idinteger · int64required

Body

application/jsonmultipart/form-data

labelstringrequired

colorstring · default: "#ebc346"optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/datasource' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "label": "text",
    "color": "text"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "color": "text",
  "label": "text"
}

Success!

export the database table + branch schema

post

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

application/jsonmultipart/form-data

passwordstringoptional

branchstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/export-schema' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "branch": "",
    "password": ""
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{}

Success!

export the workspace and content

post

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

application/jsonmultipart/form-data

passwordstringoptional

branchstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/export' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "branch": "",
    "password": ""
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{}

Success!

browse workspaces

get

browse workspaces Authentication: required

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

[
  {
    "id": 1,
    "name": "text",
    "description": "text",
    "branch": "text"
  }
]

Success!

browse workspace

get

browse workspace Authentication: required Required API Scope: Instance Workspace: Read

Authorizations

Path parameters

workspace_idinteger · int64required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{
  "id": 1,
  "name": "text",
  "description": "text",
  "branch": "text"
}

Success!

Tables

update workspace table's autocomplete

put

update workspace table's autocomplete Authentication: required Required API Scope: Workspace Database: Update

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

autocompleteobject[]optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/autocomplete' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "autocomplete": [
      {
        "name": "id"
      }
    ]
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "id": "text",
  "autocomplete": "text"
}

Success!

delete table content rows in bulk

post

The request body should contain an array of row_ids, where each id identifies a row to be deleted. Required API Scope: Workspace Content: Delete

Authorizations

Path parameters

workspace_idstringrequired

table_idstringrequired

Header parameters

x-data-sourcestring · default: "live"optional

Body

application/jsonmultipart/form-data

row_idsstring[]optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/content/bulk/delete' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "row_ids": [
      1
    ]
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "success": [
    "text"
  ],
  "success_total": 1,
  "error": [
    "text"
  ]
}

Success!

update table content in bulk

post

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). The example below is assuming that the table being modified has a column labeled name.

Required API Scope: Workspace Content: Update

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Header parameters

x-data-sourcestring · default: "live"optional

Body

application/jsonmultipart/form-data

itemsobject[]optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/content/bulk/patch' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "items": [
      {
        "row_id": 1,
        "updates": {
          "name": "test name"
        }
      }
    ]
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "success": [
    "text"
  ],
  "success_total": 1
}

Success!

create new table content in bulk

post

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. The example below is assuming that the table has a column labeled "name".

Required API Scope: Workspace Content: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Header parameters

x-data-sourcestring · default: "live"optional

Body

application/jsonmultipart/form-data

allow_id_fieldbooleanoptional

itemsobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/content/bulk' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "items": [
      {
        "name": "test name"
      }
    ],
    "allow_id_field": false
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

[
  1
]

Success!

delete table content rows matching search criteria

post

Provide search criteria to delete all matching rows. Required API Scope: Workspace Content: Delete

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Header parameters

x-data-sourcestring · default: "live"optional

Body

application/jsonmultipart/form-data

searchobjectoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/content/search/delete' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "search": []
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "success": [
    "text"
  ],
  "success_total": 1
}

Success!

patch table content rows matching search criteria

post

Provide search and update objects with path and new value to patch rows matching search criteria. Required API Scope: Workspace Content: Update

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Header parameters

x-data-sourcestring · default: "live"optional

Body

application/jsonmultipart/form-data

searchobjectoptional

updatesobjectoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/content/search/patch' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "search": [
      {
        "name": "test"
      }
    ],
    "updates": {
      "name": "new name"
    }
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "success": [
    "text"
  ],
  "success_total": 1
}

Success!

search table content with support for complex filtering and sorting

post

search table content with support for complex filtering and sorting Authentication: required Required API Scope: Workspace Content: Read

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Header parameters

x-data-sourcestring · default: "live"optional

Body

application/jsonmultipart/form-data

pageinteger · int64 · default: 1optional

per_pageinteger · int64 · default: 50optional

sortobjectoptional

searchobjectoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/content/search' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "page": 1,
    "per_page": 50,
    "sort": {
      "id": "desc"
    },
    "search": []
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "items": {},
  "itemsReceived": 1,
  "curPage": 1,
  "nextPage": 1,
  "prevPage": 1,
  "offset": 1,
  "perPage": 1,
  "itemsTotal": 1,
  "pageTotal": 1
}

Success!

delete table content

delete

delete table content Authentication: required Required API Scope: Workspace Content: Delete

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

content_idstringrequired

Header parameters

x-data-sourcestring · default: "live"optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/content/{content_id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{}

Success!

get table content

get

get table content Authentication: required Required API Scope: Workspace Content: Read

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

content_idstringrequired

Header parameters

x-data-sourcestring · default: "live"optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/content/{content_id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{}

Success!

update existing table content

put

Each table has unique schema, which means that the request body should be updated with the schema relevant to the table being used. The example below is assuming that the table has a column labeled "name".

Required API Scope: Workspace Content: Update

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

content_idstringrequired

Header parameters

x-data-sourcestring · default: "live"optional

Body

objectoptional

Example: {"name":"test name"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/content/{content_id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "test name"
  }'

application/json

200

400

401

403

404

429

500

200

{}

Success!

browse table content

get

browse table content Authentication: required Required API Scope: Workspace Content: Read

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Query parameters

pageinteger · int64optional

per_pageinteger · int64optional

Header parameters

x-data-sourcestring · default: "live"optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/content' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{
  "items": {},
  "itemsReceived": 1,
  "curPage": 1,
  "nextPage": 1,
  "prevPage": 1,
  "offset": 1,
  "perPage": 1,
  "itemsTotal": 1,
  "pageTotal": 1
}

Success!

create new table content

post

Each table has unique schema, which means that the request body should be updated with the schema relevant to the table being used. The example below is assuming that the table has a column labeled "name".

Required API Scope: Workspace Content: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Header parameters

x-data-sourcestring · default: "live"optional

Body

objectoptional

Example: {"name":"test name"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/content' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "test name"
  }'

application/json

200

400

401

403

404

429

500

200

{}

Success!

create a btree table index

post

create a btree table index Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

fieldsobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/index/btree' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "fields": [
      {
        "name": "name",
        "op": "desc"
      }
    ]
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "id": "text"
}

Success!

create a search table index

post

create a search table index Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

langstring · enumrequired

Options: simple, arabic, danish, dutch, english, finnish, french, german, hungarian, indonesian, irish, italian, lithuanian, nepali, norwegian, portuguese, romanian, russian, spanish, swedish, tamil, turkish

fieldsobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/index/search' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "search_label",
    "lang": "english",
    "fields": [
      {
        "name": "name",
        "priority": 1
      }
    ]
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "id": "text"
}

Success!

create a spatial table index

post

create a spatial table index Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

fieldsobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/index/spatial' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "fields": [
      {
        "name": "location",
        "op": "gist_geometry_ops_2d"
      }
    ]
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "id": "text"
}

Success!

create a unique table index

post

create a unique table index Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

fieldsobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/index/unique' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "fields": [
      {
        "name": "name",
        "op": "desc"
      }
    ]
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "id": "text"
}

Success!

create a vector table index

post

Options include vector_ip_ops (Inner Product), vector_cosine_ops (Cosine), vector_l1_ops (L1 Distance), vector_l2_ops (L2 Distance) Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

fieldsobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/index/vector' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "fields": [
      {
        "name": "name",
        "op": "vector_ip_ops"
      }
    ]
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "id": "text"
}

Success!

delete table index

delete

delete table index Authentication: required Required API Scope: Workspace Database: Delete

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

index_idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/index/{index_id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{}

Success!

browse table indexes

get

browse table indexes Authentication: required Required API Scope: Workspace Database: Read

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/index' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{}

Success!

replace all of the indexes of a workspace table

put

replace all of the indexes of a workspace table Authentication: required Required API Scope: Workspace Database: Update

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

indexobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/index' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "index": [
      {
        "type": "primary",
        "fields": [
          {
            "name": "id"
          }
        ]
      },
      {
        "type": "btree",
        "fields": [
          {
            "name": "created_at",
            "op": "desc"
          }
        ]
      }
    ]
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{}

Success!

update workspace table's metadata

put

update workspace table's metadata Authentication: required Required API Scope: Workspace Database: Update

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestring | nullableoptional

descriptionstring | nullableoptional

tagstring[] | nullableoptional

authboolean | nullableoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/meta' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "tag": [
      "text"
    ],
    "auth": true
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{}

Success!

rename a column within the schema of a workspace table

post

rename a column within the schema of a workspace table Authentication: required Required API Scope: Workspace Database: Update

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

new_namestringrequired

old_namestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/rename' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "new_name": "new_field",
    "old_name": "old_field"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{}

Success!

create attachment schema within a workspace table

post

create attachment schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

nullableboolean · default: trueoptional

requiredbooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

sensitivebooleanoptional

stylestring · enum · default: "single"optional

Options: single, list

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/attachment' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "attachment"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

create audio schema within a workspace table

post

create audio schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

nullableboolean · default: trueoptional

requiredbooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

sensitivebooleanoptional

stylestring · enum · default: "single"optional

Options: single, list

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/audio' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "audio"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

create bool schema within a workspace table

post

create bool schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

nullablebooleanoptional

defaultbooleanoptional

requiredbooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

sensitivebooleanoptional

stylestring · enum · default: "single"optional

Options: single, list

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/bool' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "finished",
    "default": false
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

create date schema within a workspace table

post

create date schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

nullablebooleanoptional

requiredbooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

sensitivebooleanoptional

stylestring · enum · default: "single"optional

Options: single, list

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/date' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "completed_at"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

create decimal schema within a workspace table

post

create decimal schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

nullablebooleanoptional

defaultnumberoptional

requiredbooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

sensitivebooleanoptional

stylestring · enum · default: "single"optional

Options: single, list

filtersobject | nullableoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/decimal' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "score",
    "default": 100
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

create email schema within a workspace table

post

create email schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

nullablebooleanoptional

defaultstringoptional

requiredbooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

sensitivebooleanoptional

stylestring · enum · default: "single"optional

Options: single, list

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/email' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "email"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

create enum schema within a workspace table

post

create enum schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

nullablebooleanoptional

defaultstringoptional

requiredbooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

sensitivebooleanoptional

stylestring · enum · default: "single"optional

Options: single, list

valuesstring[]optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/enum' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "status",
    "values": [
      "To Do",
      "In Progress",
      "Done",
      "Pending"
    ]
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

create geo_linestring schema within a workspace table

post

create geo_linestring schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

nullableboolean · default: trueoptional

requiredbooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

sensitivebooleanoptional

stylestring · enum · default: "single"optional

Options: single, list

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/geo_linestring' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "line"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

create geo_multilinestring schema within a workspace table

post

create geo_multilinestring schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

nullableboolean · default: trueoptional

requiredbooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

sensitivebooleanoptional

stylestring · enum · default: "single"optional

Options: single, list

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/geo_multilinestring' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "lines"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

create geo_multipoint schema within a workspace table

post

create geo_multipoint schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

nullableboolean · default: trueoptional

requiredbooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

sensitivebooleanoptional

stylestring · enum · default: "single"optional

Options: single, list

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/geo_multipoint' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "points"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

create geo_multipolygon schema within a workspace table

post

create geo_multipolygon schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

nullableboolean · default: trueoptional

requiredbooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

sensitivebooleanoptional

stylestring · enum · default: "single"optional

Options: single, list

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/geo_multipolygon' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "polygons"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

create geo_point schema within a workspace table

post

create geo_point schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

nullableboolean · default: trueoptional

requiredbooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

sensitivebooleanoptional

stylestring · enum · default: "single"optional

Options: single, list

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/geo_point' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "point"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

create geo_polygon schema within a workspace table

post

create geo_polygon schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

nullableboolean · default: trueoptional

requiredbooleanoptional

sensitivebooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

stylestring · enum · default: "single"optional

Options: single, list

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/geo_polygon' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "polygon"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

create image schema within a workspace table

post

create image schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

nullableboolean · default: trueoptional

requiredbooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

sensitivebooleanoptional

stylestring · enum · default: "single"optional

Options: single, list

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/image' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "image"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

create int schema within a workspace table

post

create int schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

nullablebooleanoptional

defaultinteger · int64optional

requiredbooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

sensitivebooleanoptional

stylestring · enum · default: "single"optional

Options: single, list

filtersobject | nullableoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/int' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "score",
    "default": 100
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

create json schema within a workspace table

post

create json schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

nullablebooleanoptional

requiredbooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

sensitivebooleanoptional

stylestring · enum · default: "single"optional

Options: single, list

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/json' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "data"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

create object schema within a workspace table

post

create object schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

nullablebooleanoptional

requiredbooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

sensitivebooleanoptional

stylestring · enum · default: "single"optional

Options: single, list

childrenobjectoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/object' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "group",
    "children": [
      {
        "name": "name",
        "type": "text"
      },
      {
        "name": "score",
        "type": "int"
      }
    ]
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

create password reference schema within a workspace table

post

create password reference schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

nullablebooleanoptional

requiredbooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

sensitivebooleanoptional

stylestring · enum · default: "single"optional

Options: single, list

filtersobject | nullableoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/password' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "password",
    "filters": {
      "min": 8,
      "max": 64,
      "minAlpha": 1,
      "minDigit": 1,
      "minSymbol": 1
    }
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

create table reference schema within a workspace table

post

create table reference schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

tableref_idinteger · int64required

nullablebooleanoptional

requiredbooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

sensitivebooleanoptional

stylestring · enum · default: "single"optional

Options: single, list

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/tablerefuuid' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "user_id",
    "tableref_id": 101
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

create table reference schema within a workspace table

post

create table reference schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

tableref_idinteger · int64required

nullablebooleanoptional

requiredbooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

sensitivebooleanoptional

stylestring · enum · default: "single"optional

Options: single, list

filtersobject | nullableoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/tableref' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "user_id",
    "tableref_id": 101
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

create text schema within a workspace table

post

create text schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

nullablebooleanoptional

defaultstringoptional

requiredbooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

sensitivebooleanoptional

stylestring · enum · default: "single"optional

Options: single, list

formatstring · enumoptional

Options: , plaintext, yaml, html, xml, markdown

filtersobject | nullableoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/text' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "name",
    "filters": {
      "trim": true,
      "max": 100
    }
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

create timestamp schema within a workspace table

post

create timestamp schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

nullableboolean · default: trueoptional

requiredbooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

sensitivebooleanoptional

stylestring · enum · default: "single"optional

Options: single, list

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/timestamp' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "completed_at"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

create uuid schema within a workspace table

post

create uuid schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

nullablebooleanoptional

defaultinteger · int64optional

requiredbooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

sensitivebooleanoptional

stylestring · enum · default: "single"optional

Options: single, list

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/uuid' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "user_id"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

create vector schema within a workspace table

post

create vector schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

nullablebooleanoptional

defaultstringoptional

requiredbooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

sensitivebooleanoptional

stylestring · enum · default: "single"optional

Options: single, list

vectorobjectrequired

filtersobject | nullableoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/vector' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "name",
    "vector": {
      "size": 3
    }
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

create video schema within a workspace table

post

create video schema within a workspace table Authentication: required Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

nullableboolean · default: trueoptional

requiredbooleanoptional

accessstring · enum · default: "public"optional

Options: public, private, internal

sensitivebooleanoptional

stylestring · enum · default: "single"optional

Options: single, list

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/type/video' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "video"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "name": "text"
}

Success!

delete a specific schema element within workspace table

delete

delete a specific schema element within workspace table Authentication: required Required API Scope: Workspace Database: Delete

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

schema_namestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/{schema_name}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{}

Success!

get a specific schema element within workspace table

get

get a specific schema element within workspace table Authentication: required Required API Scope: Workspace Database: Read

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

schema_namestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema/{schema_name}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{}

Success!

browse workspace table's schema

get

browse workspace table's schema Authentication: required Required API Scope: Workspace Database: Read

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{}

Success!

replace the entire schema of a workspace table

put

replace the entire schema of a workspace table Authentication: required Required API Scope: Workspace Database: Update

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

schemaobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/schema' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
      }
    ]
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{}

Success!

update workspace table's security settings

put

update workspace table's security settings Authentication: required Required API Scope: Workspace Database: Update

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Body

application/jsonmultipart/form-data

guidstring | nullableoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/security' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "guid": "text"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{}

Success!

truncate table's content and optionally reset the primary key

delete

truncate table's content and optionally reset the primary key Authentication: required Required API Scope: Workspace Content: Delete

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Header parameters

x-data-sourcestring · default: "live"optional

Body

application/jsonmultipart/form-data

resetbooleanrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}/truncate' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "reset": true
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{}

Success!

delete workspace table and all of its content

delete

delete workspace table and all of its content Authentication: required Required API Scope: Workspace Database: Delete

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{}

Success!

get workspace table

get

get workspace table Authentication: required Required API Scope: Workspace Database: Read

Authorizations

Path parameters

workspace_idinteger · int64required

table_idinteger · int64required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table/{table_id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

[
  {
    "id": 1,
    "created_at": "text",
    "updated_at": "text",
    "name": "text",
    "description": "text",
    "docs": "text",
    "guid": "text",
    "auth": true,
    "tag": [
      "text"
    ]
  }
]

Success!

browse workspace tables

get

browse workspace tables Authentication: required Required API Scope: Workspace Database: Read

Authorizations

Path parameters

workspace_idinteger · int64required

Query parameters

pageinteger · int64optional

per_pageinteger · int64optional

searchstringoptional

sortstring · enumoptional

Options: created_at, updated_at, name

orderstring · enumoptional

Options: asc, desc

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

[
  {
    "curPage": 1,
    "nextPage": 1,
    "prevPage": 1,
    "items": [
      {
        "id": 1,
        "created_at": "text",
        "updated_at": "text",
        "name": "text",
        "description": "text",
        "docs": "text",
        "guid": "text",
        "auth": true,
        "tag": [
          "text"
        ]
      }
    ]
  }
]

Success!

create workspace table

post

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. Required API Scope: Workspace Database: Create

Authorizations

Path parameters

workspace_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringoptional

docsstringoptional

authbooleanoptional

guidstring | nullableoptional

schemaobject | nullableoptional

indexobject | nullableoptional

tagstring[] | nullableoptional

autocompleteobject[] | nullableoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/table' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "new table 123",
    "description": "",
    "docs": "",
    "auth": null,
    "guid": null,
    "schema": null,
    "index": null,
    "autocomplete": [],
    "tag": []
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "id": "text"
}

Success!

Functions

get workspace function

get

get workspace function Authentication: required Required API Scope: Workspace Function: Read

Authorizations

Path parameters

workspace_idinteger · int64required

function_idinteger · int64required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/function/{function_id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{
  "id": 1,
  "created_at": "text",
  "updated_at": "text",
  "name": "text",
  "description": "text",
  "docs": "text",
  "guid": "text",
  "branch": "text",
  "cache": {
    "active": true,
    "ttl": 1,
    "input": true,
    "auth": true,
    "datasource": true,
    "ip": true,
    "headers": [
      "text"
    ],
    "env": [
      "text"
    ]
  }
}

Success!

add workspace function

post

add workspace function Authentication: required Required API Scope: Workspace Function: Create

Authorizations

Path parameters

workspace_idinteger · int64required

Body

application/jsonmultipart/form-data

branchstringoptional

descriptionstringrequired

docsstringoptional

namestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/function' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "branch": "text",
    "description": "text",
    "docs": "text",
    "name": "text"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "id": 1,
  "created_at": "text",
  "updated_at": "text",
  "name": "text",
  "description": "text",
  "docs": "text",
  "guid": "text",
  "branch": "text",
  "cache": {
    "active": true,
    "ttl": 1,
    "input": true,
    "auth": true,
    "datasource": true,
    "ip": true,
    "headers": [
      "text"
    ],
    "env": [
      "text"
    ]
  }
}

Success!

delete workspace function

delete

delete workspace function Authentication: required Required API Scope: Workspace Function: Delete

Authorizations

Path parameters

workspace_idinteger · int64required

function_idinteger · int64required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/function/{function_id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{}

Success!

update workspace function

put

update workspace function Authentication: required Required API Scope: Workspace Function: Update

Authorizations

Path parameters

workspace_idinteger · int64required

function_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringrequired

docsstringoptional

cacheobjectoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/function/{function_id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "docs": "text",
    "cache": {
      "active": true,
      "ttl": 1,
      "input": true,
      "auth": true,
      "datasource": true,
      "ip": true,
      "headers": [
        "text"
      ],
      "env": [
        "text"
      ]
    }
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "id": 1,
  "created_at": "text",
  "updated_at": "text",
  "name": "text",
  "description": "text",
  "docs": "text",
  "guid": "text",
  "branch": "text",
  "cache": {
    "active": true,
    "ttl": 1,
    "input": true,
    "auth": true,
    "datasource": true,
    "ip": true,
    "headers": [
      "text"
    ],
    "env": [
      "text"
    ]
  }
}

Success!

browse workspace functions

get

browse workspace functions Authentication: required Required API Scope: Workspace Function: Read

Authorizations

Path parameters

workspace_idinteger · int64required

Query parameters

branchstringoptional

pageinteger · int64optional

per_pageinteger · int64optional

searchstringoptional

sortstring · enumoptional

Options: created_at, updated_at, name

orderstring · enumoptional

Options: asc, desc

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/function' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{
  "curPage": 1,
  "nextPage": 1,
  "prevPage": 1,
  "items": [
    {
      "id": 1,
      "created_at": "text",
      "updated_at": "text",
      "name": "text",
      "description": "text",
      "docs": "text",
      "guid": "text",
      "branch": "text",
      "cache": {
        "active": true,
        "ttl": 1,
        "input": true,
        "auth": true,
        "datasource": true,
        "ip": true,
        "headers": [
          "text"
        ],
        "env": [
          "text"
        ]
      }
    }
  ]
}

Success!

update workspace function security settings

put

update workspace function security settings Authentication: required Required API Scope: Workspace Function: Update

Authorizations

Path parameters

workspace_idinteger · int64required

function_idinteger · int64required

Body

application/jsonmultipart/form-data

guidstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/function/{function_id}/security' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "guid": "text"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "id": 1,
  "created_at": "text",
  "updated_at": "text",
  "name": "text",
  "description": "text",
  "docs": "text",
  "guid": "text",
  "branch": "text",
  "cache": {
    "active": true,
    "ttl": 1,
    "input": true,
    "auth": true,
    "datasource": true,
    "ip": true,
    "headers": [
      "text"
    ],
    "env": [
      "text"
    ]
  }
}

Success!

Tasks

get workspace task

get

get workspace task Authentication: required Required API Scope: Workspace Task: Read

Authorizations

Path parameters

workspace_idinteger · int64required

task_idinteger · int64required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/task/{task_id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{
  "id": 1,
  "created_at": "text",
  "updated_at": "text",
  "name": "text",
  "description": "text",
  "docs": "text",
  "guid": "text",
  "datasource": "text",
  "active": true,
  "branch": "text"
}

Success!

add workspace task

post

add workspace task Authentication: required Required API Scope: Workspace Task: Create

Authorizations

Path parameters

workspace_idinteger · int64required

Body

application/jsonmultipart/form-data

branchstringoptional

namestringrequired

descriptionstringrequired

docsstringoptional

datasourcestringrequired

activebooleanrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/task' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "branch": "text",
    "name": "text",
    "description": "text",
    "docs": "text",
    "datasource": "text",
    "active": true
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "id": 1,
  "created_at": "text",
  "updated_at": "text",
  "name": "text",
  "description": "text",
  "docs": "text",
  "guid": "text",
  "datasource": "text",
  "active": true,
  "branch": "text"
}

Success!

delete workspace task

delete

delete workspace task Authentication: required Required API Scope: Workspace Task: Delete

Authorizations

Path parameters

workspace_idinteger · int64required

task_idinteger · int64required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/task/{task_id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{}

Success!

update workspace task

put

update workspace task Authentication: required Required API Scope: Workspace Task: Update

Authorizations

Path parameters

workspace_idinteger · int64required

task_idinteger · int64required

Body

application/jsonmultipart/form-data

namestringrequired

descriptionstringrequired

docsstringoptional

datasourcestringrequired

activebooleanrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/task/{task_id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "docs": "text",
    "datasource": "text",
    "active": true
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "id": 1,
  "created_at": "text",
  "updated_at": "text",
  "name": "text",
  "description": "text",
  "docs": "text",
  "guid": "text",
  "datasource": "text",
  "active": true,
  "branch": "text"
}

Success!

browse workspace tasks

get

browse workspace tasks Authentication: required Required API Scope: Workspace Task: Read

Authorizations

Path parameters

workspace_idinteger · int64required

Query parameters

branchstringoptional

pageinteger · int64optional

per_pageinteger · int64optional

searchstringoptional

sortstring · enumoptional

Options: created_at, updated_at, name

orderstring · enumoptional

Options: asc, desc

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/task' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{
  "curPage": 1,
  "nextPage": 1,
  "prevPage": 1,
  "items": [
    {
      "id": 1,
      "created_at": "text",
      "updated_at": "text",
      "name": "text",
      "description": "text",
      "docs": "text",
      "guid": "text",
      "datasource": "text",
      "active": true,
      "branch": "text"
    }
  ]
}

Success!

update workspace task security settings

put

update workspace task security settings Authentication: required Required API Scope: Workspace Task: Update

Authorizations

Path parameters

workspace_idinteger · int64required

task_idinteger · int64required

Body

application/jsonmultipart/form-data

guidstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/task/{task_id}/security' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "guid": "text"
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "id": 1,
  "created_at": "text",
  "updated_at": "text",
  "name": "text",
  "description": "text",
  "docs": "text",
  "guid": "text",
  "datasource": "text",
  "active": true,
  "branch": "text"
}

Success!

Files

list files within workspace

get

list files within workspace Authentication: required Required API Scope: Workspace File: Read

Authorizations

Path parameters

workspace_idinteger · int64required

Query parameters

pageinteger · int64optional

per_pageinteger · int64optional

searchstringoptional

accessstring · enumoptional

Options: public, private

sortstring · enumoptional

Options: created_at, name, size, mime

orderstring · enumoptional

Options: asc, desc

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/file' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{
  "curPage": 1,
  "nextPage": 1,
  "prevPage": 1,
  "items": [
    {
      "id": 1,
      "created_at": "text",
      "name": "text",
      "size": 1,
      "type": "text",
      "mime": "text",
      "access": "text",
      "path": "text"
    }
  ]
}

Success!

upload file to workspace

post

upload file to workspace Authentication: required Required API Scope: Workspace File: Create

Authorizations

Path parameters

workspace_idinteger · int64required

Body

contentstring · binaryrequired

typestring · enumoptional

Options: image, video, audio

accessstring · enum · default: "public"optional

Options: public, private

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/file' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: multipart/form-data' \
  --form 'content=binary' \
  --form 'type=image' \
  --form 'access=public'

multipart/form-data

200

400

401

403

404

429

500

200

{
  "id": 1,
  "created_at": "text",
  "name": "text",
  "size": 1,
  "type": "text",
  "mime": "text",
  "access": "text",
  "path": "text"
}

Success!

delete file within workspace

delete

delete file within workspace Authentication: required Required API Scope: Workspace File: Delete

Authorizations

Path parameters

workspace_idinteger · int64required

file_idinteger · int64required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/file/{file_id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

No body

Success!

bulk delete files within workspace

delete

bulk delete files within workspace Authentication: required Required API Scope: Workspace File: Delete

Authorizations

Path parameters

workspace_idinteger · int64required

Body

application/jsonmultipart/form-data

idsinteger · int64[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/file/bulk_delete' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "ids": [
      1
    ]
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

No body

Success!

Realtime

get workspace realtime details

get

get workspace realtime details Authentication: required Required API Scope: Instance Workspace: Read

Authorizations

Path parameters

workspace_idinteger · int64required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/realtime' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

429

500

200

{
  "enabled": true,
  "hash": "text",
  "channels": [
    {
      "anonymous_clients": true,
      "client_authenticated_messaging": true,
      "client_private_messaging": true,
      "client_private_messaging_authenticated_only": true,
      "client_public_messaging": true,
      "client_public_messaging_authenticated_only": true,
      "description": "text",
      "enabled": true,
      "id": 1,
      "pattern": "text",
      "presence": true,
      "wildcard": true
    }
  ]
}

Success!

update workspace realtime settings

put

update workspace realtime settings Authentication: required Required API Scope: Instance Workspace: Update

Authorizations

Path parameters

workspace_idinteger · int64required

Body

application/jsonmultipart/form-data

enabledbooleanoptional

hashstringoptional

channelsobject[]optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://xxsw-1d5c-nopq.n7d.xano.io/api:meta/workspace/{workspace_id}/realtime' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "enabled": true,
    "hash": "text",
    "channels": [
      {
        "anonymous_clients": true,
        "client_authenticated_messaging": true,
        "client_private_messaging": true,
        "client_private_messaging_authenticated_only": true,
        "client_public_messaging": true,
        "client_public_messaging_authenticated_only": true,
        "description": "text",
        "enabled": true,
        "history": 0,
        "id": 1,
        "pattern": "text",
        "presence": true,
        "wildcard": true
      }
    ]
  }'

application/jsonmultipart/form-data

200

400

401

403

404

429

500

200

{
  "enabled": true,
  "hash": "text",
  "channels": [
    {
      "anonymous_clients": true,
      "client_authenticated_messaging": true,
      "client_private_messaging": true,
      "client_private_messaging_authenticated_only": true,
      "client_public_messaging": true,
      "client_public_messaging_authenticated_only": true,
      "description": "text",
      "enabled": true,
      "id": 1,
      "pattern": "text",
      "presence": true,
      "wildcard": true
    }
  ]
}

Success!

The Metadata API is flexible regarding sending input values. You only need to send the values required to process your request. For example, if you are updating a schema and want to just update the name, then you only need to send the updated name and the other metadata of the schema will remain unchanged.

For partners wanting an easier way to integrate, it may be useful to start out with the Account API. This way the only prompt from the user will be to get their access token, and then you can use the Account API to get a list of the user's instances, leading to the Instance API for workspaces, tables, and APIs.