logo
Overview
API Reference
Deployments
Gets a deployment status
Lists deployments
Upload deployment source
Get a deployment
Deletes a deployment
Re-deploy a deployment
Tunnels
Lists tunnels
Creates a tunnel
Gets a tunnel
Deletes a tunnel
Rotates the token
Gets a teardown status
Tunnel Services
Gets a provisioning status
Gets a service configuration
Configures tunnel services
Variables
Creates a variable
Updates a variable
API Keys - Buckets
Lists buckets
Creates a bucket
Gets a bucket
Updates a bucket
Deletes a bucket
API Keys - Consumers
Lists consumers
Creates a consumer
Gets a consumer
Updates a consumer
Deletes a consumer
Roll consumer keys
API Keys - Keys
Lists keys
Creates an API key
Creates multiple API keys
Gets an API key
Updates an API key
Deletes an API key
Metering - Buckets
Lists metering buckets
Creates a bucket
Gets a bucket
Deletes a bucket
Metering - Plans
Lists plans
Creates a plan
Gets a plan
Updates a plan
Deletes a plan
Metering - Subscriptions
Lists subscriptions
Creates a subscription
Gets a subscription
Updates a subscription
Deletes a subscription
Metering - Quotas
Get quotas
OpenAPI Specification
Who Am I

The Zuplo Developer API, powered by Zuplo

Welcome to ZAPI - the Zuplo API where you can manage API keys, tunnels and more. To get your API key for this service login to portal.zuplo.com and navigate to your project Settings > Zuplo API Keys.

API Keys

BASE URL
https://dev.zuplo.com

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.

ENDPOINTS
GET/v1/accounts/:accountName/key-buckets
POST/v1/accounts/:accountName/key-buckets
GET/v1/accounts/:accountName/key-buckets/:bucketName
PATCH/v1/accounts/:accountName/key-buckets/:bucketName
DELETE/v1/accounts/:accountName/key-buckets/:bucketName

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.

ENDPOINTS
GET/v1/accounts/:accountName/key-buckets/:bucketName/consumers
POST/v1/accounts/:accountName/key-buckets/:bucketName/consumers
GET/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName
PATCH/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName
DELETE/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName
POST/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/roll-key

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.

ENDPOINTS
GET/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys
POST/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys
POST/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/$bulk
GET/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId
PATCH/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId
DELETE/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId

Variables

Set of operations available to create and update environment variables. You can learn more about environment variables here.

ENDPOINTS
POST/v1/accounts/:accountName/projects/:projectName/branches/:branchName/variables
PATCH/v1/accounts/:accountName/projects/:projectName/branches/:branchName/variables/:variableName

Deployments

Set of operations available to handle deployments. You can learn more about deployments here.

ENDPOINTS
GET/v1/accounts/:accountName/projects/:projectName/deployment-status/:statusId
GET/v1/accounts/:accountName/projects/:projectName/deployments
POST/v1/deployments/sources
GET/v1/deployments/:deploymentName
DELETE/v1/deployments/:deploymentName
POST/v1/deployments/:deploymentName/deploy

Tunnels

List of endpoints available to perform operations on Tunnels.

ENDPOINTS
GET/v1/accounts/:accountName/tunnels
POST/v1/accounts/:accountName/tunnels
GET/v1/accounts/:accountName/tunnels/:tunnelId
DELETE/v1/accounts/:accountName/tunnels/:tunnelId
POST/v1/accounts/:accountName/tunnels/:tunnelId/$rotate-token
GET/v1/accounts/:accountName/tunnels/:tunnelId/teardown-operations/:operationId

Tunnel Services

List of endpoints available to manage services for a given tunnel.

ENDPOINTS
GET/v1/accounts/:accountName/tunnels/:tunnelId/provisioning-operations/:operationId
GET/v1/accounts/:accountName/tunnels/:tunnelId/services-configuration
PUT/v1/accounts/:accountName/tunnels/:tunnelId/services-configuration

Metering - Buckets

ENDPOINTS
GET/v1/metering
POST/v1/metering
GET/v1/metering/:bucketId
DELETE/v1/metering/:bucketId

Metering - Plans

ENDPOINTS
GET/v1/metering/:bucketId/plans
POST/v1/metering/:bucketId/plans
GET/v1/metering/:bucketId/plans/:planId
PATCH/v1/metering/:bucketId/plans/:planId
DELETE/v1/metering/:bucketId/plans/:planId

Metering - Subscriptions

ENDPOINTS
GET/v1/metering/:bucketId/subscriptions
POST/v1/metering/:bucketId/subscriptions
GET/v1/metering/:bucketId/subscriptions/:subscriptionId
PATCH/v1/metering/:bucketId/subscriptions/:subscriptionId
DELETE/v1/metering/:bucketId/subscriptions/:subscriptionId

Metering - Quotas

ENDPOINTS
GET/v1/metering/:bucketId/subscriptions/:subscriptionId/quotas