https://dev.zuplo.comaccountName
1 2curl --request GET \ --url https://dev.zuplo.com/v1/accounts/:accountName/key-buckets
{}accountName
description
isRetrievable
name
tags
1 2 3curl --request POST \ --url https://dev.zuplo.com/v1/accounts/:accountName/key-buckets \ --data '{"createdOn":"2023-04-18T05:54:34.0Z","description":"quis Duis dolor","id":"non qui Lorem","isRetrievable":false,"name":"nplbihhxr96xrdkc8jks4oam1v0drisbkrbtd8ztyoua5j97wzs1elhdh","tags":{},"updatedOn":"2023-04-20T05:54:34.0Z"}'
{
"createdOn": "2023-04-18T05:54:34.0Z",
"description": "quis Duis dolor",
"id": "non qui Lorem",
"isRetrievable": false,
"name": "nplbihhxr96xrdkc8jks4oam1v0drisbkrbtd8ztyoua5j97wzs1elhdh",
"tags": {},
"updatedOn": "2023-04-20T05:54:34.0Z"
}{}accountName
bucketName
1 2curl --request GET \ --url https://dev.zuplo.com/v1/accounts/:accountName/key-buckets/:bucketName
{}accountName
bucketName
description
isRetrievable
tags
1 2 3curl --request PATCH \ --url https://dev.zuplo.com/v1/accounts/:accountName/key-buckets/:bucketName \ --data '{"isRetrievable":true,"tags":{}}'
{
"isRetrievable": true,
"tags": {}
}{}accountName
bucketName
1 2curl --request DELETE \ --url https://dev.zuplo.com/v1/accounts/:accountName/key-buckets/:bucketName
{}limit
offset
include-api-key
include-manager-invites
include-manager
key-format
none
visible
masked
accountName
bucketName
1 2curl --request GET \ --url https://dev.zuplo.com/v1/accounts/:accountName/key-buckets/:bucketName/consumers
{}accountName
bucketName
description
managers
metadata
name
tags
1 2 3curl --request POST \ --url https://dev.zuplo.com/v1/accounts/:accountName/key-buckets/:bucketName/consumers \ --data '{"description":"in elit consectetur","managers":["labore in officia in","sint pariatur","sunt sint"],"metadata":{},"name":"j27ot410efn5417j0-w6xf4ft9pj54we74dah2kx2x1ozbg-xc0knq","tags":{}}'
{
"description": "in elit consectetur",
"managers": [
"labore in officia in",
"sint pariatur",
"sunt sint"
],
"metadata": {},
"name": "j27ot410efn5417j0-w6xf4ft9pj54we74dah2kx2x1ozbg-xc0knq",
"tags": {}
}{}accountName
bucketName
consumerName
1 2curl --request GET \ --url https://dev.zuplo.com/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName
{}accountName
bucketName
consumerName
description
metadata
tags
1 2 3curl --request PATCH \ --url https://dev.zuplo.com/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName \ --data '{"description":"cillum consectetur id exercitation labore","tags":{}}'
{
"description": "cillum consectetur id exercitation labore",
"tags": {}
}{}accountName
bucketName
consumerName
1 2curl --request DELETE \ --url https://dev.zuplo.com/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName
{}limit
offset
key-format
none
visible
masked
accountName
bucketName
consumerName
1 2curl --request GET \ --url https://dev.zuplo.com/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys
{}accountName
bucketName
consumerName
description
key
1 2 3curl --request POST \ --url https://dev.zuplo.com/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys \ --data '{"createdOn":"2023-04-18T05:54:34.0Z","description":"pariatur laborum elit exercitation aliquip","expiresOn":"2023-04-18T05:54:34.0Z","id":"non","key":"pariatur dolore laboris dolore veniam","updatedOn":"2023-04-20T05:54:34.0Z"}'
{
"createdOn": "2023-04-18T05:54:34.0Z",
"description": "pariatur laborum elit exercitation aliquip",
"expiresOn": "2023-04-18T05:54:34.0Z",
"id": "non",
"key": "pariatur dolore laboris dolore veniam",
"updatedOn": "2023-04-20T05:54:34.0Z"
}{}accountName
bucketName
consumerName
Unnamed Property
1 2 3curl --request POST \ --url 'https://dev.zuplo.com/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/$bulk' \ --data '[{"createdOn":"2023-04-18T05:54:34.0Z","updatedOn":"2023-04-20T05:54:34.0Z","id":"dolore non in dolor","expiresOn":"2023-04-18T05:54:34.0Z","description":"enim dolore ad aute mollit","key":"aute nulla velit proident"}]'
[
{
"createdOn": "2023-04-18T05:54:34.0Z",
"updatedOn": "2023-04-20T05:54:34.0Z",
"id": "dolore non in dolor",
"expiresOn": "2023-04-18T05:54:34.0Z",
"description": "enim dolore ad aute mollit",
"key": "aute nulla velit proident"
}
]{}key-format
none
visible
masked
accountName
bucketName
consumerName
keyId
1 2curl --request GET \ --url https://dev.zuplo.com/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId
{}accountName
bucketName
consumerName
keyId
description
key
1 2 3curl --request PATCH \ --url https://dev.zuplo.com/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId \ --data '{}'
{}{}accountName
bucketName
consumerName
keyId
1 2curl --request DELETE \ --url https://dev.zuplo.com/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId
{}accountName
projectName
branchName
isSecret
name
value
1 2 3curl --request POST \ --url https://dev.zuplo.com/v1/accounts/:accountName/projects/:projectName/branches/:branchName/variables \ --data '{"branch":"staging","createdOn":"2023-04-18T05:54:34.0Z","isSecret":true,"name":"APP_ENVIRONMENT_KEY","updatedOn":"2023-04-20T05:54:34.0Z","value":"z_dev123IjKSlslsw_933"}'
{
"branch": "staging",
"createdOn": "2023-04-18T05:54:34.0Z",
"isSecret": true,
"name": "APP_ENVIRONMENT_KEY",
"updatedOn": "2023-04-20T05:54:34.0Z",
"value": "z_dev123IjKSlslsw_933"
}{}accountName
projectName
branchName
variableName
value
1 2 3curl --request PATCH \ --url https://dev.zuplo.com/v1/accounts/:accountName/projects/:projectName/branches/:branchName/variables/:variableName \ --data '{"value":"z_dev123IjKSlslsw_933"}'
{
"value": "z_dev123IjKSlslsw_933"
}{}accountName
projectName
statusId
1 2curl --request GET \ --url https://dev.zuplo.com/v1/accounts/:accountName/projects/:projectName/deployment-status/:statusId
{}accountName
projectName
1 2curl --request GET \ --url https://dev.zuplo.com/v1/accounts/:accountName/projects/:projectName/deployments
{}Authorization
deploymentName
1 2 3curl --request DELETE \ --url https://dev.zuplo.com/v1/deployments/:deploymentName \ --header 'Authorization: Bearer YOUR_KEY_HERE'
{}Authorization
deploymentName
1 2 3curl --request POST \ --url https://dev.zuplo.com/v1/deployments/:deploymentName/deploy \ --header 'Authorization: Bearer YOUR_KEY_HERE'
{}accountName
1 2curl --request GET \ --url https://dev.zuplo.com/v1/accounts/:accountName/tunnels
{}accountName
name
1 2 3curl --request POST \ --url https://dev.zuplo.com/v1/accounts/:accountName/tunnels \ --data '{"id":"tnl_JcHFzTcJ9y4GU69lKBOaxFYU","name":"api-service-tunnel","token":"eyJhIjoiODJhNGM0ZTBlYWY3ZmU3YjQyMWRlZHU1ODhlNjg1ZGMiLCJ0IjoiNjY3ZWZhODktYzIyNS00NTIyLWI0M2EtYTgwYzY0OTgxMGY1IiwicyI6IkY5RGdVNnNNOTJWT245OUlUSWxMazVwY3lHV0ZLVG1jcHg2d0I5TkR4Vm89In0="}'
{
"id": "tnl_JcHFzTcJ9y4GU69lKBOaxFYU",
"name": "api-service-tunnel",
"token": "eyJhIjoiODJhNGM0ZTBlYWY3ZmU3YjQyMWRlZHU1ODhlNjg1ZGMiLCJ0IjoiNjY3ZWZhODktYzIyNS00NTIyLWI0M2EtYTgwYzY0OTgxMGY1IiwicyI6IkY5RGdVNnNNOTJWT245OUlUSWxMazVwY3lHV0ZLVG1jcHg2d0I5TkR4Vm89In0="
}{}accountName
tunnelId
1 2curl --request GET \ --url https://dev.zuplo.com/v1/accounts/:accountName/tunnels/:tunnelId
{}accountName
tunnelId
1 2curl --request DELETE \ --url https://dev.zuplo.com/v1/accounts/:accountName/tunnels/:tunnelId
{}accountName
tunnelId
1 2curl --request POST \ --url 'https://dev.zuplo.com/v1/accounts/:accountName/tunnels/:tunnelId/$rotate-token'
{}accountName
tunnelId
operationId
1 2curl --request GET \ --url https://dev.zuplo.com/v1/accounts/:accountName/tunnels/:tunnelId/teardown-operations/:operationId
{}accountName
tunnelId
operationId
1 2curl --request GET \ --url https://dev.zuplo.com/v1/accounts/:accountName/tunnels/:tunnelId/provisioning-operations/:operationId
{}accountName
tunnelId
1 2curl --request GET \ --url https://dev.zuplo.com/v1/accounts/:accountName/tunnels/:tunnelId/services-configuration
{}accountName
tunnelId
services
version
1 2 3curl --request PUT \ --url https://dev.zuplo.com/v1/accounts/:accountName/tunnels/:tunnelId/services-configuration \ --data '{"services":[{"name":"authservice","endpoint":"https://localhost:3000","configurations":[{"project":"alpha-beta-gamma","accessibleBy":"['\''preview'\'', '\''production'\'']"},{"project":"alpha-beta-gamma","accessibleBy":"['\''preview'\'', '\''production'\'']"},{"project":"alpha-beta-gamma","accessibleBy":"['\''preview'\'', '\''production'\'']"}]},{"name":"authservice","endpoint":"https://localhost:3000","configurations":[{"project":"alpha-beta-gamma","accessibleBy":"['\''preview'\'', '\''production'\'']"},{"project":"alpha-beta-gamma","accessibleBy":"['\''preview'\'', '\''production'\'']"}]},{"name":"authservice","endpoint":"https://localhost:3000","configurations":[{"project":"alpha-beta-gamma","accessibleBy":"['\''preview'\'', '\''production'\'']"},{"project":"alpha-beta-gamma","accessibleBy":"['\''preview'\'', '\''production'\'']"},{"project":"alpha-beta-gamma","accessibleBy":"['\''preview'\'', '\''production'\'']"}]}],"version":1}'
{
"services": [
{
"name": "authservice",
"endpoint": "https://localhost:3000",
"configurations": [
{
"project": "alpha-beta-gamma",
"accessibleBy": "['preview', 'production']"
},
{
"project": "alpha-beta-gamma",
"accessibleBy": "['preview', 'production']"
},
{
"project": "alpha-beta-gamma",
"accessibleBy": "['preview', 'production']"
}
]
},
{
"name": "authservice",
"endpoint": "https://localhost:3000",
"configurations": [
{
"project": "alpha-beta-gamma",
"accessibleBy": "['preview', 'production']"
},
{
"project": "alpha-beta-gamma",
"accessibleBy": "['preview', 'production']"
}
]
},
{
"name": "authservice",
"endpoint": "https://localhost:3000",
"configurations": [
{
"project": "alpha-beta-gamma",
"accessibleBy": "['preview', 'production']"
},
{
"project": "alpha-beta-gamma",
"accessibleBy": "['preview', 'production']"
},
{
"project": "alpha-beta-gamma",
"accessibleBy": "['preview', 'production']"
}
]
}
],
"version": 1
}{}accountName
projectName
1 2curl --request POST \ --url https://dev.zuplo.com/v1/accounts/:accountName/projects/:projectName/sources
{}Authorization
1 2 3curl --request GET \ --url https://dev.zuplo.com/v1/who-am-i \ --header 'Authorization: Bearer YOUR_KEY_HERE'
{}Lists all buckets belonging to this account.
Creates a new bucket for this account.
A description of the bucket
Whether the API keys stored in the bucket are retrievable
A friendly name for the bucket
Key value pairs to associate with the bucket
Returns the details for a bucket, including the token used to connect to the bucket.
The bucket name
The bucket name
A description of the bucket
Whether the API keys stored in the bucket are retrievable
Key value pairs to associate with the bucket
Deletes a bucket and any related resources
The bucket name
Lists all consumers belonging to this account.
default: 1000
default: 0
The bucket name
Creates a new consumer for this account.
The bucket name
A description of the consumer
Email addresses of the managers to add to the consumer
Generic metadata associated with the consumer
A friendly name for the consumer
Key value pairs to associate with the consumer
The bucket name
The consumer name
The bucket name
The consumer name
A description of the consumer
Generic metadata associated with the consumer
Key value pairs to associate with the consumer
Deletes a consumer and any related resources
The bucket name
The consumer name
Lists all keys for this consumer.
default: 1000
default: 0
The bucket name
The consumer name
Creates a new API key for this consumer.
The bucket name
The consumer name
The description of the api key
The key value
Creates multiple new API keys for this consumer.
The bucket name
The consumer name
Retrieves an API key for this consumer.
The bucket name
The consumer name
The key id
Updates an API key for this consumer.
The bucket name
The consumer name
The key id
The description of the api key
The key value
Deletes an API key for this consumer.
The bucket name
The consumer name
The key id
Creates a new environment variable in a branch for a given project
Update the value of a variable in a branch for a given project
Gets the deployment status of your upload. Use the UUID of the uploaded sources as the statusId.
Lists the deployments for the specified account and project.
Deletes the specified deployment.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Deploys the specified deployment.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Lists all tunnels belonging to this account.
Creates a new tunnel for this account.
A friendly name for the tunnel
Returns the details for a tunnel, including the token used to connect to the tunnel.
Deletes a tunnel and any services that it has.
Rotates the token used to connect to the tunnel.
This endpoint returns the status of the deletion of the tunnel. Tearing down the tunnel is an asynchronous process so this endpoint allows you to poll the status.
This endpoint returns the status of the services that the tunnel is currently configured for. Provisioning the services is an asynchronous process so this endpoint allows you to poll the status.
This endpoint returns a snapshot of the services that the tunnel is currently configured for.
This endpoint reads the request body and creates/updates/delete the services that the tunnel connects to.
The version of this configuration format.
POST to create an project-specific temporary URL for uploading your sources.
Returns basic information about the caller (using the api key)
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.