Zuplo
The Zuplo Developer API, powered by Zuplo

Schemas

ApiKeyBulkCreateOrUpdateBody

  • expiresOnstring · date-time

    When the key expires.

  • descriptionstring

    The description of the api key.

  • keystring

    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

  • idstring · required

    The id of the account

    Example: 103f832d-5331-42db-9d38-bbac05a68305
  • namestring · required

    The name of the account

    Example: my-account
  • labelstring

    The label of the account

    Example: My Account

Zuplo.Accounts.AccountsList

  • dataobject[] · required

Zuplo.ApiKeys.ApiKey

  • createdOnstring · date-time · readOnly · required

    When the item was created.

    Example: 2023-04-18T05:54:34.408Z
  • updatedOnstring · date-time · readOnly · required

    When the item was last updated.

    Example: 2023-04-20T05:54:34.408Z
  • idstring · readOnly · required
  • expiresOnstring · date-time

    When the key expires.

  • descriptionstring

    The description of the api key.

  • keystring

    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

  • expiresOnstring · date-time

    When the key expires.

  • descriptionstring

    The description of the api key.

  • keystring

    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

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

Zuplo.ApiKeys.Bucket

  • createdOnstring · date-time · readOnly · required

    When the item was created.

    Example: 2023-04-18T05:54:34.408Z
  • updatedOnstring · date-time · readOnly · required

    When the item was last updated.

    Example: 2023-04-20T05:54:34.408Z
  • idstring · readOnly · required
  • namestring · pattern: ^[a-z0-9-]{5,128}$ · required

    A friendly name for the bucket.

  • isRetrievableboolean

    Whether the API keys stored in the bucket are retrievable

  • descriptionstring

    A description of the bucket.

  • tagsobject

    Key value pairs to associate with the bucket.

Zuplo.ApiKeys.BucketCreateBody

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

    A friendly name for the bucket.

  • descriptionstring

    A description of the bucket.

  • tagsobject

    Key value pairs to associate with the bucket.

Zuplo.ApiKeys.BucketUpdateBody

  • descriptionstring

    A description of the bucket.

  • tagsobject

    Key value pairs to associate with the bucket.

Zuplo.ApiKeys.Buckets

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

Zuplo.ApiKeys.Consumer

  • createdOnstring · date-time · readOnly · required

    When the item was created.

    Example: 2023-04-18T05:54:34.408Z
  • updatedOnstring · date-time · readOnly · required

    When the item was last updated.

    Example: 2023-04-20T05:54:34.408Z
  • idstring · readOnly · required
  • namestring · 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.

  • apiKeysobject[]
  • descriptionstring

    A description of the consumer.

  • tagsobject

    Key value pairs to associate with the consumer.

  • metadataobject

    Generic metadata associated with the consumer.

Zuplo.ApiKeys.ConsumerCreateBody

  • namestring · 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.

  • managers

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

  • apiKeysobject[]
  • descriptionstring

    A description of the consumer.

  • tagsobject

    Key value pairs to associate with the consumer.

  • metadataobject

    Generic metadata associated with the consumer.

Zuplo.ApiKeys.ConsumerUpdateBody

  • descriptionstring

    A description of the consumer.

  • tagsobject

    Key value pairs to associate with the consumer.

  • metadataobject

    Generic metadata associated with the consumer.

Zuplo.ApiKeys.Consumers

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

Zuplo.ApiKeys.KeyFormat

string · enum
Enum values:
none
visible
masked

Zuplo.ApiKeys.ManagerCreateItem

  • emailstring · required

    The email address of the manager

  • substring · required

    The sub of the manager in the identity provider

Zuplo.AuditLogs.ActingAs

  • substring · required

    The subject identifier of the user being impersonated

  • emailstring | null · required

    The email address of the impersonated user (if available)

Zuplo.AuditLogs.Actor

  • substring · required

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

  • emailstring | null · required

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

  • typestring · required

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

  • connectionstring | null · required

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

  • actingAsobject · required

    Information about the user being impersonated, if any

  • metadataobject | null · required

    Additional metadata about the actor

Zuplo.AuditLogs.AuditLog

  • actionstring · required

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

  • metadataobject | null · required

    Additional metadata about the action

  • actorobject · required

    Details about the actor who performed the action

  • resourcesarray | null · required

    List of resources affected by this action

  • contextobject · required

    Contextual information about where and how the action was performed

  • routeobject · required

    Information about the API route that triggered this audit event

  • timestampstring · date-time · required

    The timestamp when the action occurred

  • requestIdstring · required

    The unique request ID for correlation

  • successboolean | null · required

    Whether the action was successful

  • errorstring | null · required

    Error message if the action failed

Zuplo.AuditLogs.AuditLogsPagination

  • limitinteger · int32 · required

    Maximum number of results returned

  • offsetinteger · int32 · required

    Number of results skipped

  • totalinteger · int32 · required

    Total number of results available

  • hasMoreboolean · required

    Whether there are more results available

Zuplo.AuditLogs.AuditLogsResponse

  • dataobject[] · required

    Array of audit log entries

  • paginationobject · required

    Pagination information

Zuplo.AuditLogs.Context

  • ipAddressstring | null · required

    The IP address of the request

  • userAgentstring | null · required

    The user agent string of the request

  • countrystring | null · required

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

  • regionstring | null · required

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

  • citystring | null · required

    The city name from which the request originated

  • postalCodestring | null · required

    The postal/ZIP code

  • metroCodestring | null · required

    The metro code (DMA code in the US)

  • asOrgstring | null · required

    The Autonomous System organization (ISP name)

Zuplo.AuditLogs.Resource

  • typestring · required

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

  • idstring · required

    The unique identifier of the resource

  • metadataobject | null · required

    Additional metadata about the resource

Zuplo.AuditLogs.Route

  • sourcestring | null · required

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

  • urlstring | null · required

    The full URL path of the request

  • methodstring | null · required

    The HTTP method used for the request

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

    When the item will expire.

    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

    The name of the deployment. You can find this in the Zuplo Portal under Settings > Environments.

    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:
    Example:
  • branchNamestring · required
    Example: main
  • environmentTypestring · required
    Example: PRODUCTION

Zuplo.Deployments.DeploymentsList

  • dataobject[] · required

Zuplo.Deploys.DeploymentResponse

  • statusstring · required

Zuplo.Deploys.SourceCreateBody

  • accountNamestring · required

    The name of the account

    Example: my-account
  • projectNamestring · required

    The name of the project

    Example: my-project
  • branchNamestring · required

    The name of the branch for deployment

    Example: main

Zuplo.Deploys.SourceUrlCreateBody

  • accountNamestring · required

    The name of the account

    Example: my-account
  • projectNamestring · required

    The name of the project

    Example: my-project
  • branchNamestring · required

    The name of the branch for deployment

    Example: main
  • repositoryUrlstring

    The git repository url of the source code

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

    The git branch

    Example: main
  • shastring

    The git sha of the commit

    Example: 9fb5c38a83013be1625c9b5cb2d1bdf458ff827e

Zuplo.Environments.Environment

  • namestring · required

    The name of the environment.

    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

    The name of the account

    Example: my-account
  • projectNamestring · required

    The name of the project

    Example: my-project
  • environmentTypestring · enum · required

    The name of the branch for deployment

    Enum values:
    pruduction
    preview
    Example: preview
  • branchNamestring · required

    The name of the branch for deployment

    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.ManagedDedicated.Fleet

  • idstring · required

    Fleet ID

  • namestring · required

    Fleet name

  • vendorstring · enum · required

    Fleet vendor

    Enum values:
    akamai
    amazon
    google
    microsoft
  • controlPlaneUrlstring · required

    Control plane URL

  • isAccountDefaultboolean · required

    Whether this is the default fleet for the account

  • createdOnstring · date-time · required

    Creation timestamp

  • updatedOnstring · date-time · required

    Last update timestamp

Zuplo.ManagedDedicated.FleetConfigurationRequest

No data returned

Zuplo.ManagedDedicated.FleetConfigurationResponse

No data returned

Zuplo.ManagedDedicated.FleetListResponse

  • dataobject[] · required

    List of fleets

Zuplo.ManagedDedicated.FleetVendor

string · enum
Enum values:
akamai
amazon
google
microsoft

Fleet vendor

Zuplo.Metering.Bucket

  • createdOnstring · date-time · readOnly · required

    When the item was created.

    Example: 2023-04-18T05:54:34.408Z
  • updatedOnstring · date-time · readOnly · required

    When the item was last updated.

    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
    Example: 0
  • totalinteger · uint32

Zuplo.Metering.Plan

  • createdOnstring · date-time · readOnly · required

    When the item was created.

    Example: 2023-04-18T05:54:34.408Z
  • updatedOnstring · date-time · readOnly · required

    When the item was last updated.

    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
    Example: 0
  • totalinteger · uint32

Zuplo.Metering.Quota

integer

Zuplo.Metering.Subscription

  • createdOnstring · date-time · readOnly · required

    When the item was created.

    Example: 2023-04-18T05:54:34.408Z
  • updatedOnstring · date-time · readOnly · required

    When the item was last updated.

    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
    Example: 0
  • totalinteger · uint32

Zuplo.MtlsCertificates.CertificateInfo

  • subjectstring · required

    Certificate subject

    Example: CN=example.com
  • issuerstring · required

    Certificate issuer

    Example: CN=Example CA
  • validFromstring · required

    Certificate valid from date

    Example: 2024-01-01T00:00:00Z
  • validTostring · required

    Certificate valid to date

    Example: 2025-01-01T00:00:00Z
  • serialNumberstring · required

    Certificate serial number

    Example: 12345

Zuplo.MtlsCertificates.Environments

  • developmentboolean · required

    Whether the certificate is enabled for the development environment

  • previewboolean · required

    Whether the certificate is enabled for the preview environment

  • productionboolean · required

    Whether the certificate is enabled for the production environment

Zuplo.MtlsCertificates.MtlsCertificate

  • idstring · readOnly · required

    The unique identifier for the certificate

    Example: cert_abc123
  • namestring · minLength: 1 · maxLength: 120 · required

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

    Example: my_client_cert
  • certificateInfoobject · required

    Certificate information

  • environmentsobject · required

    Environments where the certificate is enabled

  • createdOnstring · date-time · readOnly · required

    When the item was created.

    Example: 2023-04-18T05:54:34.408Z
  • updatedOnstring · date-time · readOnly · required

    When the item was last updated.

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

Zuplo.MtlsCertificates.MtlsCertificateCreateBody

  • namestring · minLength: 1 · maxLength: 120 · required

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

    Example: my_client_cert
  • certificatestring · minLength: 1 · required

    The PEM-encoded certificate

  • keystring · minLength: 1 · required

    The PEM-encoded private key

  • environmentsstring[] · minItems: 1 · required

    List of environments where the certificate should be enabled

    Enum values:
    development
    preview
    production

Zuplo.MtlsCertificates.MtlsCertificateListResponse

  • dataobject[] · required

    List of mTLS certificates

  • offsetinteger · int32 · required

    Offset for pagination

  • limitinteger · int32 · required

    Limit for pagination

Zuplo.MtlsCertificates.MtlsCertificateUpdateBody

  • environmentsstring[] · minItems: 1

    List of environments where the certificate should be enabled

    Enum values:
    development
    preview
    production

Zuplo.Projects.Project

  • namestring · required

    The name of the project

    Example: lime-fox
  • accountNamestring · required

    The name of the account this project belongs to

    Example: lime-fox

Zuplo.Projects.ProjectCreateBody

  • namestring · required

    The name of the project

    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

    A friendly name for the tunnel.

    Example: api-service-tunnel
  • tokenstring · readOnly · required

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

    Example: eyJhIjoiODJh[..]m89In0=

Zuplo.Tunnels.TunnelList

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

Zuplo.Tunnels.TunnelListItem

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

    A friendly name for the tunnel.

    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

    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
  • endpointstring · required

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

    Example: https://localhost:3000
  • configurationsobject[] · required

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

Zuplo.Tunnels.TunneledServicesConfiguration

  • versioninteger · uint8 · required

    The version of this configuration format.

    Example: 1
  • servicesobject[] · required

    A list of services that the tunnel will connect to.

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

    When the item was created.

    Example: 2023-04-18T05:54:34.408Z
  • updatedOnstring · date-time · readOnly · required

    When the item was last updated.

    Example: 2023-04-20T05:54:34.408Z
  • namestring · required

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

    Example: APP_ENVIRONMENT_KEY
  • isSecretboolean · required

    Whether the variable is a secret.

    Example: true
  • valuestring · required

    The value of the variable.

Zuplo.Variables.VariableCreateBody

  • namestring · required

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

    Example: APP_ENVIRONMENT_KEY
  • isSecretboolean · required

    Whether the variable is a secret.

    Example: true
  • valuestring · required

    The value of the variable.

Zuplo.Variables.VariableUpdateBody

  • valuestring

    The value of the variable.

Zuplo.WhoAmI.WhoAmI

  • accountstring · required
    Example: chocolate_blizzard_treat