Master Metadata API

The master Metadata API allows you to browse and retrieve Instances of an account associated with a Personal Access Token. It is especially useful for displaying an account's different Instances in a UI.

The master Metadata API Swagger documentation can be accessed by the following URL:

https://app.xano.com/api:meta

Instance

GET /instance/{name} - Get Single Instance

The GET request will provide details of a specific instance when provided the instance name

get instance

get instance Authentication: required

GEThttps://app.xano.com/api:meta/instance/{name}

Authorization

bearerAuth

Path parameters

name*string

Response

200400403404429500

Success!

Body

application/json

namestring

displaystring

xano_domainstring

custom_domainstring

meta_apistring

meta_swaggerstring

Request

JavaScriptCurlPython

const response = await fetch('https://app.xano.com/api:meta/instance/{name}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

{
  "name": "x1234-4567-8901",
  "display": "My Instance",
  "xano_domain": "x1234-4567-8901.n7.xano.com",
  "custom_domain": "text",
  "meta_api": "https://x1234-4567-8901.n7.xano.com/api:meta",
  "meta_swagger": "https://x1234-4567-8901.n7.xano.com/apispec:meta?type=json"
}

GET /instance - Browse Instances

The GET request will provide a list of Instances associated with an account.

browse instances

browse instances Authentication: required

GEThttps://app.xano.com/api:meta/instance

Authorization

bearerAuth

Response

200400403404429500

Success!

Body

application/json

namestring

displaystring

xano_domainstring

custom_domainstring

meta_apistring

meta_swaggerstring

Request

JavaScriptCurlPython

const response = await fetch('https://app.xano.com/api:meta/instance', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

[
  {
    "name": "x1234-4567-8901",
    "display": "My Instance",
    "xano_domain": "x1234-4567-8901.n7.xano.com",
    "custom_domain": "text",
    "meta_api": "https://x1234-4567-8901.n7.xano.com/api:meta",
    "meta_swagger": "https://x1234-4567-8901.n7.xano.com/apispec:meta?type=json"
  }
]

• The response provides both the Xano domain and the custom domain (if applicable).

• The meta_api value will provide access to the Metadata API for the given Instance.

• The JSON of the Metadata API Swagger for the Instance is also provided.

Snippet / Token

These endpoints provide functionality for managing private snippet access tokens.

For reference, the canonical ID of your snippet is found at the end of the URL.

https://www.xano.com/snippet/abC123Zx/

In this example URL, abC123Zx is our canonical.

POST /snippet/{canonical}/token/{token]

Use this endpoint to update a token's allowed number of installations.

updates a snippet token

updates a snippet token Authentication: required

POSThttps://app.xano.com/api:meta/snippet/{canonical}/token/{token}

Authorization

bearerAuth

Path parameters

canonical*string

token*string

Body

application/jsonmultipart/form-data

max_installs*integer (int64)

current_installs*integer (int64)

Response

200400403404429500

Success!

Body

application/json

created_atstring (timestamptz)

updated_atstring (timestamptz)

tokenstring

max_installsinteger (int64)

current_installsinteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('https://app.xano.com/api:meta/snippet/{canonical}/token/{token}', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "max_installs": 0,
      "current_installs": 0
    }),
});
const data = await response.json();

Response

200

{
  "created_at": "2023-05-09 21:31:20+0000",
  "updated_at": "2023-05-09 21:31:20+0000",
  "token": "OL3T4JYM",
  "max_installs": 23,
  "current_installs": 0
}

DELETE /snippet/{canonical}/token/{token}

Use this endpoint to delete an access token from a snippet.

deletes a snippet token

deletes a snippet token Authentication: required

DELETEhttps://app.xano.com/api:meta/snippet/{canonical}/token/{token}

Authorization

bearerAuth

Path parameters

canonical*string

token*string

Response

200400403404429500

Success!

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('https://app.xano.com/api:meta/snippet/{canonical}/token/{token}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

{}

GET /snippet/{canonical}/token

Use this endpoint to get a list of tokens for a snippet.

returns a list of tokens for a snippet

returns a list of tokens for a snippet Authentication: required

GEThttps://app.xano.com/api:meta/snippet/{canonical}/token

Authorization

bearerAuth

Path parameters

canonical*string

Response

200400403404429500

Success!

Body

application/json

created_atstring (timestamptz)

updated_atstring (timestamptz)

tokenstring

max_installsinteger (int64)

current_installsinteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('https://app.xano.com/api:meta/snippet/{canonical}/token', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

[
  {
    "created_at": "2023-05-09 21:31:20+0000",
    "updated_at": "2023-05-09 21:31:20+0000",
    "token": "OL3T4JYM",
    "max_installs": 23,
    "current_installs": 0
  }
]

POST /snippet/{canonical}/token

Use this endpoint to create a new token for a snippet.

creates a new install token on the snippet

creates a new install token on the snippet Authentication: required

POSThttps://app.xano.com/api:meta/snippet/{canonical}/token

Authorization

bearerAuth

Path parameters

canonical*string

Body

application/jsonmultipart/form-data

max_installs*integer (int64)

Response

200400403404429500

Success!

Body

application/json

created_atstring (timestamptz)

updated_atstring (timestamptz)

tokenstring

max_installsinteger (int64)

current_installsinteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('https://app.xano.com/api:meta/snippet/{canonical}/token', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "max_installs": 0
    }),
});
const data = await response.json();

Response

200

{
  "created_at": "2023-05-09 21:31:20+0000",
  "updated_at": "2023-05-09 21:31:20+0000",
  "token": "OL3T4JYM",
  "max_installs": 23,
  "current_installs": 0
}

Snippets

GET /snippet/{canonical}

Retrieve a specific snippet by its canonical ID

get a specific snippet by ID

get a specific snippet by ID Authentication: required

GEThttps://app.xano.com/api:meta/snippet/{canonical}

Authorization

bearerAuth

Path parameters

canonical*string

Response

200400403404429500

Success!

Body

application/json

canonicalstring

created_atstring (timestamptz)

updated_atstring (timestamptz)

namestring

reviewstring

review_exceptionstring

install_accessstring

install_access_descriptionstring

featuredboolean

verifiedboolean

Request

JavaScriptCurlPython

const response = await fetch('https://app.xano.com/api:meta/snippet/{canonical}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

{
  "canonical": "kRG3t_-i",
  "created_at": "2023-03-23 23:32:56+0000",
  "updated_at": "2023-03-27 17:58:48+0000",
  "name": "Token Share Test",
  "review": "pending",
  "review_exception": "text",
  "install_access": "public",
  "install_access_description": "text",
  "featured": false,
  "verified": false
}

POST /snippet/{canonical}

Update settings on the snippet, such as the access method and access description.

update settings on the snippet

update settings on the snippet Authentication: required

POSThttps://app.xano.com/api:meta/snippet/{canonical}

Authorization

bearerAuth

Path parameters

canonical*string

Body

application/jsonmultipart/form-data

install_access*enum

publiclinktoken

install_access_description*string

Response

200400403404429500

Success!

Body

application/json

canonicalstring

created_atstring (timestamptz)

updated_atstring (timestamptz)

namestring

reviewstring

review_exceptionstring

install_accessstring

install_access_descriptionstring

featuredboolean

verifiedboolean

Request

JavaScriptCurlPython

const response = await fetch('https://app.xano.com/api:meta/snippet/{canonical}', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "install_access": "public",
      "install_access_description": "text"
    }),
});
const data = await response.json();

Response

200

{
  "canonical": "kRG3t_-i",
  "created_at": "2023-03-23 23:32:56+0000",
  "updated_at": "2023-03-27 17:58:48+0000",
  "name": "Token Share Test",
  "review": "pending",
  "review_exception": "text",
  "install_access": "public",
  "install_access_description": "text",
  "featured": false,
  "verified": false
}

GET /snippet

List all snippets owned by the authenticated user.

list snippets owned by the authenticated user

list snippets owned by the authenticated user Authentication: required

GEThttps://app.xano.com/api:meta/snippet

Authorization

bearerAuth

Query parameters

Response

200400403404429500

Success!

Body

application/json

curPageinteger (int64)

nextPagenullable integer (int64)

prevPagenullable integer (int64)

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://app.xano.com/api:meta/snippet', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

{
  "curPage": 0,
  "nextPage": 0,
  "prevPage": 0,
  "items": [
    {
      "canonical": "kRG3t_-i",
      "created_at": "2023-03-23 23:32:56+0000",
      "updated_at": "2023-03-27 17:58:48+0000",
      "name": "Token Share Test",
      "review": "pending",
      "review_exception": "text",
      "install_access": "public",
      "install_access_description": "text",
      "featured": false,
      "verified": false
    }
  ]
}