Zuplo
The Zuplo Developer API, powered by Zuplo

​Schemas

​ApiKeyBulkCreateOrUpdateBody

  • expiresOnstring · date-time
  • descriptionstring
  • keystring

​Zuplo.Accounts.Account

  • idstring · required
    Example: 103f832d-5331-42db-9d38-bbac05a68305
  • namestring · required
    Example: my-account
  • labelstring
    Example: My Account

​Zuplo.Accounts.AccountsList

  • dataobject[] · required

​Zuplo.ApiKeys.ApiKey

  • createdOnstring · date-time · readOnly · required
    Example: 2023-04-18T05:54:34.408Z
  • updatedOnstring · date-time · readOnly · required
    Example: 2023-04-20T05:54:34.408Z
  • idstring · readOnly · required
  • expiresOnstring · date-time
  • descriptionstring
  • keystring

​Zuplo.ApiKeys.ApiKeyCreateOrUpdateBody

  • expiresOnstring · date-time
  • descriptionstring
  • keystring

​Zuplo.ApiKeys.ApiKeys

  • dataobject[] · required
  • limitinteger · uint32
    Example: 1000
  • offsetinteger · uint32
  • totalinteger · uint32

​Zuplo.ApiKeys.Bucket

  • createdOnstring · date-time · readOnly · required
    Example: 2023-04-18T05:54:34.408Z
  • updatedOnstring · date-time · readOnly · required
    Example: 2023-04-20T05:54:34.408Z
  • idstring · readOnly · required
  • namestring · pattern: ^[a-z0-9-]{5,128}$ · required
  • isRetrievableboolean
  • descriptionstring
  • tagsobject

​Zuplo.ApiKeys.BucketCreateBody

  • namestring · pattern: ^[a-z0-9-]{5,128}$ · required
  • descriptionstring
  • tagsobject

​Zuplo.ApiKeys.BucketUpdateBody

  • descriptionstring
  • tagsobject

​Zuplo.ApiKeys.Buckets

  • dataobject[] · required
  • limitinteger · uint32
    Example: 1000
  • offsetinteger · uint32
  • totalinteger · uint32

​Zuplo.ApiKeys.Consumer

  • createdOnstring · date-time · readOnly · required
    Example: 2023-04-18T05:54:34.408Z
  • updatedOnstring · date-time · readOnly · required
    Example: 2023-04-20T05:54:34.408Z
  • idstring · readOnly · required
  • namestring · pattern: ^[a-z0-9-]{1,128}$ · required
  • apiKeysobject[]
  • descriptionstring
  • tagsobject
  • metadataobject

​Zuplo.ApiKeys.ConsumerCreateBody

  • namestring · pattern: ^[a-z0-9-]{1,128}$ · required
  • managers
  • apiKeysobject[]
  • descriptionstring
  • tagsobject
  • metadataobject

​Zuplo.ApiKeys.ConsumerUpdateBody

  • descriptionstring
  • tagsobject
  • metadataobject

​Zuplo.ApiKeys.Consumers

  • dataobject[] · required
  • limitinteger · uint32
    Example: 1000
  • offsetinteger · uint32
  • totalinteger · uint32

​Zuplo.ApiKeys.KeyFormat

string · enum
Enum values:
none
visible
masked

​Zuplo.ApiKeys.ManagerCreateItem

  • emailstring · required
  • substring · required

​Zuplo.ClientAuth.JwksResponse

  • keysobject · required

​Zuplo.ClientAuth.OAuthAccessTokenResponse

  • access_tokenstring · required
    Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJz...
  • token_typestring · enum · required
    Enum values:
    Bearer
    Example: Bearer
  • expires_ininteger · required
    Example: 3600
  • scopestring
    Example: account project deployment

​Zuplo.ClientAuth.OAuthErrorResponse

  • errorstring · required
    Example: invalid_client
  • error_descriptionstring · required
    Example: Client authentication failed

​Zuplo.Common.ExpiresOnField

  • expiresOnstring · date-time · required
    Example: 2050-04-18T05:54:34.408Z

​Zuplo.Configurations.Configuration

  • accountNamestring · required
    Example: chocolate_great_buzzard
  • projectNamestring · required
    Example: lime-fox
  • environmentTypestring · enum · required
    Enum values:
    production
    preview
    development
    Example: production
  • systemConfigurationsstring · required
    Example: 72ih3avJtXRUz6jqHtLEBFVmJDYr1GZtMTKFS8Q71SbyiHgzbL9fPscMURcuEPnryrMv3ABU1fB4qgopG5CkmdgD2...

​Zuplo.ConsumerAnalytics.CallsByStatusCodeData

​Zuplo.ConsumerAnalytics.CallsDetailData

  • consumerstring · readOnly · required
  • timeStampstring · readOnly · required
  • totalCallsinteger · readOnly · required
  • callsByStatusCodeobject[] · readOnly · required

​Zuplo.ConsumerAnalytics.RecentCallsData

  • dataobject[] · readOnly · required

​Zuplo.ConsumerAnalytics.ReponseStatsByStatusCodeData

  • dataobject · readOnly · required

​Zuplo.ConsumerAnalytics.RequestData

  • consumerstring · readOnly · required
  • methodstring · readOnly · required
  • routePathstring · readOnly · required
  • statusCodestring · readOnly · required
  • timeStampstring · readOnly · required
  • citystring · readOnly · required
  • countrystring · 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

  • statsobject[] · readOnly
  • detailsobject[] · readOnly

​Zuplo.ConsumerAnalytics.StatsData

  • totalCallsinteger · readOnly · required
  • consumerstring · readOnly · required
  • callsByStatusCodeobject[] · readOnly · required

​Zuplo.DeploymentStatus.DeploymentStatus

  • statusstring · enum · required
    Enum values:
    SUCCESS
    ERROR
    IN_PROGRESS
    Example: SUCCESS
  • urlstring · required
    Example: https://api.zuplo.com/v1/deployments/lime-fox-main-bbe7540
  • stepsobject · required
  • buildResultobject · required

​Zuplo.Deployments.Deployment

  • namestring · required
    Example: lime-fox-main-bbe7540
  • urlstring · required
    Example: https://api.zuplo.com/deployments/lime-fox-main-bbe7540
  • labelstring · required
    Example: main
  • urlParameterstring · required
    Example: main
  • createdOnstring · required
    Example: 2023-07-25T23:41:41.468Z
  • updatedOnstring · required
    Example: 2023-07-25T23:41:41.468Z
  • loggingIdstring · required
    Example: chocolate_great_buzzard::lime-fox::main::main::bbe7540
  • accountNamestring · required
    Example: chocolate_great_buzzard
  • projectNamestring · required
    Example: lime-fox
  • statestring · required
    Example: STARTED
  • messagestring · enum · required
    Enum values:
  • branchNamestring · required
    Example: main
  • environmentTypestring · required
    Example: PRODUCTION

​Zuplo.Deployments.DeploymentsList

  • dataobject[] · required

​Zuplo.Deploys.DeploymentResponse

  • statusstring · required

​Zuplo.Deploys.SourceCreateBody

  • accountNamestring · required
    Example: my-account
  • projectNamestring · required
    Example: my-project
  • branchNamestring · required
    Example: main

​Zuplo.Deploys.SourceUrlCreateBody

  • accountNamestring · required
    Example: my-account
  • projectNamestring · required
    Example: my-project
  • branchNamestring · required
    Example: main
  • repositoryUrlstring
    Example: https://github.com/my-account/my-project
  • branchstring
    Example: main
  • shastring
    Example: 9fb5c38a83013be1625c9b5cb2d1bdf458ff827e

​Zuplo.Environments.Environment

  • namestring · required
    Example: lime-fox-main-bbe7540
  • createdOnstring · required
    Example: 2023-07-25T23:41:41.468Z
  • accountNamestring · required
    Example: chocolate_great_buzzard
  • projectNamestring · required
    Example: lime-fox
  • branchNamestring · required
    Example: main
  • environmentTypestring · enum · required
    Enum values:
    production
    preview
    development
    Example: production

​Zuplo.Environments.EnvironmentCreateBody

  • accountNamestring · required
    Example: my-account
  • projectNamestring · required
    Example: my-project
  • environmentTypestring · enum · required
    Enum values:
    pruduction
    preview
    Example: preview
  • branchNamestring · required
    Example: main

​Zuplo.Environments.EnvironmentsList

  • dataobject[] · required

​Zuplo.HttpProblemDetails.BadRequestProblemResponse

  • typestring · enum · required
    Enum values:
    https://httpproblems.com/http-status/400
  • titlestring · enum · required
    Enum values:
    Bad Request
  • detailstring
  • instancestring

​Zuplo.HttpProblemDetails.InternalServerErrorProblemResponse

  • typestring · enum · required
    Enum values:
    https://httpproblems.com/http-status/500
  • titlestring · enum · required
    Enum values:
    Internal Server Error
  • detailstring
  • instancestring

​Zuplo.HttpProblemDetails.NotFoundProblemResponse

  • typestring · enum · required
    Enum values:
    https://httpproblems.com/http-status/404
  • titlestring · enum · required
    Enum values:
    Not Found
  • detailstring
  • instancestring

​Zuplo.HttpProblemDetails.UnauthorizedProblemResponse

  • typestring · enum · required
    Enum values:
    https://httpproblems.com/http-status/401
  • titlestring · enum · required
    Enum values:
    Unauthorized
  • detailstring
  • instancestring

​Zuplo.Metering.Bucket

  • createdOnstring · date-time · readOnly · required
    Example: 2023-04-18T05:54:34.408Z
  • updatedOnstring · date-time · readOnly · required
    Example: 2023-04-20T05:54:34.408Z
  • idstring · readOnly · required
    Example: mtr_STYBm01FabkgZOP3KtkYdJuO
  • accountNamestring · readOnly · required
    Example: my-account

​Zuplo.Metering.Buckets

  • dataobject[] · required
  • limitinteger · uint32
    Example: 1000
  • offsetinteger · uint32
  • totalinteger · uint32

​Zuplo.Metering.Plan

  • createdOnstring · date-time · readOnly · required
    Example: 2023-04-18T05:54:34.408Z
  • updatedOnstring · date-time · readOnly · required
    Example: 2023-04-20T05:54:34.408Z
  • idstring · readOnly · required
    Example: plan_40dRwJecUOu9xDj2OeXDcYA5
  • hasSubscriptionsboolean · readOnly · required
    Example: true
  • labelstring · required
    Example: Basic Subscription Plan
  • planExternalIdstring · required
    Example: prod_Pbyd5ARBWtFxkg
  • metersobject · required
    Example: {"requests":{"label":"Requests","max":10}}
  • trialDaysinteger
    Example: 10
  • trialEndStatusstring · enum
    Enum values:
    paused
    canceled
    Example: paused
  • isTrialCollectPaymentboolean

​Zuplo.Metering.PlanCreateBody

  • labelstring · required
    Example: Basic Subscription Plan
  • planExternalIdstring · required
    Example: prod_Pbyd5ARBWtFxkg
  • metersobject · required
    Example: {"requests":{"label":"Requests","max":10}}
  • trialDaysinteger
    Example: 10
  • trialEndStatusstring · enum
    Enum values:
    paused
    canceled
    Example: paused
  • isTrialCollectPaymentboolean

​Zuplo.Metering.PlanUpdateBody

  • labelstring
    Example: Basic Subscription Plan
  • planExternalIdstring
    Example: prod_Pbyd5ARBWtFxkg
  • metersobject
    Example: {"requests":{"label":"Requests","max":10}}
  • trialDaysinteger
    Example: 10
  • trialEndStatusstring · enum
    Enum values:
    paused
    canceled
    Example: paused
  • isTrialCollectPaymentboolean

​Zuplo.Metering.Plans

  • dataobject[] · required
  • limitinteger · uint32
    Example: 1000
  • offsetinteger · uint32
  • totalinteger · uint32

​Zuplo.Metering.Quota

integer

​Zuplo.Metering.Subscription

  • createdOnstring · date-time · readOnly · required
    Example: 2023-04-18T05:54:34.408Z
  • updatedOnstring · date-time · readOnly · required
    Example: 2023-04-20T05:54:34.408Z
  • idstring · readOnly · required
    Example: sbsc_BnCcCqQHM5H4z60sTR0FfCKg
  • planIdsstring[] · required
    Example: ["plan_ZLbXn7SCZt6KJnD6SU8Ljv8w"]
  • planExternalIdsstring[] · required
    Example: ["prod_Pbyd5ARBWtFxkg"]
  • statusstring · enum · required
    Enum values:
    active
    inactive
    incomplete
    incomplete-expired
    trialing
    past-due
    canceled
    unpaid
  • typestring · enum · required
    Enum values:
    periodic
  • renewalStrategystring · enum · required
    Enum values:
    monthly
    yearly
  • regionstring · enum · required
    Enum values:
    us-central1
    us-east1
    europe-west4
  • customerKeystring · required
    Example: d8984b34-defd-458c-bf34-7fb1b69ce714
  • subscriptionExternalIdstring · required
    Example: sub_1OmlUlLQav6G4UBHsPy2BY7J
  • customerExternalIdstring · required
    Example: cus_PbzTcoZtPtelYg
  • quotaResetAnchorstring · date-time
  • metadataobject
  • trialEndStatusstring
    Example: paused
  • trialEndDatestring · date-time
  • trialStartDatestring · date-time
  • nextBillingCyclestring · date-time
  • productKeystring

​Zuplo.Metering.SubscriptionCreateBody

  • planIdsstring[] · required
    Example: ["plan_ZLbXn7SCZt6KJnD6SU8Ljv8w"]
  • planExternalIdsstring[] · required
    Example: ["prod_Pbyd5ARBWtFxkg"]
  • statusstring · enum · required
    Enum values:
    active
    inactive
    incomplete
    incomplete-expired
    trialing
    past-due
    canceled
    unpaid
  • typestring · enum · required
    Enum values:
    periodic
  • renewalStrategystring · enum · required
    Enum values:
    monthly
    yearly
  • regionstring · enum · required
    Enum values:
    us-central1
    us-east1
    europe-west4
  • customerKeystring · required
    Example: d8984b34-defd-458c-bf34-7fb1b69ce714
  • subscriptionExternalIdstring · required
    Example: sub_1OmlUlLQav6G4UBHsPy2BY7J
  • customerExternalIdstring · required
    Example: cus_PbzTcoZtPtelYg
  • quotaResetAnchorstring · date-time
  • metadataobject
  • trialEndStatusstring
    Example: paused
  • trialEndDatestring · date-time
  • trialStartDatestring · date-time
  • nextBillingCyclestring · date-time
  • productKeystring

​Zuplo.Metering.SubscriptionUpdateBody

  • planExternalIdsstring[]
    Example: ["prod_Pbyd5ARBWtFxkg"]
  • statusstring · enum
    Enum values:
    active
    inactive
    incomplete
    incomplete-expired
    trialing
    past-due
    canceled
    unpaid
  • proratenumber
    Example: 0.75
  • metadataobject
  • trialEndDatestring · date-time

​Zuplo.Metering.Subscriptions

  • dataobject[] · required
  • limitinteger · uint32
    Example: 1000
  • offsetinteger · uint32
  • totalinteger · uint32

​Zuplo.Projects.Project

  • namestring · required
    Example: lime-fox
  • accountNamestring · required
    Example: lime-fox

​Zuplo.Projects.ProjectsList

  • dataobject[] · required

​Zuplo.Sources.Source

  • uploadUrlstring · required
    Example: https://storage.googleapis.com/[..]1fac8da132b9

​Zuplo.Tunnels.Tunnel

  • tunnelIdstring · readOnly · required
    Example: tnl_JcHFzTcJ9y4GU69lKBOaxFYU
  • namestring · pattern: ^[a-zA-Z0-9-]{3,24}$ · required
    Example: api-service-tunnel
  • tokenstring · readOnly · required
    Example: eyJhIjoiODJh[..]m89In0=

​Zuplo.Tunnels.TunnelList

  • dataobject[] · required
  • limitinteger · uint32
    Example: 1000
  • offsetinteger · uint32
  • totalinteger · uint32

​Zuplo.Tunnels.TunnelListItem

  • idstring · readOnly · required
    Example: tnl_JcHFzTcJ9y4GU69lKBOaxFYU
  • namestring · pattern: ^[a-zA-Z0-9-]{3,24}$ · required
    Example: api-service-tunnel

​Zuplo.Tunnels.TunnelTeardownOperation

  • idstring · readOnly · required
    Example: tst_1vmvAjaCun9Mfeosn3Og4ddD
  • statusstring · enum · required
    Enum values:
    in-progress
    success
    error
    Example: success
  • messagestring
    Example: Successfully torn down tunnel.
  • detailsstring

​Zuplo.Tunnels.TunneledServiceConfiguration

  • namestring · pattern: ^[a-zA-Z0-9-]{3,24}$ · required
    Example: authservice
  • endpointstring · required
    Example: https://localhost:3000
  • configurationsobject[] · required

​Zuplo.Tunnels.TunneledServicesConfiguration

  • versioninteger · uint8 · required
    Example: 1
  • servicesobject[] · required

​Zuplo.Tunnels.TunneledServicesProvisioningOperation

  • idstring · readOnly · required
    Example: pst_ezMUOh0xFqRWg84DPH5jVwgO
  • statusstring · enum · required
    Enum values:
    in-progress
    success
    error
    Example: success
  • messagestring
    Example: Successfully provisioned services.
  • detailsstring

​Zuplo.Variables.Variable

  • branchstring · readOnly · required
    Example: preview
  • createdOnstring · date-time · readOnly · required
    Example: 2023-04-18T05:54:34.408Z
  • updatedOnstring · date-time · readOnly · required
    Example: 2023-04-20T05:54:34.408Z
  • namestring · required
    Example: APP_ENVIRONMENT_KEY
  • isSecretboolean · required
    Example: true
  • valuestring · required

​Zuplo.Variables.VariableCreateBody

  • namestring · required
    Example: APP_ENVIRONMENT_KEY
  • isSecretboolean · required
    Example: true
  • valuestring · required

​Zuplo.Variables.VariableUpdateBody

  • valuestring

​Zuplo.WhoAmI.WhoAmI

  • accountstring · required
    Example: chocolate_blizzard_treat