Documentation
API Reference

API Keys - Buckets

Lists bucketsget

Creates a bucketpost

Gets a bucketget

Deletes a bucketdelete

Updates a bucketpatch

API Keys - Consumers

Lists consumersget

Creates a consumerpost

Gets a consumerget

Deletes a consumerdelete

Updates a consumerpatch

Roll consumer keyspost

API Keys - Keys

Creates an API keypost

Creates multiple API keyspost

Gets an API keyget

Deletes an API keydelete

Updates an API keypatch

API Keys - Managers

Lists managersget

Creates a managerpost

Deletes a managerdelete

Query audit logsget

Gets a deployment statusget

Lists deploymentsget

Upload deployment sourcepost

Get a deploymentget

Deletes a deploymentdelete

Re-deploy a deploymentpost

Metering - Features

List featuresget

Create featurepost

Delete featuredelete

Metering - Meters

Create meterpost

Update meterput

Delete meterdelete

List meter group by valuesget

Query meterpost

Metering - Plans

Create a planpost

Update a planput

Delete plandelete

Archive plan versionpost

Publish planpost

Tunnel Services

Gets a provisioning statusget

Gets a service configurationget

Configures tunnel servicesput

Lists tunnelsget

Creates a tunnelpost

Gets a tunnelget

Deletes a tunneldelete

Rotates the tokenpost

Gets a teardown statusget

Creates a variablepost

Updates a variablepatch

Other endpoints

OpenAPI Specificationget

powered by Zudoku

Zuplo Developer API

Zuplo Developer API

The Zuplo Developer API lets you programmatically manage your Zuplo account, projects, environments, tunnels, custom domains, and more. Use it to automate workflows, integrate with CI/CD pipelines, or build custom tooling on top of Zuplo.

Authentication

All API requests require a Bearer token in the Authorization header:

Code
Authorization: Bearer YOUR_API_KEY

Creating an API Key

Navigate to portal.zuplo.com and log in.
Select the account you want to work with.
Go to Settings > API Keys.
Click Create New Key or copy an existing key.

API keys are scoped to your account, so a single key works for all projects under that account. If you belong to multiple accounts, make sure to select the correct one before creating a key.

⚠️ Warning: Keep your API key secure. Do not commit it to version control or share it publicly. Use environment variables to store your key in CI/CD environments.

Tags

API Keys - Buckets

A Bucket is an object representing a group of API key consumers for a given account. This section includes a group of endpoints available to perform CRUD operations on a bucket. You can learn more about buckets here.

API Keys - Consumers

A Consumer is an object representing a group of API keys in a given bucket. This section includes a group of endpoints available to perform CRUD operations on a consumer. You can learn more about consumers here.

API Keys - Keys

This is an object representing an API key. This section includes a list of endpoints to perform CRUD operations on an API key. You can learn more about API keys here.

API Keys - Managers

A Manager is an object representing a group of managers in a given consumer. This section includes a group of endpoints available to perform operations on a manager. You can learn more about consumer managers here.

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

Metering - Features

Metering - Meters

Metering - Plans

API Metering plan management

Tunnel Services

List of endpoints available to manage services for a given tunnel.

List of endpoints available to perform operations on Tunnels.

Set of operations available to create and update environment variables. You can learn more about environment variables here.

Schemas

ApiKeyBulkCreateOrUpdateBody Zuplo.Accounts.Account Zuplo.Accounts.AccountsList Zuplo.ApiKeys.ApiKey Zuplo.ApiKeys.ApiKeyCreateOrUpdateBody Zuplo.ApiKeys.ApiKeys Zuplo.ApiKeys.Bucket Zuplo.ApiKeys.BucketCreateBody Zuplo.ApiKeys.BucketUpdateBody Zuplo.ApiKeys.Buckets Zuplo.ApiKeys.Consumer Zuplo.ApiKeys.ConsumerCreateBody Zuplo.ApiKeys.ConsumerUpdateBody Zuplo.ApiKeys.Consumers Zuplo.ApiKeys.KeyFormat Zuplo.ApiKeys.Manager Zuplo.ApiKeys.ManagerCreateBody Zuplo.ApiKeys.Managers Zuplo.AuditLogs.ActingAs Zuplo.AuditLogs.Actor Zuplo.AuditLogs.AuditLog Zuplo.AuditLogs.AuditLogsPagination Zuplo.AuditLogs.AuditLogsResponse Zuplo.AuditLogs.Context Zuplo.AuditLogs.Resource Zuplo.AuditLogs.Route Zuplo.ClientAuth.JwksResponse Zuplo.ClientAuth.OAuthAccessTokenResponse Zuplo.ClientAuth.OAuthErrorResponse Zuplo.Common.ExpiresOnField Zuplo.Configurations.Configuration Zuplo.ConsumerAnalytics.CallsByStatusCodeData Zuplo.ConsumerAnalytics.CallsDetailData Zuplo.ConsumerAnalytics.RecentCallsData Zuplo.ConsumerAnalytics.ReponseStatsByStatusCodeData Zuplo.ConsumerAnalytics.RequestData Zuplo.ConsumerAnalytics.StatsByStatusCode.TimeWindowFilter Zuplo.ConsumerAnalytics.StatsByStatusCodeData Zuplo.ConsumerAnalytics.StatsData Zuplo.DeploymentStatus.DeploymentStatus Zuplo.Deployments.Deployment Zuplo.Deployments.DeploymentsList Zuplo.Deploys.DeploymentResponse Zuplo.Deploys.SourceCreateBody Zuplo.Deploys.SourceUrlCreateBody Zuplo.Environments.Environment Zuplo.Environments.EnvironmentCreateBody Zuplo.Environments.EnvironmentsList Zuplo.HttpProblemDetails.BadRequestProblemResponse Zuplo.HttpProblemDetails.InternalServerErrorProblemResponse Zuplo.HttpProblemDetails.NotFoundProblemResponse Zuplo.HttpProblemDetails.UnauthorizedProblemResponse Zuplo.ManagedDedicated.Fleet Zuplo.ManagedDedicated.FleetConfigurationRequest Zuplo.ManagedDedicated.FleetConfigurationResponse Zuplo.ManagedDedicated.FleetListResponse Zuplo.ManagedDedicated.FleetVendor Zuplo.Metering.Bucket Zuplo.Metering.Buckets Zuplo.Metering.Plan Zuplo.Metering.PlanCreateBody Zuplo.Metering.PlanUpdateBody Zuplo.Metering.Plans Zuplo.Metering.Quota Zuplo.Metering.Subscription Zuplo.Metering.SubscriptionCreateBody Zuplo.Metering.SubscriptionUpdateBody Zuplo.Metering.Subscriptions Zuplo.MtlsCertificates.CertificateInfo Zuplo.MtlsCertificates.Environments Zuplo.MtlsCertificates.MtlsCertificate Zuplo.MtlsCertificates.MtlsCertificateCreateBody Zuplo.MtlsCertificates.MtlsCertificateListResponse Zuplo.MtlsCertificates.MtlsCertificateUpdateBody Zuplo.Projects.Project Zuplo.Projects.ProjectCreateBody Zuplo.Projects.ProjectsList Zuplo.Sources.Source Zuplo.Tunnels.Tunnel Zuplo.Tunnels.TunnelList Zuplo.Tunnels.TunnelListItem Zuplo.Tunnels.TunnelTeardownOperation Zuplo.Tunnels.TunneledServiceConfiguration Zuplo.Tunnels.TunneledServicesConfiguration Zuplo.Tunnels.TunneledServicesProvisioningOperation Zuplo.Variables.Variable Zuplo.Variables.VariableCreateBody Zuplo.Variables.VariableUpdateBody Zuplo.WhoAmI.WhoAmI Addon AddonCreate AddonInstanceType AddonOrderBy AddonPaginatedResponse AddonReplaceUpdate AddonStatus Address Alignment Annotations App AppBase AppCapability AppCapabilityType AppPaginatedResponse AppReadOrCreateOrUpdateOrDeleteOrQuery AppReference AppReplaceUpdate AppStatus AppType BadRequestProblemResponse BalanceHistoryWindow BillingCollectionAlignment BillingCustomerProfile BillingDiscountMetadata BillingDiscountPercentage BillingDiscountReason BillingDiscountUsage BillingDiscounts BillingInvoiceCustomerExtendedDetails BillingParty BillingPartyReplaceUpdate BillingPartyTaxIdentity BillingProfile BillingProfileAppReferences BillingProfileApps BillingProfileAppsCreate BillingProfileAppsOrReference BillingProfileCreate BillingProfileCustomerOverride BillingProfileCustomerOverrideCreate BillingProfileCustomerOverrideExpand BillingProfileCustomerOverrideOrderBy BillingProfileCustomerOverrideWithDetails BillingProfileCustomerOverrideWithDetailsPaginatedResponse BillingProfileCustomerWorkflowOverride BillingProfileExpand BillingProfileOrderBy BillingProfilePaginatedResponse BillingProfileReplaceUpdateWithWorkflow BillingTaxIdentificationCode BillingWorkflow BillingWorkflowAppReferenceType BillingWorkflowCollectionAlignment BillingWorkflowCollectionAlignmentAnchored BillingWorkflowCollectionAlignmentSubscription BillingWorkflowCollectionSettings BillingWorkflowCreate BillingWorkflowInvoicingSettings BillingWorkflowLineResolution BillingWorkflowPaymentSettings BillingWorkflowTaxSettings CheckoutSessionCustomTextAfterSubmitParams CheckoutSessionUIMode ClientAppStartResponse CollectionMethod ConflictProblemResponse CountryCode CreateCheckoutSessionTaxIdCollection CreateCheckoutSessionTaxIdCollectionRequired CreateStripeCheckoutSessionBillingAddressCollection CreateStripeCheckoutSessionConsentCollection CreateStripeCheckoutSessionConsentCollectionPaymentMethodReuseAgreement CreateStripeCheckoutSessionConsentCollectionPaymentMethodReuseAgreementPosition CreateStripeCheckoutSessionConsentCollectionPromotions CreateStripeCheckoutSessionConsentCollectionTermsOfService CreateStripeCheckoutSessionCustomerUpdate CreateStripeCheckoutSessionCustomerUpdateBehavior CreateStripeCheckoutSessionRedirectOnCompletion CreateStripeCheckoutSessionRequest CreateStripeCheckoutSessionRequestOptions CreateStripeCheckoutSessionResult CreateStripeCustomerPortalSessionParams CreditNoteOriginalInvoiceRef Currency CurrencyCode CustomInvoicingApp CustomInvoicingAppReplaceUpdate CustomInvoicingCustomerAppData CustomInvoicingDraftSynchronizedRequest CustomInvoicingFinalizedInvoicingRequest CustomInvoicingFinalizedPaymentRequest CustomInvoicingFinalizedRequest CustomInvoicingLineDiscountExternalIdMapping CustomInvoicingLineExternalIdMapping CustomInvoicingPaymentTrigger CustomInvoicingSyncResult CustomInvoicingTaxConfig CustomInvoicingUpdatePaymentStatusRequest CustomPlanInput CustomSubscriptionChange CustomSubscriptionCreate Customer CustomerAccess CustomerAppData CustomerAppDataCreateOrUpdateItem CustomerAppDataPaginatedResponse CustomerCreate CustomerExpand CustomerId CustomerKey CustomerOrderBy CustomerPaginatedResponse CustomerReplaceUpdate CustomerSubscriptionOrderBy CustomerUsageAttribution DiscountPercentage DiscountReasonMaximumSpend DiscountReasonProrationCredit DiscountReasonRatecardPercentage DiscountReasonRatecardUsage DiscountReasonType DiscountUsage Discounts DynamicPrice DynamicPriceWithCommitments EditOp EditSubscriptionAddItem EditSubscriptionAddPhase EditSubscriptionRemoveItem EditSubscriptionRemovePhase EditSubscriptionStretchPhase EditSubscriptionUnscheduleEdit Entitlement EntitlementBaseTemplate EntitlementBoolean EntitlementBooleanCreateInputs EntitlementBooleanV2 EntitlementCreateInputs EntitlementCreateSharedFields EntitlementCustomerFields EntitlementGrant EntitlementGrantCreateInput EntitlementGrantCreateInputV2 EntitlementGrantV2 EntitlementMetered EntitlementMeteredCalculatedFields EntitlementMeteredCreateInputs EntitlementMeteredV2 EntitlementMeteredV2CreateInputs EntitlementOrderBy EntitlementPaginatedResponse EntitlementStatic EntitlementStaticCreateInputs EntitlementStaticV2 EntitlementType EntitlementV2 EntitlementV2CreateInputs EntitlementV2PaginatedResponse EntitlementValue ErrorExtension Event EventDeliveryAttemptResponse ExpirationDuration ExpirationPeriod Feature FeatureCreateInputs FeatureMeta FeatureOrderBy FeaturePaginatedResponse FilterBoolean FilterFloat FilterIDExact FilterInteger FilterString FilterTime FlatPrice FlatPriceWithPaymentTerm ForbiddenProblemResponse GatewayTimeoutProblemResponse GrantBurnDownHistorySegment GrantOrderBy GrantPaginatedResponse GrantUsageRecord GrantV2PaginatedResponse IDResource IngestEventsBody IngestedEvent IngestedEventCursorPaginatedResponse InstallMethod InternalServerErrorProblemResponse Invoice InvoiceAppExternalIds InvoiceAvailableActionDetails InvoiceAvailableActionInvoiceDetails InvoiceAvailableActions InvoiceDetailedLine InvoiceDetailedLineCostCategory InvoiceDetailedLineRateCard InvoiceDiscountBase InvoiceDocumentRef InvoiceDocumentRefType InvoiceExpand InvoiceGenericDocumentRef InvoiceLine InvoiceLineAmountDiscount InvoiceLineAppExternalIds InvoiceLineBase InvoiceLineDiscounts InvoiceLineManagedBy InvoiceLineReplaceUpdate InvoiceLineStatus InvoiceLineSubscriptionReference InvoiceLineTaxBehavior InvoiceLineTaxItem InvoiceLineTypes InvoiceLineUsageDiscount InvoiceNumber InvoiceOrderBy InvoicePaginatedResponse InvoicePaymentTerms InvoicePendingLineCreate InvoicePendingLineCreateInput InvoicePendingLineCreateResponse InvoicePendingLinesActionFiltersInput InvoicePendingLinesActionInput InvoiceReference InvoiceReplaceUpdate InvoiceSimulationInput InvoiceSimulationLine InvoiceStatus InvoiceStatusDetails InvoiceTotals InvoiceType InvoiceUsageBasedRateCard InvoiceWorkflowInvoicingSettingsReplaceUpdate InvoiceWorkflowReplaceUpdate InvoiceWorkflowSettings InvoiceWorkflowSettingsReplaceUpdate IssueAfterReset ListAppsRequest ListEntitlementsResult ListFeaturesResult MarketplaceInstallRequestPayload MarketplaceInstallResponse MarketplaceListing MarketplaceListingPaginatedResponse MeasureUsageFrom MeasureUsageFromPreset MeasureUsageFromTime Metadata Meter MeterAggregation MeterCreate MeterOrderBy MeterQueryRequest MeterQueryResult MeterQueryRow MeterUpdate NotFoundProblemResponse NotImplementedProblemResponse NotificationChannel NotificationChannelCreateRequest NotificationChannelMeta NotificationChannelOrderBy NotificationChannelPaginatedResponse NotificationChannelType NotificationChannelWebhook NotificationChannelWebhookCreateRequest NotificationEvent NotificationEventBalanceThresholdPayload NotificationEventBalanceThresholdPayloadData NotificationEventDeliveryAttempt NotificationEventDeliveryStatus NotificationEventDeliveryStatusState NotificationEventEntitlementValuePayloadBase NotificationEventInvoiceCreatedPayload NotificationEventInvoiceUpdatedPayload NotificationEventOrderBy NotificationEventPaginatedResponse NotificationEventPayload NotificationEventResendRequest NotificationEventResetPayload NotificationEventType NotificationRule NotificationRuleBalanceThreshold NotificationRuleBalanceThresholdCreateRequest NotificationRuleBalanceThresholdValue NotificationRuleBalanceThresholdValueType NotificationRuleCreateRequest NotificationRuleEntitlementReset NotificationRuleEntitlementResetCreateRequest NotificationRuleInvoiceCreated NotificationRuleInvoiceCreatedCreateRequest NotificationRuleInvoiceUpdated NotificationRuleInvoiceUpdatedCreateRequest NotificationRuleMeta NotificationRuleOrderBy NotificationRulePaginatedResponse Numeric OAuth2AuthorizationCodeGrantErrorType PackagePrice PackagePriceWithCommitments PaymentDueDate PaymentTermDueDate PaymentTermInstant PaymentTermType PaymentTerms Percentage Period Plan PlanAddon PlanAddonCreate PlanAddonOrderBy PlanAddonPaginatedResponse PlanAddonReplaceUpdate PlanCreate PlanOrderBy PlanPaginatedResponse PlanPhase PlanReference PlanReferenceInput PlanReplaceUpdate PlanStatus PlanSubscriptionChange PlanSubscriptionCreate PortalToken PreconditionFailedProblemResponse Price PricePaymentTerm PriceTier PriceType ProRatingConfig ProRatingMode Progress RateCard RateCardBooleanEntitlement RateCardEntitlement RateCardFlatFee RateCardMeteredEntitlement RateCardStaticEntitlement RateCardType RateCardUsageBased RateCardUsageBasedPrice RecurringPeriod RecurringPeriodCreateInput RecurringPeriodInterval RecurringPeriodIntervalEnum RecurringPeriodV2 RemovePhaseShifting ResetEntitlementUsageInput SandboxApp SandboxAppReplaceUpdate SandboxCustomerAppData ServiceUnavailableProblemResponse SortOrder SpendCommitments StripeAPIKeyInput StripeApp StripeAppReadOrCreateOrUpdateOrDeleteOrQuery StripeAppReplaceUpdate StripeCheckoutSessionMode StripeCustomerAppData StripeCustomerAppDataBase StripeCustomerAppDataCreateOrUpdateItem StripeCustomerPortalSession StripeTaxConfig StripeWebhookEvent StripeWebhookResponse Subject SubjectUpsert Subscription SubscriptionAccess SubscriptionAddon SubscriptionAddonCreate SubscriptionAddonRateCard SubscriptionAddonTimelineSegment SubscriptionAddonUpdate SubscriptionAlignment SubscriptionBadRequestErrorResponse SubscriptionChange SubscriptionChangeResponseBody SubscriptionConflictErrorResponse SubscriptionCreate SubscriptionEdit SubscriptionEditOperation SubscriptionEntitlements SubscriptionErrorExtensions SubscriptionExpanded SubscriptionItem SubscriptionItemIncluded SubscriptionPaginatedResponse SubscriptionPaymentStatus SubscriptionPaymentStatusType SubscriptionPhase SubscriptionPhaseCreate SubscriptionPhaseExpanded SubscriptionStatus SubscriptionTiming SubscriptionTimingEnum TaxBehavior TaxConfig TieredPrice TieredPriceMode TieredPriceWithCommitments ULIDOrExternalKey UnauthorizedProblemResponse UnexpectedProblemResponse UnitPrice UnitPriceWithCommitments ValidationError ValidationErrorProblemResponse ValidationIssue ValidationIssueSeverity VoidInvoiceActionCreate VoidInvoiceActionCreateItem VoidInvoiceActionInput VoidInvoiceActionLineOverride VoidInvoiceLineActionCreate VoidInvoiceLineActionCreateItem VoidInvoiceLineActionType VoidInvoiceLineDiscardAction VoidInvoiceLinePendingActionCreate VoidInvoiceLinePendingActionCreateItem WindowSize WindowedBalanceHistory

Terms of Service

ContactZuplosupport@zuplo.com https://zuplo.com/

Servers

https://dev.zuplo.com

Zuplo API