ZuploZuplo
LoginSign Up
  • Documentation
  • API Reference
Information
Analytics
    Get recent requests for a given deployment in the last 24 hoursgetGet statistics on requests by status code for a given deploymentget
API Keys - Buckets
    Lists bucketsgetCreates a bucketpostGets a bucketgetDeletes a bucketdeleteUpdates a bucketpatch
API Keys - Consumers
    Lists consumersgetCreates a consumerpostGets a consumergetDeletes a consumerdeleteUpdates a consumerpatchRoll consumer keyspost
API Keys - Keys
    Lists keysgetCreates an API keypostCreates multiple API keyspostGets an API keygetDeletes an API keydeleteUpdates an API keypatch
API Keys - Managers
    Lists managersgetCreates a managerpostDeletes a managerdelete
Audit Logs
    Query audit logsget
Build Logs
    Get build logsget
Client mTLS CA Certificates
    List Client mTLS CA CertificatesgetCreate Client mTLS CA CertificatepostDelete Client mTLS CA CertificatedeleteUpdate Client mTLS CA Certificatepatch
Custom Domains
    Get Custom DomainsgetCreate Custom DomainpostDelete a Custom DomaindeleteUpdate a Custom Domainpatch
Deployments
    Gets a deployment statusgetLists deploymentsgetUpload deployment sourcepostGet a deploymentgetDeletes a deploymentdeleteRe-deploy a deploymentpost
Environments
    Query environmentsgetGet an environmentget
MCP Servers
    API MCP ServerpostDocs MCP Serverpost
Metering - Features
    List featuresgetCreate featurepostGet featuregetDelete featuredelete
Metering - Meters
    List metersgetCreate meterpostGet metergetUpdate meterputDelete meterdeleteList meter group by valuesgetQuery metergetQuery meterpost
Metering - Plans
    List plansgetCreate a planpostGet plangetUpdate a planputDelete plandeleteArchive plan versionpostPublish planpost
Projects
    Create projectpost
Runtime Logs
    List request logsgetGet request log detailget
Tunnel Services
    Gets a provisioning statusgetGets a service configurationgetConfigures tunnel servicesput
Tunnels
    Lists tunnelsgetCreates a tunnelpostGets a tunnelgetDeletes a tunneldeleteRotates the tokenpostGets a teardown statusget
Variables
    Creates a variablepostUpdates a variablepatch
Other endpoints
    OpenAPI SpecificationgetLists accountsgetLists projectsgetWho Am Iget
Schemas
powered by Zudoku
Zuplo Developer API

Zuplo Developer API

The Zuplo Developer API lets you programmatically manage your Zuplo account, projects, environments, tunnels, custom domains, and more. Use it to automate workflows, integrate with CI/CD pipelines, or build custom tooling on top of Zuplo.

Authentication

All API requests require a Bearer token in the Authorization header:

Code
Authorization: Bearer YOUR_API_KEY

Creating an API Key

  1. Navigate to portal.zuplo.com and log in.
  2. Select the account you want to work with.
  3. Go to Settings > API Keys.
  4. Click Create New Key or copy an existing key.

API keys are scoped to your account, so a single key works for all projects under that account. If you belong to multiple accounts, make sure to select the correct one before creating a key.

⚠️ Warning: Keep your API key secure. Do not commit it to version control or share it publicly. Use environment variables to store your key in CI/CD environments.

Tags
Analytics
Analytics and usage data
API Keys - Buckets
A Bucket is an object representing a group of API key consumers for a given account. This section includes a group of endpoints available to perform CRUD operations on a bucket. You can learn more about buckets here.
API Keys - Consumers
A Consumer is an object representing a group of API keys in a given bucket. This section includes a group of endpoints available to perform CRUD operations on a consumer. You can learn more about consumers here.
API Keys - Keys
This is an object representing an API key. This section includes a list of endpoints to perform CRUD operations on an API key. You can learn more about API keys here.
API Keys - Managers
A Manager is an object representing a group of managers in a given consumer. This section includes a group of endpoints available to perform operations on a manager. You can learn more about consumer managers here.
Audit Logs
Build Logs
Client mTLS CA Certificates
Manage account-level client mTLS CA certificates
Custom Domains
Manage account custom domains and their deployment mappings
Deployments
Set of operations available to handle deployments. You can learn more about deployments here.
Environments
Zuplo environments
MCP Servers
MCP server endpoints for AI-powered tools
Metering - Features
Metering - Meters
Metering - Plans
API Metering plan management
Projects
Runtime Logs
Tunnel Services
List of endpoints available to manage services for a given tunnel.
Tunnels
List of endpoints available to perform operations on Tunnels.
Variables
Set of operations available to create and update environment variables. You can learn more about environment variables here.
Terms of Service
ContactZuplosupport@zuplo.comhttps://zuplo.com/
Servers
https://dev.zuplo.com

Zuplo API