Xano Documentation
  • ๐Ÿ‘‹Welcome to Xano!
  • ๐ŸŒŸFrequently Asked Questions
  • ๐Ÿ”Security & Compliance (Trust Center)
  • ๐Ÿ™Feature Requests
  • ๐Ÿ’”Known Issues
  • Before You Begin
    • Using These Docs
    • Where should I start?
    • Set Up a Free Xano Account
    • Key Concepts
    • The Development Life Cycle
    • Navigating Xano
    • Plans & Pricing
  • The Database
    • Designing your Database
    • Database Basics
      • Using the Xano Database
      • Field Types
      • Relationships
      • Database Views
      • Export and Sharing
      • Data Sources
    • Migrating your Data
      • Airtable to Xano
      • Supabase to Xano
      • CSV Import & Export
    • Database Performance and Maintenance
      • Storage
      • Indexing
      • Maintenance
      • Schema Versioning
  • ๐Ÿ› ๏ธThe Function Stack
    • Building with Visual Development
      • APIs
        • Swagger (OpenAPI Documentation)
      • Custom Functions
        • Async Functions
      • Background Tasks
      • Triggers
      • Middleware
      • Configuring Expressions
      • Working with Data
    • Functions
      • AI Tools
      • Database Requests
        • Query All Records
          • External Filtering Examples
        • Get Record
        • Add Record
        • Edit Record
        • Add or Edit Record
        • Patch Record
        • Delete Record
        • Bulk Operations
        • Database Transaction
        • External Database Query
        • Direct Database Query
        • Get Database Schema
      • Data Manipulation
        • Create Variable
        • Update Variable
        • Conditional
        • Switch
        • Loops
        • Math
        • Arrays
        • Objects
        • Text
      • Security
      • APIs & Lambdas
        • Realtime Functions
        • External API Request
        • Lambda Functions
      • Data Caching (Redis)
      • Custom Functions
      • Utility Functions
      • File Storage
      • Cloud Services
    • Filters
      • Manipulation
      • Math
      • Timestamp
      • Text
      • Array
      • Transform
      • Conversion
      • Comparison
      • Security
    • Data Types
      • Text
      • Expression
      • Array
      • Object
      • Integer
      • Decimal
      • Boolean
      • Timestamp
      • Null
    • Environment Variables
    • Additional Features
      • Response Caching
  • Testing and Debugging
    • Testing and Debugging Function Stacks
    • Unit Tests
    • Test Suites
  • CI/CD
  • File Storage
    • File Storage in Xano
    • Private File Storage
  • Realtime
    • Realtime in Xano
    • Channel Permissions
    • Realtime in Webflow
  • Maintenance, Monitoring, and Logging
    • Statement Explorer
    • Request History
    • Instance Dashboard
      • Memory Usage
  • Building Backend Features
    • User Authentication & User Data
      • Separating User Data
      • Restricting Access (RBAC)
      • OAuth (SSO)
    • Webhooks
    • Messaging
    • Emails
    • Custom Report Generation
    • Fuzzy Search
    • Chatbots
  • Xano Features
    • Snippets
    • Instance Settings
      • Release Track Preferences
      • Static IP (Outgoing)
      • Change Server Region
      • Direct Database Connector
      • Backup and Restore
      • Security Policy
    • Advanced Back-end Features
      • Xano Link
      • Developer API (Deprecated)
    • Metadata API
      • Master Metadata API
      • Tables and Schema
      • Content
      • Search
      • File
      • Request History
      • Workspace Import and Export
      • Token Scopes Reference
  • Xano AI
    • Building a Backend Using AI
    • Get Started Assistant
    • AI Database Assistant
    • AI Lambda Assistant
    • AI SQL Assistant
    • API Request Assistant
    • Template Engine
    • Streaming APIs
  • AI Tools
    • MCP Servers
      • Connecting Clients
      • MCP Functions
  • Xano Transform
    • Using Xano Transform
  • Xano Actions
    • What are Actions?
    • Browse Actions
  • Team Collaboration
    • Realtime Collaboration
    • Managing Team Members
    • Branching & Merging
    • Role-based Access Control (RBAC)
  • Agencies
    • Xano for Agencies
    • Agency Features
      • Agency Dashboard
      • Client Invite
      • Transfer Ownership
      • Agency Profile
      • Commission
      • Private Marketplace
  • Enterprise
    • Xano for Enterprise
    • Enterprise Features
      • Microservices
      • Tenant Center
      • Compliance Center
      • Security Policy
      • Instance Activity
      • Deployment
      • RBAC (Role-based Access Control)
      • Xano Link
  • Your Xano Account
    • Account Page
    • Billing
    • Referrals & Commissions
  • Troubleshooting & Support
    • Error Reference
    • Troubleshooting Performance
      • When a single workflow feels slow
      • When everything feels slow
      • RAM Usage
      • Function Stack Performance
    • Getting Help
      • Granting Access
      • Community Code of Conduct
      • Community Content Modification Policy
  • Special Pricing
    • Students & Education
    • Non-Profits
  • Security
    • Best Practices
Powered by GitBook
  1. Xano Features
  2. Metadata API

Master Metadata API

Last updated 4 months ago

Was this helpful?

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 - Browse Instances

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

  • 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.

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

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

GET /snippet/{canonical}/token

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

POST /snippet/{canonical}/token

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

Snippets

GET /snippet/{canonical}

Retrieve a specific snippet by its canonical ID

POST /snippet/{canonical}

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

GET /snippet

List all snippets owned by the authenticated user.

get instance

get

get instance Authentication: required

Authorizations
Path parameters
namestringRequired
Responses
200
Success!
application/json
400
Input Error. Check the request payload for issues.
403
Access denied. Additional privileges are needed access the requested resource.
404
Not Found. The requested resource does not exist.
429
Rate Limited. Too many requests.
500
Unexpected error
get
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"
}

browse instances

get

browse instances Authentication: required

Authorizations
Responses
200
Success!
application/json
400
Input Error. Check the request payload for issues.
403
Access denied. Additional privileges are needed access the requested resource.
404
Not Found. The requested resource does not exist.
429
Rate Limited. Too many requests.
500
Unexpected error
get
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"
  }
]

deletes a snippet token

delete

deletes a snippet token Authentication: required

Authorizations
Path parameters
canonicalstringRequired
tokenstringRequired
Responses
200
Success!
application/json
Responseobject
400
Input Error. Check the request payload for issues.
403
Access denied. Additional privileges are needed access the requested resource.
404
Not Found. The requested resource does not exist.
429
Rate Limited. Too many requests.
500
Unexpected error
delete
DELETE /api:meta/snippet/{canonical}/token/{token} HTTP/1.1
Host: app.xano.com
Authorization: Bearer JWT
Accept: */*
{}

returns a list of tokens for a snippet

get

returns a list of tokens for a snippet Authentication: required

Authorizations
Path parameters
canonicalstringRequired
Responses
200
Success!
application/json
400
Input Error. Check the request payload for issues.
403
Access denied. Additional privileges are needed access the requested resource.
404
Not Found. The requested resource does not exist.
429
Rate Limited. Too many requests.
500
Unexpected error
get
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
  }
]

get a specific snippet by ID

get

get a specific snippet by ID Authentication: required

Authorizations
Path parameters
canonicalstringRequired
Responses
200
Success!
application/json
400
Input Error. Check the request payload for issues.
403
Access denied. Additional privileges are needed access the requested resource.
404
Not Found. The requested resource does not exist.
429
Rate Limited. Too many requests.
500
Unexpected error
get
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
}

list snippets owned by the authenticated user

get

list snippets owned by the authenticated user Authentication: required

Authorizations
Query parameters
pageinteger ยท int64Optional
Responses
200
Success!
application/json
400
Input Error. Check the request payload for issues.
403
Access denied. Additional privileges are needed access the requested resource.
404
Not Found. The requested resource does not exist.
429
Rate Limited. Too many requests.
500
Unexpected error
get
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
    }
  ]
}

updates a snippet token

post

updates a snippet token Authentication: required

Authorizations
Path parameters
canonicalstringRequired
tokenstringRequired
Body
max_installsinteger ยท int64Required
current_installsinteger ยท int64Required
Responses
200
Success!
application/json
400
Input Error. Check the request payload for issues.
403
Access denied. Additional privileges are needed access the requested resource.
404
Not Found. The requested resource does not exist.
429
Rate Limited. Too many requests.
500
Unexpected error
post
POST /api:meta/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
}

creates a new install token on the snippet

post

creates a new install token on the snippet Authentication: required

Authorizations
Path parameters
canonicalstringRequired
Body
max_installsinteger ยท int64Required
Responses
200
Success!
application/json
400
Input Error. Check the request payload for issues.
403
Access denied. Additional privileges are needed access the requested resource.
404
Not Found. The requested resource does not exist.
429
Rate Limited. Too many requests.
500
Unexpected error
post
POST /api:meta/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
}

update settings on the snippet

post

update settings on the snippet Authentication: required

Authorizations
Path parameters
canonicalstringRequired
Body
install_accessstring ยท enumRequiredPossible values:
install_access_descriptionstringRequired
Responses
200
Success!
application/json
400
Input Error. Check the request payload for issues.
403
Access denied. Additional privileges are needed access the requested resource.
404
Not Found. The requested resource does not exist.
429
Rate Limited. Too many requests.
500
Unexpected error
post
POST /api:meta/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
}