The Zuplo Developer API, powered by Zuplo
Welcome to ZAPI - the Zuplo API where you can manage API keys, tunnels and more. To get your API key for this service login to portal.zuplo.com and navigate to your project Settings > Zuplo API Keys.
https://dev.zuplo.comAPI 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.
Lists buckets
Lists all buckets belonging to this account.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
1
Creates a bucket
Creates a new bucket for this account.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
Request Body
name
A friendly name for the bucket.
description
A description of the bucket.
tags
Key value pairs to associate with the bucket.
1
{
"name": "my-bucket",
"description": "Bucket for zuplo consumers",
"tags": {
"foo": "bar"
}
}Gets a bucket
Returns the details for a bucket, including the token used to connect to the bucket.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
1
Updates a bucket
Updates a bucket, and returns the updated value.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
Request Body
description
A description of the bucket.
tags
Key value pairs to associate with the bucket.
1
{
"description": "Bucket for zuplo consumers",
"tags": {
"foo": "bar"
}
}Deletes a bucket
Deletes a bucket and any related resources
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
1
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.
Lists consumers
Lists all consumers belonging to this account.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
limit
The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000
offset
The offset of the first item returned in the collection. Default: 0
include-api-keys
Include the api key data in the response.
include-manager-invites
Include the manager invites data in the response.
include-managers
Include the manager's data in the response.
key-format
The format of the key to return.
none: Key is completely hidden.
visible: Key is completely visible.
masked: Part of key suffix is visible.
Possible Enum Values
none
visible
masked
manager-email
Filter by email address of key manager.
tag
Query by tag. Example usage is tag.account=foo, where account is the name of the tag property and foo is the value.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
1
Creates a consumer
Creates a new consumer for this account.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
with-api-key
If an API key should be created with the consumer.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
Request Body
name
A friendly name for the consumer. This name is used as the default user.sub property in the API Key Authentication policy.
managersEmail addresses of the managers to invite or a list of managers (with subs) to add to the consumer.
description
A description of the consumer.
tags
Key value pairs to associate with the consumer.
metadata
Generic metadata associated with the consumer.
1
{
"name": "zup-inc",
"description": "Consumer for zup inc",
"tags": {
"foo": "bar"
},
"metadata": {
"id": "zup-id-343"
},
"managers": [
{
"email": "user@example.com",
"sub": "oauth2|113533232396018044159"
}
]
}Gets a consumer
Gets a consumer given a bucket name and consumer name.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
include-api-keys
Include the api key data in the response.
key-format
The format of the key to return.
none: Key is completely hidden.
visible: Key is completely visible.
masked: Part of key suffix is visible.
Possible Enum Values
none
visible
masked
include-managers
Include the manager's data in the response.
include-manager-invites
Include the manager invites data in the response.
tag
Query by tag. Example usage is tag.account=foo, where account is the name of the tag property and foo is the value.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerName
The name of the consumer.
1
Updates a consumer
Update the consumer with the matching consumer name.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
tag
Query by tag. Example usage is tag.account=foo, where account is the name of the tag property and foo is the value.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerName
The name of the consumer.
Request Body
description
A description of the consumer.
tags
Key value pairs to associate with the consumer.
metadata
Generic metadata associated with the consumer.
1
{
"description": "Consumer for zup inc",
"tags": {
"foo": "bar"
},
"metadata": {
"id": "zup-id-343"
}
}Deletes a consumer
Deletes a consumer and any related resources
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
tag
Query by tag. Example usage is tag.account=foo, where account is the name of the tag property and foo is the value.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerName
The name of the consumer.
1
Roll consumer keys
Set expiration for keys with no expiration date and creates a new key.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
tag
Query by tag. Example usage is tag.account=foo, where account is the name of the tag property and foo is the value.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerName
The name of the consumer.
Request Body
expiresOn
When the item will expire.
1
{
"expiresOn": "2050-04-18T05:54:34.408Z"
}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.
Lists keys
Lists all keys for this consumer.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
limit
The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000
offset
The offset of the first item returned in the collection. Default: 0
key-format
The format of the key to return.
none: Key is completely hidden.
visible: Key is completely visible.
masked: Part of key suffix is visible.
Possible Enum Values
none
visible
masked
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerName
The name of the consumer.
1
Creates an API key
Creates a new API key for this consumer. New API keys will automatically have API Key Leak Detection enabled.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerName
The name of the consumer.
Request Body
expiresOn
When the key expires.
description
The description of the api key.
key
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
1
{
"description": "My secret api key",
"expiresOn": "2023-04-20T05:54:34.408Z",
"key": "zpka_66b21c8591354c0997db232cc2f79c9e_69253f24"
}Creates multiple API keys
Creates multiple new API keys for this consumer.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerName
The name of the consumer.
Request Body
Unnamed Property
1
[
{
"description": "My secret api key",
"expiresOn": "2023-04-20T05:54:34.408Z",
"key": "zpka_66b21c8591354c0997db232cc2f79c9e_69253f24"
},
{
"description": "My secret api key2",
"expiresOn": "2023-05-20T05:54:34.408Z",
"key": "zpka_77b21c8591354c0997db232cc2f79c9e_69253f99"
}
]Gets an API key
Retrieves an API key for this consumer.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
key-format
The format of the key to return.
none: Key is completely hidden.
visible: Key is completely visible.
masked: Part of key suffix is visible.
Possible Enum Values
none
visible
masked
tag
Query by tag. Example usage is tag.account=foo, where account is the name of the tag property and foo is the value.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerName
The name of the consumer.
keyId
The key id.
1
Updates an API key
Updates an API key for this consumer.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
tag
Query by tag. Example usage is tag.account=foo, where account is the name of the tag property and foo is the value.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerName
The name of the consumer.
keyId
The key id.
Request Body
expiresOn
When the key expires.
description
The description of the api key.
key
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
1
{
"expiresOn": "2023-04-18T05:54:34.0Z",
"description": "eu in amet",
"key": "labore enim esse consequat"
}Deletes an API key
Deletes an API key for this consumer.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
tag
Query by tag. Example usage is tag.account=foo, where account is the name of the tag property and foo is the value.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerName
The name of the consumer.
keyId
The key id.
1
Variables
Set of operations available to create and update environment variables. You can learn more about environment variables here.
Creates a variable
Creates a new environment variable in a branch for a given project.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
projectName
The name of the project. You can find this in your Zuplo Portal under Settings > Project Information.
branchName
The name of the branch in your source control provider.
Request Body
name
The name of the variable. Must be named in SCREAMING_SNAKE_CASE.
isSecret
Whether the variable is a secret.
value
The value of the variable.
1
{
"name": "PORTAL_ID",
"isSecret": false,
"value": "89333"
}Updates a variable
Update the value of a variable in a branch for a given project.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
projectName
The name of the project. You can find this in your Zuplo Portal under Settings > Project Information.
branchName
The name of the branch in your source control provider.
variableName
The name of the environment variable.
Request Body
value
The value of the variable.
1
{
"value": "89333"
}Deployments
Set of operations available to handle deployments. You can learn more about deployments here.
Gets a deployment status
Gets the deployment status of your upload. Use the UUID of the uploaded sources as the statusId.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
projectName
The name of the project. You can find this in your Zuplo Portal under Settings > Project Information.
statusId
The UUID of the uploaded sources.
1
Lists deployments
Lists the deployments for the specified account and project.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
projectName
The name of the project. You can find this in your Zuplo Portal under Settings > Project Information.
1
Upload deployment source
Creates a URL for uploading sources.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Request Body
accountName
The name of the account
projectName
The name of the project
branchName
The name of the branch for deployment
1
{
"accountName": "my-account",
"projectName": "my-project",
"branchName": "main"
}Get a deployment
Gets the specified deployment.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
deploymentName
The name of the deployment. You can find this in the Zuplo Portal under Settings > Environments.
1
Deletes a deployment
Deletes the specified deployment.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
deploymentName
The name of the deployment. You can find this in the Zuplo Portal under Settings > Environments.
1
Re-deploy a deployment
Re-deploys the specified deployment so that it can pick up new environment variables or other configuration changes.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
deploymentName
The name of the deployment. You can find this in the Zuplo Portal under Settings > Environments.
1
Tunnels
List of endpoints available to perform operations on Tunnels.
Lists tunnels
Lists all tunnels belonging to this account.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
1
Creates a tunnel
Creates a new tunnel for this account.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
Request Body
name
A friendly name for the tunnel.
1
{
"tunnelId": "tnl_JcHFzTcJ9y4GU69lKBOaxFYU",
"name": "api-service-tunnel",
"token": "eyJhIjoiODJhNGM0ZTBlYWY3ZmU3YjQyMWRlZHU1ODhlNjg1ZGMiLCJ0IjoiNjY3ZWZhODktYzIyNS00NTIyLWI0M2EtYTgwYzY0OTgxMGY1IiwicyI6IkY5RGdVNnNNOTJWT245OUlUSWxMazVwY3lHV0ZLVG1jcHg2d0I5TkR4Vm89In0="
}Gets a tunnel
Returns the details for a tunnel, including the token used to connect to the tunnel.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
tunnelId
The ID of the tunnel.
1
Deletes a tunnel
Deletes a tunnel and any services that it has.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
tunnelId
The ID of the tunnel.
1
Rotates the token
Rotates the token used to connect to the tunnel.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
tunnelId
The ID of the tunnel.
1
Gets a teardown status
This endpoint returns the status of the deletion of the tunnel. Tearing down the tunnel is an asynchronous process so this endpoint allows you to poll the status.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
tunnelId
The ID of the tunnel.
operationId
The ID of the deletion operation.
1
Tunnel Services
List of endpoints available to manage services for a given tunnel.
Gets a provisioning status
This endpoint returns the status of the services that the tunnel is currently configured for. Provisioning the services is an asynchronous process so this endpoint allows you to poll the status.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
tunnelId
The ID of the tunnel.
operationId
The ID of the operation.
1
Gets a service configuration
This endpoint returns a snapshot of the services that the tunnel is currently configured for.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
tunnelId
The ID of the tunnel.
1
Configures tunnel services
This endpoint reads the request body and creates/updates/delete the services that the tunnel connects to.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
accountName
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
tunnelId
The ID of the tunnel.
Request Body
version
The version of this configuration format.
services
A list of services that the tunnel will connect to.
1
{
"version": 1,
"services": [
{
"name": "authservice",
"endpoint": "https://localhost:3000",
"configurations": []
},
{
"name": "authservice",
"endpoint": "https://localhost:3000",
"configurations": [
{
"project": "alpha-beta-gamma",
"accessibleBy": [
"preview",
"production"
]
},
{
"project": "alpha-beta-gamma",
"accessibleBy": [
"preview",
"production"
]
}
]
},
{
"name": "authservice",
"endpoint": "https://localhost:3000",
"configurations": [
{
"project": "alpha-beta-gamma",
"accessibleBy": [
"preview",
"production"
]
},
{
"project": "alpha-beta-gamma",
"accessibleBy": [
"preview",
"production"
]
}
]
},
{
"name": "authservice",
"endpoint": "https://localhost:3000",
"configurations": [
{
"project": "alpha-beta-gamma",
"accessibleBy": [
"preview",
"production"
]
},
{
"project": "alpha-beta-gamma",
"accessibleBy": [
"preview",
"production"
]
},
{
"project": "alpha-beta-gamma",
"accessibleBy": [
"preview",
"production"
]
},
{
"project": "alpha-beta-gamma",
"accessibleBy": [
"preview",
"production"
]
},
{
"project": "alpha-beta-gamma",
"accessibleBy": [
"preview",
"production"
]
}
]
},
{
"name": "authservice",
"endpoint": "https://localhost:3000",
"configurations": [
{
"project": "alpha-beta-gamma",
"accessibleBy": [
"preview",
"production"
]
}
]
}
]
}Metering - Buckets
Lists metering buckets
Lists all buckets belonging to this account.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
1
Creates a bucket
Creates a new bucket for this account.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
1
Gets a bucket
Returns the details for a bucket.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
bucketId
The id of the bucket. Zuplo automatically creates buckets for your project. You can find it in your Zuplo Portal under the Settings tab for your project.
1
Deletes a bucket
Deletes a bucket and any related resources
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
bucketId
The id of the bucket. Zuplo automatically creates buckets for your project. You can find it in your Zuplo Portal under the Settings tab for your project.
1
Metering - Plans
Lists plans
Lists all plans belonging to this bucket.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
bucketId
The id of the bucket. Zuplo automatically creates buckets for your project. You can find it in your Zuplo Portal under the Settings tab for your project.
1
Creates a plan
Creates a new plan for this bucket.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
bucketId
The id of the bucket. Zuplo automatically creates buckets for your project. You can find it in your Zuplo Portal under the Settings tab for your project.
Request Body
label
planExternalId
meters
trialDays
trialEndStatus
Possible Enum Values
paused
canceled
isTrialCollectPayment
1
{
"label": "Basic Subscription Plan",
"planExternalId": "prod_Pbyd5ARBWtFxkg",
"meters": {
"requests": {
"label": "Requests",
"max": 10
}
},
"trialDays": 10,
"isTrialCollectPayment": true
}Gets a plan
Returns the details for a plan.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
bucketId
The id of the bucket. Zuplo automatically creates buckets for your project. You can find it in your Zuplo Portal under the Settings tab for your project.
planId
The id of the plan.
1
Updates a plan
Update the details for a plan
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
bucketId
The id of the bucket. Zuplo automatically creates buckets for your project. You can find it in your Zuplo Portal under the Settings tab for your project.
planId
The id of the plan.
Request Body
label
planExternalId
meters
trialDays
trialEndStatus
Possible Enum Values
paused
canceled
isTrialCollectPayment
1
{}Deletes a plan
Deletes a plan (if there are no associated subscriptions)
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
bucketId
The id of the bucket. Zuplo automatically creates buckets for your project. You can find it in your Zuplo Portal under the Settings tab for your project.
planId
The id of the plan.
1
Metering - Subscriptions
Lists subscriptions
Lists all subscriptions belonging to this bucket.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
bucketId
The id of the bucket. Zuplo automatically creates buckets for your project. You can find it in your Zuplo Portal under the Settings tab for your project.
1
Creates a subscription
Creates a new subscription for this bucket.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
bucketId
The id of the bucket. Zuplo automatically creates buckets for your project. You can find it in your Zuplo Portal under the Settings tab for your project.
Request Body
planIds
planExternalIds
quotaResetAnchor
status
Possible Enum Values
active
inactive
incomplete
incomplete-expired
trialing
past-due
canceled
type
Possible Enum Values
periodic
renewalStrategy
Possible Enum Values
monthly
yearly
region
Possible Enum Values
us-central1
us-east1
europe-west4
customerKey
subscriptionExternalId
customerExternalId
metadata
trialEndStatus
trialEndDate
trialStartDate
1
{
"planIds": [
"plan_ZLbXn7SCZt6KJnD6SU8Ljv8w"
],
"planExternalIds": [
"prod_Pbyd5ARBWtFxkg"
],
"quotaResetAnchor": "1908-07-15T03:11:15.0Z",
"status": "paused",
"type": "periodic",
"renewalStrategy": "yearly",
"region": "us-central1",
"customerKey": "d8984b34-defd-458c-bf34-7fb1b69ce714",
"subscriptionExternalId": "sub_1OmlUlLQav6G4UBHsPy2BY7J",
"customerExternalId": "cus_PbzTcoZtPtelYg"
}Gets a subscription
Returns the details for a subscription.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
bucketId
The id of the bucket. Zuplo automatically creates buckets for your project. You can find it in your Zuplo Portal under the Settings tab for your project.
subscriptionId
The id of the subscription.
1
Updates a subscription
Updates the subscription for this bucket.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
bucketId
The id of the bucket. Zuplo automatically creates buckets for your project. You can find it in your Zuplo Portal under the Settings tab for your project.
subscriptionId
The id of the subscription.
Request Body
planExternalIds
status
Possible Enum Values
active
inactive
incomplete
incomplete-expired
trialing
past-due
canceled
prorate
metadata
trialEndDate
1
{
"planExternalIds": [
"prod_Pbyd5ARBWtFxkg"
],
"prorate": 0.75,
"trialEndDate": "1953-03-19T01:52:22.0Z"
}Deletes a subscription
Deletes a subscription and any related resources
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
bucketId
The id of the bucket. Zuplo automatically creates buckets for your project. You can find it in your Zuplo Portal under the Settings tab for your project.
subscriptionId
The id of the subscription.
1
Metering - Quotas
Get quotas
Get the quotas for this subscription
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
bucketId
The id of the bucket. Zuplo automatically creates buckets for your project. You can find it in your Zuplo Portal under the Settings tab for your project.
subscriptionId
The id of the subscription.
1
OpenAPI Specification
Returns the OpenAPI V3 spec for Zuplo's Developer API
1
Who Am I
Returns basic information about the caller (using the api key)
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
1