https://dev.zuplo.com
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.
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.
Authorization
accountName
1
Authorization
accountName
name
description
tags
1
{
"name": "my-bucket",
"description": "Bucket for zuplo consumers",
"tags": {
"foo": "bar"
}
}
Authorization
accountName
bucketName
1
Authorization
accountName
bucketName
description
tags
1
{
"description": "Bucket for zuplo consumers",
"tags": {
"foo": "bar"
}
}
Authorization
accountName
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.
Authorization
limit
offset
include-api-keys
include-managers
key-format
none
visible
masked
manager-email
tag
accountName
bucketName
1
Authorization
with-api-key
accountName
bucketName
name
managers
description
tags
metadata
1
{
"name": "zup-inc",
"description": "Consumer for zup inc",
"tags": {
"foo": "bar"
},
"metadata": {
"id": "zup-id-343"
},
"managers": [
"[email protected]"
]
}
Authorization
include-api-keys
key-format
none
visible
masked
include-managers
tag
accountName
bucketName
consumerName
1
Authorization
tag
accountName
bucketName
consumerName
description
tags
metadata
1
{
"description": "Consumer for zup inc",
"tags": {
"foo": "bar"
},
"metadata": {
"id": "zup-id-343"
}
}
Authorization
tag
accountName
bucketName
consumerName
1
Authorization
tag
accountName
bucketName
consumerName
expiresOn
1
{
"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.
Authorization
limit
offset
key-format
none
visible
masked
accountName
bucketName
consumerName
1
Authorization
accountName
bucketName
consumerName
expiresOn
description
key
1
{
"description": "My secret api key",
"expiresOn": "2023-04-20T05:54:34.408Z",
"key": "zpka_66b21c8591354c0997db232cc2f79c9e_69253f24"
}
Authorization
accountName
bucketName
consumerName
Unnamed Property
1
{
"description": "My secret api key",
"expiresOn": "2023-04-20T05:54:34.408Z",
"key": "zpka_66b21c8591354c0997db232cc2f79c9e_69253f24"
}
Authorization
key-format
none
visible
masked
tag
accountName
bucketName
consumerName
keyId
1
Authorization
tag
accountName
bucketName
consumerName
keyId
expiresOn
description
key
1
{
"expiresOn": "2023-04-18T05:54:34.0Z",
"description": "laborum Excepteur voluptate anim aute",
"key": "id"
}
Authorization
tag
accountName
bucketName
consumerName
keyId
1
Set of operations available to create and update environment variables. You can learn more about environment variables here.
Authorization
accountName
projectName
branchName
name
isSecret
value
1
{
"name": "PORTAL_ID",
"isSecret": false,
"value": "89333"
}
Authorization
accountName
projectName
branchName
variableName
value
1
{
"value": "89333"
}
Set of operations available to handle deployments. You can learn more about deployments here.
Authorization
accountName
projectName
statusId
1
Authorization
accountName
projectName
1
Authorization
deploymentName
1
Authorization
deploymentName
1
Authorization
deploymentName
1
List of endpoints available to perform operations on Tunnels.
Authorization
accountName
1
Authorization
accountName
name
1
{
"tunnelId": "tnl_JcHFzTcJ9y4GU69lKBOaxFYU",
"name": "api-service-tunnel",
"token": "eyJhIjoiODJhNGM0ZTBlYWY3ZmU3YjQyMWRlZHU1ODhlNjg1ZGMiLCJ0IjoiNjY3ZWZhODktYzIyNS00NTIyLWI0M2EtYTgwYzY0OTgxMGY1IiwicyI6IkY5RGdVNnNNOTJWT245OUlUSWxMazVwY3lHV0ZLVG1jcHg2d0I5TkR4Vm89In0="
}
Authorization
accountName
tunnelId
1
Authorization
accountName
tunnelId
1