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 Variables API

Set of operations available to create and update environment variables. You can learn more about environment variables [here](https://zuplo.com/docs/articles/environment-variables).

Zuplo Variables 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 Variables. 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 2 operations across 2 paths, and defines 7 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.

2 operations 2 paths 7 schemas 1 PATCH1 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 Variables 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 2

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

Variables 2

Set of operations available to create and update environment variables. You can learn more about environment variables [here](https://zuplo.com/docs/articles/environment-variables…

POST
/v1/accounts/{accountName}/projects/{projectName}/branches/{branchName}/variables
Creates a Variable
VariablesService_create 3 params body → 201400401500
PATCH
/v1/accounts/{accountName}/projects/{projectName}/branches/{branchName}/variables/{variableName}
Updates a Variable
VariablesService_update 4 params body → 200400401404500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Zuplo.Variables.Variable (6 properties), Zuplo.Variables.VariableCreateBody (3 properties), Zuplo.HttpProblemDetails.NotFoundProblemResponse (2 properties), Zuplo.HttpProblemDetails.BadRequestProblemResponse (2 properties). Each schema is shown below with its type and property counts.

Zuplo.Variables.VariableUpdateBody
object
1 property
Zuplo.Variables.Variable
object
6 properties 6 required
Zuplo.HttpProblemDetails.UnauthorizedProblemResponse
object
2 properties 2 required
Zuplo.HttpProblemDetails.InternalServerErrorProblemResponse
object
2 properties 2 required
Zuplo.Variables.VariableCreateBody
object
3 properties 3 required
Zuplo.HttpProblemDetails.BadRequestProblemResponse
object
2 properties 2 required
Zuplo.HttpProblemDetails.NotFoundProblemResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuplo-variables-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 Deployments API
Zuplo MCP Servers API
Zuplo Openapi API
Zuplo Tunnel Services API
Zuplo Tunnels API
Zuplo Who Am I API