ZuploZuplo
LoginStart for Free
  • 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

Deployments

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


Gets a deployment status

GET
https://dev.zuplo.com
/v1/accounts/{accountName}/projects/{projectName}/deployment-status/{statusId}

Gets the deployment status of your upload. Use the UUID of the uploaded sources as the statusId.

Gets a deployment status › path Parameters

accountName
​string · required

The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

projectName
​string · required

The name of the project. You can find this in your Zuplo Portal under Settings > Project Information.

statusId
​string · required

The UUID of the uploaded sources.

Gets a deployment status › Responses

The request has succeeded.

Status of a Zuplo project deployment, including the status, build results, and a URL to view more details.
Zuplo.DeploymentStatus.DeploymentStatus
status
​string · enum · required
Enum values:
SUCCESS
ERROR
IN_PROGRESS
Example: SUCCESS
url
​string · required
​object · required
​object · required
GET/v1/accounts/{accountName}/projects/{projectName}/deployment-status/{statusId}
curl https://dev.zuplo.com/v1/accounts/:accountName/projects/:projectName/deployment-status/:statusId
Example Responses
{ "status": "SUCCESS", "url": "https://api.zuplo.com/v1/deployments/lime-fox-main-bbe7540", "steps": {}, "buildResult": {} }
json
application/json

Lists deployments

GET
https://dev.zuplo.com
/v1/accounts/{accountName}/projects/{projectName}/deployments

Lists the deployments for the specified account and project.

Lists deployments › path Parameters

accountName
​string · required

The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

projectName
​string · required

The name of the project. You can find this in your Zuplo Portal under Settings > Project Information.

Lists deployments › Responses

The request has succeeded.

Zuplo.Deployments.DeploymentsList
​Zuplo.Deployments.Deployment[] · required
GET/v1/accounts/{accountName}/projects/{projectName}/deployments
curl https://dev.zuplo.com/v1/accounts/:accountName/projects/:projectName/deployments
Example Responses
{ "data": [ { "name": "lime-fox-main-bbe7540", "label": "main", "urlParameter": "main", "createdOn": "2023-07-25T23:41:41.468Z", "updatedOn": "2023-07-25T23:41:41.468Z", "loggingId": "chocolate_great_buzzard::lime-fox::main::main::bbe7540", "accountName": "chocolate_great_buzzard", "projectName": "lime-fox", "state": "STARTED", "message": "", "branchName": "main", "url": "https://lime-fox-main-bbe7540.zuplo.app", "environmentType": "PRODUCTION" } ] }
json
application/json

Upload deployment source

POST
https://dev.zuplo.com
/v1/deployments/sources

Creates a URL for uploading sources.

Upload deployment source › Request Body

Zuplo.Deploys.SourceCreateBody
accountName
​string · required

The name of the account

Example: my-account
projectName
​string · required

The name of the project

Example: my-project
branchName
​string · required

The name of the branch for deployment

Example: main

Upload deployment source › Responses

The request has succeeded.

Zuplo.Sources.Source
uploadUrl
​string · required
POST/v1/deployments/sources
curl https://dev.zuplo.com/v1/deployments/sources \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "accountName": "my-account", "projectName": "my-project", "branchName": "main" }'
Example Request Body
{ "accountName": "my-account", "projectName": "my-project", "branchName": "main" }
json
Example Responses
{ "uploadUrl": "https://storage.googleapis.com/[..]1fac8da132b9" }
json
application/json

Get a deployment

GET
https://dev.zuplo.com
/v1/deployments/{deploymentName}

Gets the specified deployment.

Get a deployment › path Parameters

deploymentName
​string · required

The name of the deployment. You can find this in the Zuplo Portal under Settings > Environments.

Get a deployment › Responses

The request has succeeded.

A single deployment of a Zup.
Zuplo.Deployments.Deployment
name
​string · required

The name of the deployment. You can find this in the Zuplo Portal under Settings > Environments.

Example: lime-fox-main-bbe7540
url
​string · required
label
​string · required
urlParameter
​string · required
createdOn
​string · required
updatedOn
​string · required
loggingId
​string · required
accountName
​string · required
projectName
​string · required
state
​string · required
message
​string · enum · required
Enum values:
Example:
branchName
​string · required
environmentType
​string · required
GET/v1/deployments/{deploymentName}
curl https://dev.zuplo.com/v1/deployments/:deploymentName
Example Responses
{ "name": "lime-fox-main-bbe7540", "label": "main", "urlParameter": "main", "createdOn": "2023-07-25T23:41:41.468Z", "updatedOn": "2023-07-25T23:41:41.468Z", "loggingId": "chocolate_great_buzzard::lime-fox::main::main::bbe7540", "accountName": "chocolate_great_buzzard", "projectName": "lime-fox", "state": "STARTED", "message": "", "branchName": "main", "url": "https://lime-fox-main-bbe7540.zuplo.app", "environmentType": "PRODUCTION" }
json
application/json

Deletes a deployment

DELETE
https://dev.zuplo.com
/v1/deployments/{deploymentName}

Deletes the specified deployment.

Deletes a deployment › path Parameters

deploymentName
​string · required

The name of the deployment. You can find this in the Zuplo Portal under Settings > Environments.

Deletes a deployment › Responses

The request has succeeded.

No data returned
DELETE/v1/deployments/{deploymentName}
curl https://dev.zuplo.com/v1/deployments/:deploymentName \ --request DELETE
Example Responses
No example specified for this content type

Re-deploy a deployment

POST
https://dev.zuplo.com
/v1/deployments/{deploymentName}/deploy

Re-deploys the specified deployment so that it can pick up new environment variables or other configuration changes.

Re-deploy a deployment › path Parameters

deploymentName
​string · required

The name of the deployment. You can find this in the Zuplo Portal under Settings > Environments.

Re-deploy a deployment › Responses

The request has succeeded.

Zuplo.Deploys.DeploymentResponse
status
​string · required
POST/v1/deployments/{deploymentName}/deploy
curl https://dev.zuplo.com/v1/deployments/:deploymentName/deploy \ --request POST
Example Responses
{ "status": "request enqueued" }
json
application/json

Custom DomainsEnvironments