logo
Overview
API Reference
API Keys - Buckets
Lists buckets
Creates a bucket
Gets the details for a bucket
Updates the bucket
Deletes a bucket
API Keys - Consumers
Lists consumers
Creates a consumer
Gets a consumer
Updates the 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
Variables
Create a new variable
Update value of a variable
Deployments
Gets deployment status
Lists deployments
Get deployment
Deletes deployment
Performs a deployment
Tunnels
Lists tunnels
Creates a tunnel
Gets the details for a tunnel
Deletes a tunnel
Rotates the token
Gets the teardown provisioning status for the tunnel
Tunnel Services
Gets the provisioning status for the tunnel
Gets the service configuration for the tunnel
Configures the services that the tunnel connects to
OpenAPI Specification
Sources
Who Am I

The Zuplo Developer API, powered by Zuplo

BASE URL
https://dev.zuplo.com

API Keys - Buckets

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

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

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

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

Deployments

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

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

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

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

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.

Lists buckets

Headers

Authorization

required, string

Path Parameters

accountName

required, string
GET
/v1/accounts/:accountName/key-buckets
1

Creates a bucket

Headers

Authorization

required, string

Path Parameters

accountName

required, string

Request Body

name

required, string

description

optional, string

tags

optional, object
POST
/v1/accounts/:accountName/key-buckets
1
EXAMPLE BODY
{
  "name": "my-bucket",
  "description": "Bucket for zuplo consumers",
  "tags": {
    "foo": "bar"
  }
}

Gets the details for a bucket

Headers

Authorization

required, string

Path Parameters

accountName

required, string

bucketName

required, string
GET
/v1/accounts/:accountName/key-buckets/:bucketName
1

Updates the bucket

Headers

Authorization

required, string

Path Parameters

accountName

required, string

bucketName

required, string

Request Body

description

optional, string

tags

optional, object
PATCH
/v1/accounts/:accountName/key-buckets/:bucketName
1
EXAMPLE BODY
{
  "description": "Bucket for zuplo consumers",
  "tags": {
    "foo": "bar"
  }
}

Deletes a bucket

Headers

Authorization

required, string

Path Parameters

accountName

required, string

bucketName

required, string
DELETE
/v1/accounts/:accountName/key-buckets/:bucketName
1

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.

Lists consumers

Headers

Authorization

required, string

Query Parameters

limit

required, integer, maximum value of 1000, minimum value of 1

offset

required, integer, minimum value of 0

include-api-keys

optional, boolean

include-managers

optional, boolean

key-format

optional, string enum

Possible Enum Values

none

visible

masked

manager-email

optional, string

tag

optional, string

Path Parameters

accountName

required, string

bucketName

required, string
GET
/v1/accounts/:accountName/key-buckets/:bucketName/consumers
1

Creates a consumer

Headers

Authorization

required, string

Query Parameters

with-api-key

optional, boolean

Path Parameters

accountName

required, string

bucketName

required, string

Request Body

name

required, string

managers

optional, array of strings

description

optional, string

tags

optional, object

metadata

optional, object
POST
/v1/accounts/:accountName/key-buckets/:bucketName/consumers
1
EXAMPLE BODY
{
  "name": "zup-inc",
  "description": "Consumer for zup inc",
  "tags": {
    "foo": "bar"
  },
  "metadata": {
    "id": "zup-id-343"
  },
  "managers": [
    "[email protected]"
  ]
}

Gets a consumer

Headers

Authorization

required, string

Query Parameters

include-api-keys

optional, boolean

key-format

optional, string enum

Possible Enum Values

none

visible

masked

include-managers

optional, boolean

tag

optional, string

Path Parameters

accountName

required, string

bucketName

required, string

consumerName

required, string
GET
/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName
1

Updates the consumer

Headers

Authorization

required, string

Query Parameters

tag

optional, string

Path Parameters

accountName

required, string

bucketName

required, string

consumerName

required, string

Request Body

description

optional, string

tags

optional, object

metadata

optional, object
PATCH
/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName
1
EXAMPLE BODY
{
  "description": "Consumer for zup inc",
  "tags": {
    "foo": "bar"
  },
  "metadata": {
    "id": "zup-id-343"
  }
}

Deletes a consumer

Headers

Authorization

required, string

Query Parameters

tag

optional, string

Path Parameters

accountName

required, string

bucketName

required, string

consumerName

required, string
DELETE
/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName
1

Roll consumer keys

Headers

Authorization

required, string

Query Parameters

tag

optional, string

Path Parameters

accountName

required, string

bucketName

required, string

consumerName

required, string

Request Body

expiresOn

required, string
POST
/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/roll-key
1
EXAMPLE BODY
{
  "expiresOn": "2050-04-18T05:54:34.408Z"
}

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.

Lists keys

Headers

Authorization

required, string

Query Parameters

limit

required, integer, maximum value of 1000, minimum value of 1

offset

required, integer, minimum value of 0

key-format

optional, string enum

Possible Enum Values

none

visible

masked

Path Parameters

accountName

required, string

bucketName

required, string

consumerName

required, string
GET
/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys
1

Creates an API key

Headers

Authorization

required, string

Path Parameters

accountName

required, string

bucketName

required, string

consumerName

required, string

Request Body

expiresOn

optional, string

description

optional, string

key

optional, string
POST
/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys
1
EXAMPLE BODY
{
  "description": "My secret api key",
  "expiresOn": "2023-04-20T05:54:34.408Z",
  "key": "zpka_66b21c8591354c0997db232cc2f79c9e_69253f24"
}

Creates multiple API keys

Headers

Authorization

required, string

Path Parameters

accountName

required, string

bucketName

required, string

consumerName

required, string

Request Body

Unnamed Property

required, array
POST
/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/$bulk
1
EXAMPLE BODY
{
  "description": "My secret api key",
  "expiresOn": "2023-04-20T05:54:34.408Z",
  "key": "zpka_66b21c8591354c0997db232cc2f79c9e_69253f24"
}

Gets an API key

Headers

Authorization

required, string

Query Parameters

key-format

optional, string enum

Possible Enum Values

none

visible

masked

tag

optional, string

Path Parameters

accountName

required, string

bucketName

required, string

consumerName

required, string

keyId

required, string
GET
/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId
1

Updates an API key

Headers

Authorization

required, string

Query Parameters

tag

optional, string

Path Parameters

accountName

required, string

bucketName

required, string

consumerName

required, string

keyId

required, string

Request Body

expiresOn

optional, string

description

optional, string

key

optional, string
PATCH
/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId
1
EXAMPLE BODY
{
  "expiresOn": "2023-04-18T05:54:34.0Z",
  "description": "laborum Excepteur voluptate anim aute",
  "key": "id"
}

Deletes an API key

Headers

Authorization

required, string

Query Parameters

tag

optional, string

Path Parameters

accountName

required, string

bucketName

required, string

consumerName

required, string

keyId

required, string
DELETE
/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId
1

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

Create a new variable

Headers

Authorization

required, string

Path Parameters

accountName

required, string

projectName

required, string

branchName

required, string

Request Body

name

required, string

isSecret

required, boolean

value

required, string
POST
/v1/accounts/:accountName/projects/:projectName/branches/:branchName/variables
1
EXAMPLE BODY
{
  "name": "PORTAL_ID",
  "isSecret": false,
  "value": "89333"
}

Update value of a variable

Headers

Authorization

required, string

Path Parameters

accountName

required, string

projectName

required, string

branchName

required, string

variableName

required, string

Request Body

value

optional, string
PATCH
/v1/accounts/:accountName/projects/:projectName/branches/:branchName/variables/:variableName
1
EXAMPLE BODY
{
  "value": "89333"
}

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

Gets deployment status

Headers

Authorization

required, string

Path Parameters

accountName

required, string

projectName

required, string

statusId

required, string
GET
/v1/accounts/:accountName/projects/:projectName/deployment-status/:statusId
1

Lists deployments

Headers

Authorization

required, string

Path Parameters

accountName

required, string

projectName

required, string
GET
/v1/accounts/:accountName/projects/:projectName/deployments
1

Get deployment

Headers

Authorization

required, string

Path Parameters

deploymentName

required, string
GET
/v1/deployments/:deploymentName
1

Deletes deployment

Headers

Authorization

required, string

Path Parameters

deploymentName

required, string
DELETE
/v1/deployments/:deploymentName
1

Performs a deployment

Headers

Authorization

required, string

Path Parameters

deploymentName

required, string
POST
/v1/deployments/:deploymentName/deploy
1

List of endpoints available to perform operations on Tunnels.

Lists tunnels

Headers

Authorization

required, string

Path Parameters

accountName

required, string
GET
/v1/accounts/:accountName/tunnels
1

Creates a tunnel

Headers

Authorization

required, string

Path Parameters

accountName

required, string

Request Body

name

required, string
POST
/v1/accounts/:accountName/tunnels
1
EXAMPLE BODY
{
  "tunnelId": "tnl_JcHFzTcJ9y4GU69lKBOaxFYU",
  "name": "api-service-tunnel",
  "token": "eyJhIjoiODJhNGM0ZTBlYWY3ZmU3YjQyMWRlZHU1ODhlNjg1ZGMiLCJ0IjoiNjY3ZWZhODktYzIyNS00NTIyLWI0M2EtYTgwYzY0OTgxMGY1IiwicyI6IkY5RGdVNnNNOTJWT245OUlUSWxMazVwY3lHV0ZLVG1jcHg2d0I5TkR4Vm89In0="
}

Gets the details for a tunnel

Headers

Authorization

required, string

Path Parameters

accountName

required, string

tunnelId

required, string
GET
/v1/accounts/:accountName/tunnels/:tunnelId
1

Deletes a tunnel

Headers

Authorization

required, string

Path Parameters

accountName

required, string

tunnelId

required, string
DELETE
/v1/accounts/:accountName/tunnels/:tunnelId
1

Rotates the token