The Zuplo Developer API, powered by Zuplo

Schemas

ApiKeyBulkCreateOrUpdateBody

expiresOn

string · date-time

When the key expires.

description

string

The description of the api key.

key

string

The API key's value. You can use this parameter to override Zuplo's default key format, but this is not recommended as you will lose our API Key Leak Detection

Zuplo.Accounts.Account

A Zuplo account

id

string · required

The id of the account

Example: 103f832d-5331-42db-9d38-bbac05a68305

name

string · required

The name of the account

Example: my-account

label

string

The label of the account

Example: My Account

Zuplo.Accounts.AccountsList

object[] · required

Zuplo.ApiKeys.ApiKey

A Consumer can have any number of API keys associated with it. Each API Key shares the same identity (i.e. Consumer) when authenticating with this service. Keys can have their own description to note the use of the key and can have an expiration date. Expired keys will not be permitted to authenticate after their expiration.

createdOn

string · date-time · readOnly · required

When the item was created.

Example: 2023-04-18T05:54:34.408Z

updatedOn

string · date-time · readOnly · required

When the item was last updated.

Example: 2023-04-20T05:54:34.408Z

id

string · readOnly · required

expiresOn

string · date-time

When the key expires.

description

string

The description of the api key.

key

string

The API key's value. You can use this parameter to override Zuplo's default key format, but this is not recommended as you will lose our API Key Leak Detection

Zuplo.ApiKeys.ApiKeyCreateOrUpdateBody

expiresOn

string · date-time

When the key expires.

description

string

The description of the api key.

key

string

The API key's value. You can use this parameter to override Zuplo's default key format, but this is not recommended as you will lose our API Key Leak Detection

Zuplo.ApiKeys.ApiKeys

object[] · required

limit

integer · uint32

offset

integer · uint32

total

integer · uint32

Zuplo.ApiKeys.Bucket

Top level group for API key mangement. A bucket could be used with a single Zuplo environment or shared among multiple environments or projects. By default a Zuplo API Gateway project will be created with several buckets that map to production, preview, and working copy environments.

createdOn

string · date-time · readOnly · required

When the item was created.

Example: 2023-04-18T05:54:34.408Z

updatedOn

string · date-time · readOnly · required

When the item was last updated.

Example: 2023-04-20T05:54:34.408Z

id

string · readOnly · required

name

string · pattern: ^[a-z0-9-]{5,128}$ · required

A friendly name for the bucket.

isRetrievable

boolean

Whether the API keys stored in the bucket are retrievable

description

string

A description of the bucket.

object

Key value pairs to associate with the bucket.

Zuplo.ApiKeys.BucketCreateBody

name

string · pattern: ^[a-z0-9-]{5,128}$ · required

A friendly name for the bucket.

description

string

A description of the bucket.

object

Key value pairs to associate with the bucket.

Zuplo.ApiKeys.BucketUpdateBody

description

string

A description of the bucket.

object

Key value pairs to associate with the bucket.

Zuplo.ApiKeys.Buckets

object[] · required

limit

integer · uint32

offset

integer · uint32

total

integer · uint32

Zuplo.ApiKeys.Consumer

Consumers are the core of the API Key service. The consumer is the 'identity' of any API Keys that are created.

createdOn

string · date-time · readOnly · required

When the item was created.

Example: 2023-04-18T05:54:34.408Z

updatedOn

string · date-time · readOnly · required

When the item was last updated.

Example: 2023-04-20T05:54:34.408Z

id

string · readOnly · required

name

string · pattern: ^[a-z0-9-]{1,128}$ · required

A friendly name for the consumer. This name is used as the default user.sub property in the API Key Authentication policy.

object[]

description

string

A description of the consumer.

object

Key value pairs to associate with the consumer.

object

Generic metadata associated with the consumer.

Zuplo.ApiKeys.ConsumerCreateBody

name

string · pattern: ^[a-z0-9-]{1,128}$ · required

A friendly name for the consumer. This name is used as the default user.sub property in the API Key Authentication policy.

Email addresses of the managers to invite or a list of managers (with subs) to add to the consumer.

object[]

description

string

A description of the consumer.

object

Key value pairs to associate with the consumer.

object

Generic metadata associated with the consumer.

Zuplo.ApiKeys.ConsumerUpdateBody

description

string

A description of the consumer.

object

Key value pairs to associate with the consumer.

object

Generic metadata associated with the consumer.

Zuplo.ApiKeys.Consumers

object[] · required

limit

integer · uint32

offset

integer · uint32

total

Details about the actor who performed the action

sub

string · required

The subject identifier of the actor (user ID, API key, etc.)

email

string | null · required

The email address of the actor (only for user actors)

type

string · required

The type of actor (e.g., 'user', 'consumer', 'service', 'anonymous')

connection

string | null · required

The authentication connection used (e.g., 'auth0', 'google')

object · required

Information about the user being impersonated, if any

object | null · required

Additional metadata about the actor

Zuplo.AuditLogs.AuditLog

An audit log entry representing an action performed in the system

action

string · required

The action that was performed (e.g., 'account.create', 'project.delete')

object | null · required

Additional metadata about the action

object · required

Details about the actor who performed the action

array | null · required

List of resources affected by this action

object · required

Contextual information about where and how the action was performed

object · required

Information about the API route that triggered this audit event

timestamp

string · date-time · required

The timestamp when the action occurred

requestId

string · required

The unique request ID for correlation

success

boolean | null · required

Whether the action was successful

error

string | null · required

Error message if the action failed

Zuplo.AuditLogs.AuditLogsPagination

Pagination information for audit logs

limit

integer · int32 · required

Maximum number of results returned

offset

integer · int32 · required

Number of results skipped

total

integer · int32 · required

Total number of results available

hasMore

boolean · required

Whether there are more results available

Zuplo.AuditLogs.AuditLogsResponse

Response containing a list of audit logs with pagination

object[] · required

Array of audit log entries

object · required

Pagination information

Zuplo.AuditLogs.Context

Contextual information about where and how the action was performed

ipAddress

string | null · required

The IP address of the request

userAgent

string | null · required

The user agent string of the request

country

string | null · required

The ISO 3166-1 alpha-2 country code (e.g., 'US', 'GB')

region

string | null · required

The region/state code (e.g., 'CA' for California)

city

string | null · required

The city name from which the request originated

postalCode

string | null · required

The postal/ZIP code

metroCode

string | null · required

The metro code (DMA code in the US)

asOrg

string | null · required

The Autonomous System organization (ISP name)

Zuplo.AuditLogs.Resource

A resource affected by the action

type

string · required

The type of resource (e.g., 'account', 'project', 'deployment')

id

string · required

The unique identifier of the resource

object | null · required

Additional metadata about the resource

Zuplo.AuditLogs.Route

Information about the API route that triggered this audit event

source

string | null · required

The source system or API that handled the request (e.g., 'api', 'gateway')

url

string | null · required

The full URL path of the request

method

string | null · required

The HTTP method used for the request

Zuplo.ClientAuth.JwksResponse

object · required

Zuplo.ClientAuth.OAuthAccessTokenResponse

access_token

string · required

token_type

string · enum · required

Enum values:

Bearer

Example: Bearer

expires_in

integer · required

scope

string

Zuplo.ClientAuth.OAuthErrorResponse

error

string · required

error_description

string · required

Zuplo.Common.ExpiresOnField

expiresOn

string · date-time · required

When the item will expire.

Example: 2050-04-18T05:54:34.408Z

Zuplo.Configurations.Configuration

accountName

string · required

projectName

string · required

environmentType

string · enum · required

Enum values:

production

preview

development

Example: production

systemConfigurations

string · required

Zuplo.ConsumerAnalytics.CallsByStatusCodeData

Zuplo.ConsumerAnalytics.CallsDetailData

consumer

string · readOnly · required

timeStamp

string · readOnly · required

totalCalls

integer · readOnly · required

object[] · readOnly · required

Zuplo.ConsumerAnalytics.RecentCallsData

object[] · readOnly · required

Zuplo.ConsumerAnalytics.ReponseStatsByStatusCodeData

object · readOnly · required

Zuplo.ConsumerAnalytics.RequestData

consumer

string · readOnly · required

method

string · readOnly · required

routePath

string · readOnly · required

statusCode

string · readOnly · required

timeStamp

string · readOnly · required

city

string · readOnly · required

country

string · readOnly · required

Zuplo.ConsumerAnalytics.StatsByStatusCode.TimeWindowFilter

string · enum

Enum values:

last-hour

last-24-hours

last-7-days

last-30-days

last-3-months

Zuplo.ConsumerAnalytics.StatsByStatusCodeData

object[] · readOnly

Zuplo.ConsumerAnalytics.StatsData

totalCalls

integer · readOnly · required

consumer

string · readOnly · required

object[] · readOnly · required

Zuplo.DeploymentStatus.DeploymentStatus

Status of a Zuplo project deployment, including the status, build results, and a URL to view more details.

status

string · enum · required

Enum values:

SUCCESS

ERROR

IN_PROGRESS

Example: SUCCESS

url

string · required

object · required

Zuplo.Deployments.Deployment

A single deployment of a Zup.

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

Zuplo.Deployments.DeploymentsList

object[] · required

Zuplo.Deploys.DeploymentResponse

status

string · required

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

Zuplo.Deploys.SourceUrlCreateBody

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

repositoryUrl

string

The git repository url of the source code

Example: https://github.com/my-account/my-project

branch

string

The git branch

Example: main

sha

string

The git sha of the commit

Example: 9fb5c38a83013be1625c9b5cb2d1bdf458ff827e

Zuplo.Environments.Environment

The environment representing a Zup. This is mainly used in self-hosting deployments.

name

string · required

The name of the environment.

Example: lime-fox-main-bbe7540

createdOn

string · required

accountName

string · required

projectName

string · required

branchName

string · required

environmentType

string · enum · required

Enum values:

production

preview

development

Example: production

Zuplo.Environments.EnvironmentCreateBody

accountName

string · required

The name of the account

Example: my-account

projectName

string · required

The name of the project

Example: my-project

environmentType

Fleet information

id

string · required

Fleet ID

name

string · required

Fleet name

vendor

string · enum · required

Fleet vendor

Enum values:

akamai

amazon

google

microsoft

controlPlaneUrl

string · required

Control plane URL

isAccountDefault

boolean · required

Whether this is the default fleet for the account

createdOn

string · date-time · required

Creation timestamp

updatedOn

string · date-time · required

Last update timestamp

Zuplo.ManagedDedicated.FleetConfigurationRequest

Fleet configuration request

No data returned

Zuplo.ManagedDedicated.FleetConfigurationResponse

Fleet configuration response

No data returned

Zuplo.ManagedDedicated.FleetListResponse

Fleet list response

object[] · required

List of fleets

Zuplo.ManagedDedicated.FleetVendor

string · enum

Enum values:

akamai

amazon

google

microsoft

Fleet vendor

Zuplo.Metering.Bucket

createdOn

string · date-time · readOnly · required

When the item was created.

Example: 2023-04-18T05:54:34.408Z

updatedOn

string · date-time · readOnly · required

When the item was last updated.

Example: 2023-04-20T05:54:34.408Z

id

string · readOnly · required

accountName

string · readOnly · required

Zuplo.Metering.Buckets

object[] · required

limit

integer · uint32

offset

integer · uint32

total

integer · uint32

Zuplo.Metering.Plan

createdOn

string · date-time · readOnly · required

When the item was created.

Example: 2023-04-18T05:54:34.408Z

updatedOn

string · date-time · readOnly · required

When the item was last updated.

Example: 2023-04-20T05:54:34.408Z

id

string · readOnly · required

hasSubscriptions

boolean · readOnly · required

label

string · required

planExternalId

string · required

object · required

trialDays

integer

trialEndStatus

string · enum

Enum values:

paused

canceled

Example: paused

isTrialCollectPayment

boolean

Zuplo.Metering.PlanCreateBody

label

string · required

planExternalId

string · required

object · required

trialDays

integer

trialEndStatus

string · enum

Enum values:

paused

canceled

Example: paused

isTrialCollectPayment

boolean

Zuplo.Metering.PlanUpdateBody

label

string

planExternalId

string

object

trialDays

integer

trialEndStatus

string · enum

Enum values:

paused

canceled

Example: paused

isTrialCollectPayment

boolean

Zuplo.Metering.Plans

object[] · required

limit

integer · uint32

offset

integer · uint32

total

integer · uint32

Zuplo.Metering.Quota

integer

Zuplo.Metering.Subscription

createdOn

string · date-time · readOnly · required

When the item was created.

Example: 2023-04-18T05:54:34.408Z

updatedOn

string · date-time · readOnly · required

When the item was last updated.

Example: 2023-04-20T05:54:34.408Z

id

string · readOnly · required

planIds

string[] · required

planExternalIds

string[] · required

status

string · enum · required

Enum values:

active

inactive

incomplete

incomplete-expired

trialing

past-due

canceled

unpaid

type

string · enum · required

Enum values:

periodic

renewalStrategy

string · enum · required

Enum values:

monthly

yearly

region

string · enum · required

Enum values:

us-central1

us-east1

europe-west4

customerKey

string · required

subscriptionExternalId

string · required

customerExternalId

string · required

quotaResetAnchor

string · date-time

object

trialEndStatus

string

trialEndDate

string · date-time

trialStartDate

string · date-time

nextBillingCycle

string · date-time

productKey

string

Zuplo.Metering.SubscriptionCreateBody

planIds

string[] · required

planExternalIds

string[] · required

status

string · enum · required

Enum values:

active

inactive

incomplete

incomplete-expired

trialing

past-due

canceled

unpaid

type

string · enum · required

Enum values:

periodic

renewalStrategy

string · enum · required

Enum values:

monthly

yearly

region

string · enum · required

Enum values:

us-central1

us-east1

europe-west4

customerKey

string · required

subscriptionExternalId

string · required

customerExternalId

string · required

quotaResetAnchor

string · date-time

object

trialEndStatus

string

trialEndDate

string · date-time

trialStartDate

string · date-time

nextBillingCycle

string · date-time

productKey

string

Zuplo.Metering.SubscriptionUpdateBody

planExternalIds

string[]

status

string · enum

Enum values:

active

inactive

incomplete

incomplete-expired

trialing

past-due

canceled

unpaid

prorate

number

object

trialEndDate

string · date-time

Zuplo.Metering.Subscriptions

object[] · required

limit

integer · uint32

offset

integer · uint32

total

integer · uint32

Zuplo.MtlsCertificates.CertificateInfo

subject

string · required

Certificate subject

Example: CN=example.com

issuer

string · required

Certificate issuer

Example: CN=Example CA

validFrom

string · required

Certificate valid from date

Example: 2024-01-01T00:00:00Z

validTo

string · required

Certificate valid to date

Example: 2025-01-01T00:00:00Z

serialNumber

string · required

Certificate serial number

Example: 12345

Zuplo.MtlsCertificates.Environments

development

boolean · required

Whether the certificate is enabled for the development environment

preview

boolean · required

Whether the certificate is enabled for the preview environment

production

boolean · required

Whether the certificate is enabled for the production environment

Zuplo.MtlsCertificates.MtlsCertificate

id

string · readOnly · required

The unique identifier for the certificate

Example: cert_abc123

name

string · minLength: 1 · maxLength: 120 · required

The name of the certificate. Must be alphanumeric with underscores.

Example: my_client_cert

object · required

Certificate information

object · required

Environments where the certificate is enabled

createdOn

string · date-time · readOnly · required

When the item was created.

Example: 2023-04-18T05:54:34.408Z

updatedOn

string · date-time · readOnly · required

When the item was last updated.

Example: 2023-04-20T05:54:34.408Z

Zuplo.MtlsCertificates.MtlsCertificateCreateBody

name

string · minLength: 1 · maxLength: 120 · required

The name of the certificate. Must be alphanumeric with underscores.

Example: my_client_cert

certificate

string · minLength: 1 · required

The PEM-encoded certificate

key

string · minLength: 1 · required

The PEM-encoded private key

environments

string[] · minItems: 1 · required

List of environments where the certificate should be enabled

Enum values:

development

preview

production

Zuplo.MtlsCertificates.MtlsCertificateListResponse

object[] · required

List of mTLS certificates

offset

integer · int32 · required

Offset for pagination

limit

integer · int32 · required

Limit for pagination

Zuplo.MtlsCertificates.MtlsCertificateUpdateBody

environments

string[] · minItems: 1

List of environments where the certificate should be enabled

Enum values:

development

preview

production

Zuplo.Projects.Project

A single project.

name

string · required

The name of the project

Example: lime-fox

accountName

string · required

The name of the account this project belongs to

Example: lime-fox

Zuplo.Projects.ProjectCreateBody

The body of the project creation request.

name

string · required

The name of the project

Example: lime-fox

Zuplo.Projects.ProjectsList

object[] · required

Zuplo.Sources.Source

uploadUrl

string · required

Zuplo.Tunnels.Tunnel

Tunnels allow you to expose services running on bare metal, on-premises, or other non-cloud providers to the Zuplo platform. [Further reading](https://zuplo.com/docs/articles/secure-tunnel).

tunnelId

string · readOnly · required

name

string · pattern: ^[a-zA-Z0-9-]{3,24}$ · required

A friendly name for the tunnel.

Example: api-service-tunnel

token

string · readOnly · required

Set your TUNNEL_TOKEN to this value to connect to the tunnel.

Example: eyJhIjoiODJh[..]m89In0=

Zuplo.Tunnels.TunnelList

object[] · required

limit

integer · uint32

offset

integer · uint32

total

integer · uint32

Zuplo.Tunnels.TunnelListItem

id

string · readOnly · required

name

string · pattern: ^[a-zA-Z0-9-]{3,24}$ · required

A friendly name for the tunnel.

Example: api-service-tunnel

Zuplo.Tunnels.TunnelTeardownOperation

id

string · readOnly · required

status

string · enum · required

Enum values:

in-progress

success

error

Example: success

message

string

details

string

Zuplo.Tunnels.TunneledServiceConfiguration

Tunnel service configuration.

name

string · pattern: ^[a-zA-Z0-9-]{3,24}$ · required

A friendly name for the service. This name needs to be unique across all your tunneled services. Changing this will invalidate existing services with the name.

Example: authservice

endpoint

string · required

The URL of the service that the tunnel will forward to, e.g, http://localhost:3000

Example: https://localhost:3000

object[] · required

A list of projects that should have access to this tunneled service under the service://name URL scheme.

Zuplo.Tunnels.TunneledServicesConfiguration

version

integer · uint8 · required

The version of this configuration format.

Example: 1

object[] · required

A list of services that the tunnel will connect to.

Zuplo.Tunnels.TunneledServicesProvisioningOperation

id

string · readOnly · required

status

string · enum · required

Enum values:

in-progress

success

error

Example: success

message

string

details

string

Zuplo.Variables.Variable

branch

string · readOnly · required

createdOn

string · date-time · readOnly · required

When the item was created.

Example: 2023-04-18T05:54:34.408Z

updatedOn

string · date-time · readOnly · required

When the item was last updated.

Example: 2023-04-20T05:54:34.408Z

name

string · required

The name of the variable. Must be named in SCREAMING_SNAKE_CASE.

Example: APP_ENVIRONMENT_KEY

isSecret

boolean · required

Whether the variable is a secret.

Example: true

value

string · required

The value of the variable.

Zuplo.Variables.VariableCreateBody

name

string · required

The name of the variable. Must be named in SCREAMING_SNAKE_CASE.

Example: APP_ENVIRONMENT_KEY

isSecret

boolean · required

Whether the variable is a secret.

Example: true

value

string · required

The value of the variable.

Zuplo.Variables.VariableUpdateBody

value

string

The value of the variable.

Zuplo.WhoAmI.WhoAmI

account

string · required