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:
Instance
GET /instance/{name} - Get Single Instance
The GET request will provide details of a specific instance when provided the instance name
get instance Authentication: required
GET /api:meta/instance/{name} HTTP/1.1
Host: app.xano.com
Authorization: Bearer JWT
Accept: */*
{
"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 Authentication: required
GET /api:meta/instance HTTP/1.1
Host: app.xano.com
Authorization: Bearer JWT
Accept: */*
[
{
"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 Authentication: required
POST /api:meta/snippet/{canonical}/token/{token} HTTP/1.1
Host: app.xano.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 39
{
"max_installs": 1,
"current_installs": 1
}{
"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": 1
}DELETE /snippet/{canonical}/token/{token}
Use this endpoint to delete an access token from a snippet.
deletes a snippet token Authentication: required
DELETE /api:meta/snippet/{canonical}/token/{token} HTTP/1.1
Host: app.xano.com
Authorization: Bearer JWT
Accept: */*
{}GET /snippet/{canonical}/token
Use this endpoint to get a list of tokens for a snippet.
returns a list of tokens for a snippet Authentication: required
GET /api:meta/snippet/{canonical}/token HTTP/1.1
Host: app.xano.com
Authorization: Bearer JWT
Accept: */*
[
{
"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": 1
}
]POST /snippet/{canonical}/token
Use this endpoint to create a new token for a snippet.
creates a new install token on the snippet Authentication: required
POST /api:meta/snippet/{canonical}/token HTTP/1.1
Host: app.xano.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"max_installs": 1
}{
"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": 1
}Snippets
GET /snippet/{canonical}
Retrieve a specific snippet by its canonical ID
get a specific snippet by ID Authentication: required
GET /api:meta/snippet/{canonical} HTTP/1.1
Host: app.xano.com
Authorization: Bearer JWT
Accept: */*
{
"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": true,
"verified": true
}POST /snippet/{canonical}
Update settings on the snippet, such as the access method and access description.
update settings on the snippet Authentication: required
POST /api:meta/snippet/{canonical} HTTP/1.1
Host: app.xano.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 63
{
"install_access": "public",
"install_access_description": "text"
}{
"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": true,
"verified": true
}GET /snippet
List all snippets owned by the authenticated user.
list snippets owned by the authenticated user Authentication: required
GET /api:meta/snippet HTTP/1.1
Host: app.xano.com
Authorization: Bearer JWT
Accept: */*
{
"curPage": 1,
"nextPage": 1,
"prevPage": 1,
"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": true,
"verified": true
}
]
}Last updated
Was this helpful?