Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuplo Deployments API

Set of operations available to handle deployments. You can learn more about deployments [here](https://zuplo.com/docs/articles/environments).

Zuplo Deployments API is one of 13 APIs that Zuplo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Deployments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and 4 JSON Schemas.

This API exposes 6 operations across 5 paths, and defines 10 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://dev.zuplo.com.

6 operations 5 paths 10 schemas 1 DELETE3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://dev.zuplo.com
Authentication
API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

Zuplo Deployments API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key authentication. Format: Bearer {api-key}

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Deployments 6

Set of operations available to handle deployments. You can learn more about deployments [here](https://zuplo.com/docs/articles/environments).

GET
/v1/accounts/{accountName}/projects/{projectName}/deployment-status/{statusId}
Gets a Deployment Status
V1_deploymentStatus 3 params → 200400401404500
GET
/v1/accounts/{accountName}/projects/{projectName}/deployments
Lists Deployments
DeploymentsService_list 2 params → 200400401500
POST
/v1/deployments/sources
Upload Deployment Source
DeployService_sources body → 200400401500
GET
/v1/deployments/{deploymentName}
Get a Deployment
DeploymentsService_read 1 param → 200400401500
DELETE
/v1/deployments/{deploymentName}
Deletes a Deployment
DeploymentsService_delete 1 param → 200400401500
POST
/v1/deployments/{deploymentName}/deploy
Re-deploy a Deployment
DeployService_redeploy 1 param → 200400401500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Zuplo.Deployments.Deployment (13 properties), Zuplo.DeploymentStatus.DeploymentStatus (4 properties), Zuplo.Deploys.SourceCreateBody (3 properties), Zuplo.HttpProblemDetails.NotFoundProblemResponse (2 properties). Each schema is shown below with its type and property counts.

Zuplo.Deployments.Deployment
object
A single deployment of a Zup.
13 properties 13 required
Zuplo.Sources.Source
object
1 property 1 required
Zuplo.Deployments.DeploymentsList
object
1 property 1 required
Zuplo.HttpProblemDetails.UnauthorizedProblemResponse
object
2 properties 2 required
Zuplo.HttpProblemDetails.InternalServerErrorProblemResponse
object
2 properties 2 required
Zuplo.Deploys.SourceCreateBody
object
3 properties 3 required
Zuplo.DeploymentStatus.DeploymentStatus
object
Status of a Zuplo project deployment, including the status, build results, and a URL to view more details.
4 properties 4 required
Zuplo.HttpProblemDetails.BadRequestProblemResponse
object
2 properties 2 required
Zuplo.Deploys.DeploymentResponse
object
1 property 1 required
Zuplo.HttpProblemDetails.NotFoundProblemResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuplo-deployments-api-openapi.yml Raw ↑

Other APIs Zuplo publishes across the network.

Zuplo API Keys - Buckets API
Zuplo API Keys - Consumers API
Zuplo API Keys - Keys API
Zuplo API Keys - Managers API
Zuplo Audit Logs API
Zuplo Custom Domains API
Zuplo MCP Servers API
Zuplo Openapi API
Zuplo Tunnel Services API
Zuplo Tunnels API
Zuplo Variables API
Zuplo Who Am I API