Zuplo DocsZuplo Docs
Overview

​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.

API Keys

Endpoint:https://dev.zuplo.com
Deployments

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

​Gets a deployment status

GET
https://dev.zuplo.com
/v1/accounts/{accountName}/projects/{projectName}/deployment-status/{statusId}

Gets the deployment status of your upload. Use the UUID of the uploaded sources as the statusId.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • projectName
    string
    required

    The name of the project. You can find this in your Zuplo Portal under Settings > Project Information.

  • statusId
    string
    required

    The UUID of the uploaded sources.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • status
      string
    • url
      string
    • steps
      object
    • buildResult
      object

​Lists deployments

GET
https://dev.zuplo.com
/v1/accounts/{accountName}/projects/{projectName}/deployments

Lists the deployments for the specified account and project.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • projectName
    string
    required

    The name of the project. You can find this in your Zuplo Portal under Settings > Project Information.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • data
      object[]

​Upload deployment source

POST
https://dev.zuplo.com
/v1/deployments/sources

Creates a URL for uploading sources.

​Headers

  • Authorization
    string
    required

    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
    string

    The name of the account

  • projectName
    string

    The name of the project

  • branchName
    string

    The name of the branch for deployment

​Responses

    • uploadUrl
      string

​Get a deployment

GET
https://dev.zuplo.com
/v1/deployments/{deploymentName}

Gets the specified deployment.

​path Parameters

  • deploymentName
    string
    required

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

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • name
      string

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

    • url
      string
    • label
      string
    • urlParameter
      string
    • createdOn
      string
    • updatedOn
      string
    • loggingId
      string
    • accountName
      string
    • projectName
      string
    • state
      string
    • message
      string
    • branchName
      string
    • environmentType
      string

​Deletes a deployment

DELETE
https://dev.zuplo.com
/v1/deployments/{deploymentName}

Deletes the specified deployment.

​path Parameters

  • deploymentName
    string
    required

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

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    No response specified

​Re-deploy a deployment

POST
https://dev.zuplo.com
/v1/deployments/{deploymentName}/deploy

Re-deploys the specified deployment so that it can pick up new environment variables or other configuration changes.

​path Parameters

  • deploymentName
    string
    required

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

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • status
      string
Tunnels

List of endpoints available to perform operations on Tunnels.

​Lists tunnels

GET
https://dev.zuplo.com
/v1/accounts/{accountName}/tunnels

Lists all tunnels belonging to this account.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • data
      object[]
    • limit
      integer
      optional
    • offset
      integer
      optional
    • total
      integer
      optional

​Creates a tunnel

POST
https://dev.zuplo.com
/v1/accounts/{accountName}/tunnels

Creates a new tunnel for this account.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

​Headers

  • Authorization
    string
    required

    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

  • id
    string
  • name
    string

    A friendly name for the tunnel.

  • token
    string

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

​Responses

    • id
      string
    • name
      string

      A friendly name for the tunnel.

    • token
      string

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

​Gets a tunnel

GET
https://dev.zuplo.com
/v1/accounts/{accountName}/tunnels/{tunnelId}

Returns the details for a tunnel, including the token used to connect to the tunnel.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • tunnelId
    string
    required

    The ID of the tunnel.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • id
      string
    • name
      string

      A friendly name for the tunnel.

    • token
      string

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

​Deletes a tunnel

DELETE
https://dev.zuplo.com
/v1/accounts/{accountName}/tunnels/{tunnelId}

Deletes a tunnel and any services that it has.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • tunnelId
    string
    required

    The ID of the tunnel.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • id
      string
    • status
      string
    • message
      string
      optional
    • details
      string
      optional

​Rotates the token

POST
https://dev.zuplo.com
/v1/accounts/{accountName}/tunnels/{tunnelId}/$rotate-token

Rotates the token used to connect to the tunnel.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • tunnelId
    string
    required

    The ID of the tunnel.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • id
      string
    • name
      string

      A friendly name for the tunnel.

    • token
      string

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

​Gets a teardown status

GET
https://dev.zuplo.com
/v1/accounts/{accountName}/tunnels/{tunnelId}/teardown-operations/{operationId}

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.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • tunnelId
    string
    required

    The ID of the tunnel.

  • operationId
    string
    required

    The ID of the deletion operation.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • id
      string
    • status
      string
    • message
      string
      optional
    • details
      string
      optional
Tunnel Services

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

​Gets a provisioning status

GET
https://dev.zuplo.com
/v1/accounts/{accountName}/tunnels/{tunnelId}/provisioning-operations/{operationId}

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.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • tunnelId
    string
    required

    The ID of the tunnel.

  • operationId
    string
    required

    The ID of the operation.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • id
      string
    • status
      string
    • message
      string
      optional
    • details
      string
      optional

​Gets a service configuration

GET
https://dev.zuplo.com
/v1/accounts/{accountName}/tunnels/{tunnelId}/services-configuration

This endpoint returns a snapshot of the services that the tunnel is currently configured for.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • tunnelId
    string
    required

    The ID of the tunnel.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • version
      integer

      The version of this configuration format.

    • services
      object[]

      A list of services that the tunnel will connect to.

​Configures tunnel services

PUT
https://dev.zuplo.com
/v1/accounts/{accountName}/tunnels/{tunnelId}/services-configuration

This endpoint reads the request body and creates/updates/delete the services that the tunnel connects to.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • tunnelId
    string
    required

    The ID of the tunnel.

​Headers

  • Authorization
    string
    required

    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

  • version
    integer

    The version of this configuration format.

  • services
    object[]

    A list of services that the tunnel will connect to.

​Responses

    • id
      string
    • status
      string
    • message
      string
      optional
    • details
      string
      optional
Variables

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

​Creates a variable

POST
https://dev.zuplo.com
/v1/accounts/{accountName}/projects/{projectName}/branches/{branchName}/variables

Creates a new environment variable in a branch for a given project.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • projectName
    string
    required

    The name of the project. You can find this in your Zuplo Portal under Settings > Project Information.

  • branchName
    string
    required

    The name of the branch in your source control provider.

​Headers

  • Authorization
    string
    required

    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

  • name
    string

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

  • isSecret
    boolean

    Whether the variable is a secret.

  • value
    string

    The value of the variable.

​Responses

    • branch
      string
    • createdOn
      string

      When the item was created.

    • updatedOn
      string

      When the item was last updated.

    • name
      string

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

    • isSecret
      boolean

      Whether the variable is a secret.

    • value
      string

      The value of the variable.

​Updates a variable

PATCH
https://dev.zuplo.com
/v1/accounts/{accountName}/projects/{projectName}/branches/{branchName}/variables/{variableName}

Update the value of a variable in a branch for a given project.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • projectName
    string
    required

    The name of the project. You can find this in your Zuplo Portal under Settings > Project Information.

  • branchName
    string
    required

    The name of the branch in your source control provider.

  • variableName
    string
    required

    The name of the environment variable.

​Headers

  • Authorization
    string
    required

    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

  • value
    string
    optional

    The value of the variable.

​Responses

    • branch
      string
    • createdOn
      string

      When the item was created.

    • updatedOn
      string

      When the item was last updated.

    • name
      string

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

    • isSecret
      boolean

      Whether the variable is a secret.

    • value
      string

      The value of the variable.

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.

​Lists buckets

GET
https://dev.zuplo.com
/v1/accounts/{accountName}/key-buckets

Lists all buckets belonging to this account.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • data
      object[]
    • limit
      integer
      optional
    • offset
      integer
      optional
    • total
      integer
      optional

​Creates a bucket

POST
https://dev.zuplo.com
/v1/accounts/{accountName}/key-buckets

Creates a new bucket for this account.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

​Headers

  • Authorization
    string
    required

    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

  • name
    string

    A friendly name for the bucket.

  • description
    string
    optional

    A description of the bucket.

  • tags
    object
    optional

    Key value pairs to associate with the bucket.

​Responses

    • createdOn
      string

      When the item was created.

    • updatedOn
      string

      When the item was last updated.

    • id
      string
    • name
      string

      A friendly name for the bucket.

    • isRetrievable
      boolean
      optional

      Whether the API keys stored in the bucket are retrievable

    • description
      string
      optional

      A description of the bucket.

    • tags
      object
      optional

      Key value pairs to associate with the bucket.

​Gets a bucket

GET
https://dev.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}

Returns the details for a bucket, including the token used to connect to the bucket.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • bucketName
    string
    required

    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.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • createdOn
      string

      When the item was created.

    • updatedOn
      string

      When the item was last updated.

    • id
      string
    • name
      string

      A friendly name for the bucket.

    • isRetrievable
      boolean
      optional

      Whether the API keys stored in the bucket are retrievable

    • description
      string
      optional

      A description of the bucket.

    • tags
      object
      optional

      Key value pairs to associate with the bucket.

​Deletes a bucket

DELETE
https://dev.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}

Deletes a bucket and any related resources

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • bucketName
    string
    required

    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.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    No response specified

​Updates a bucket

PATCH
https://dev.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}

Updates a bucket, and returns the updated value.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • bucketName
    string
    required

    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.

​Headers

  • Authorization
    string
    required

    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

  • description
    string
    optional

    A description of the bucket.

  • tags
    object
    optional

    Key value pairs to associate with the bucket.

​Responses

    • createdOn
      string

      When the item was created.

    • updatedOn
      string

      When the item was last updated.

    • id
      string
    • name
      string

      A friendly name for the bucket.

    • isRetrievable
      boolean
      optional

      Whether the API keys stored in the bucket are retrievable

    • description
      string
      optional

      A description of the bucket.

    • tags
      object
      optional

      Key value pairs to associate with the bucket.

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

GET
https://dev.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers

Lists all consumers belonging to this account.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • bucketName
    string
    required

    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.

​query Parameters

  • limit
    integer
    required

    The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000

  • offset
    integer
    required

    The offset of the first item returned in the collection. Default: 0

  • include-api-keys
    boolean

    Include the api key data in the response.

  • include-manager-invites
    boolean

    Include the manager invites data in the response.

  • include-managers
    boolean

    Include the manager's data in the response.

  • key-format
    string

    The format of the key to return. none: Key is completely hidden. visible: Key is completely visible. masked: Part of key suffix is visible.

  • manager-email
    string

    Filter by email address of key manager.

  • tag
    string

    Query by tag. Example usage is tag.account=foo, where account is the name of the tag property and foo is the value.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • data
      object[]
    • limit
      integer
      optional
    • offset
      integer
      optional
    • total
      integer
      optional

​Creates a consumer

POST
https://dev.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers

Creates a new consumer for this account.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • bucketName
    string
    required

    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.

​query Parameters

  • with-api-key
    boolean

    If an API key should be created with the consumer.

​Headers

  • Authorization
    string
    required

    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

  • name
    string

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

  • managers
    optional

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

  • description
    string
    optional

    A description of the consumer.

  • tags
    object
    optional

    Key value pairs to associate with the consumer.

  • metadata
    object
    optional

    Generic metadata associated with the consumer.

​Responses

    • createdOn
      string

      When the item was created.

    • updatedOn
      string

      When the item was last updated.

    • id
      string
    • name
      string

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

    • description
      string
      optional

      A description of the consumer.

    • tags
      object
      optional

      Key value pairs to associate with the consumer.

    • metadata
      object
      optional

      Generic metadata associated with the consumer.

​Gets a consumer

GET
https://dev.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}

Gets a consumer given a bucket name and consumer name.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • bucketName
    string
    required

    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
    string
    required

    The name of the consumer.

​query Parameters

  • include-api-keys
    boolean

    Include the api key data in the response.

  • key-format
    string

    The format of the key to return. none: Key is completely hidden. visible: Key is completely visible. masked: Part of key suffix is visible.

  • include-managers
    boolean

    Include the manager's data in the response.

  • include-manager-invites
    boolean

    Include the manager invites data in the response.

  • tag
    string

    Query by tag. Example usage is tag.account=foo, where account is the name of the tag property and foo is the value.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • createdOn
      string

      When the item was created.

    • updatedOn
      string

      When the item was last updated.

    • id
      string
    • name
      string

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

    • description
      string
      optional

      A description of the consumer.

    • tags
      object
      optional

      Key value pairs to associate with the consumer.

    • metadata
      object
      optional

      Generic metadata associated with the consumer.

​Deletes a consumer

DELETE
https://dev.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}

Deletes a consumer and any related resources

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • bucketName
    string
    required

    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
    string
    required

    The name of the consumer.

​query Parameters

  • tag
    string

    Query by tag. Example usage is tag.account=foo, where account is the name of the tag property and foo is the value.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    No response specified

​Updates a consumer

PATCH
https://dev.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}

Update the consumer with the matching consumer name.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • bucketName
    string
    required

    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
    string
    required

    The name of the consumer.

​query Parameters

  • tag
    string

    Query by tag. Example usage is tag.account=foo, where account is the name of the tag property and foo is the value.

​Headers

  • Authorization
    string
    required

    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

  • description
    string
    optional

    A description of the consumer.

  • tags
    object
    optional

    Key value pairs to associate with the consumer.

  • metadata
    object
    optional

    Generic metadata associated with the consumer.

​Responses

    • createdOn
      string

      When the item was created.

    • updatedOn
      string

      When the item was last updated.

    • id
      string
    • name
      string

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

    • description
      string
      optional

      A description of the consumer.

    • tags
      object
      optional

      Key value pairs to associate with the consumer.

    • metadata
      object
      optional

      Generic metadata associated with the consumer.

​Roll consumer keys

POST
https://dev.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/roll-key

Set expiration for keys with no expiration date and creates a new key.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • bucketName
    string
    required

    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
    string
    required

    The name of the consumer.

​query Parameters

  • tag
    string

    Query by tag. Example usage is tag.account=foo, where account is the name of the tag property and foo is the value.

​Headers

  • Authorization
    string
    required

    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

  • expiresOn
    string

    When the item will expire.

​Responses

    No response specified
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

GET
https://dev.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/keys

Lists all keys for this consumer.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • bucketName
    string
    required

    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
    string
    required

    The name of the consumer.

​query Parameters

  • limit
    integer
    required

    The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000

  • offset
    integer
    required

    The offset of the first item returned in the collection. Default: 0

  • key-format
    string

    The format of the key to return. none: Key is completely hidden. visible: Key is completely visible. masked: Part of key suffix is visible.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • data
      object[]
    • limit
      integer
      optional
    • offset
      integer
      optional
    • total
      integer
      optional

​Creates an API key

POST
https://dev.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/keys

Creates a new API key for this consumer. New API keys will automatically have API Key Leak Detection enabled.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • bucketName
    string
    required

    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
    string
    required

    The name of the consumer.

​Headers

  • Authorization
    string
    required

    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

  • expiresOn
    string
    optional

    When the key expires.

  • description
    string
    optional

    The description of the api key.

  • key
    string
    optional

    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

​Responses

    • createdOn
      string

      When the item was created.

    • updatedOn
      string

      When the item was last updated.

    • id
      string
    • expiresOn
      string
      optional

      When the key expires.

    • description
      string
      optional

      The description of the api key.

    • key
      string
      optional

      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

​Creates multiple API keys

POST
https://dev.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/keys/$bulk

Creates multiple new API keys for this consumer.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • bucketName
    string
    required

    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
    string
    required

    The name of the consumer.

​Headers

  • Authorization
    string
    required

    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

object[]
  • expiresOn
    string
    optional

    When the key expires.

  • description
    string
    optional

    The description of the api key.

  • key
    string
    optional

    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

​Responses

    • data
      object[]
    • limit
      integer
      optional
    • offset
      integer
      optional
    • total
      integer
      optional

​Gets an API key

GET
https://dev.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/keys/{keyId}

Retrieves an API key for this consumer.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • bucketName
    string
    required

    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
    string
    required

    The name of the consumer.

  • keyId
    string
    required

    The key id.

​query Parameters

  • key-format
    string

    The format of the key to return. none: Key is completely hidden. visible: Key is completely visible. masked: Part of key suffix is visible.

  • tag
    string

    Query by tag. Example usage is tag.account=foo, where account is the name of the tag property and foo is the value.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • createdOn
      string

      When the item was created.

    • updatedOn
      string

      When the item was last updated.

    • id
      string
    • expiresOn
      string
      optional

      When the key expires.

    • description
      string
      optional

      The description of the api key.

    • key
      string
      optional

      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

​Deletes an API key

DELETE
https://dev.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/keys/{keyId}

Deletes an API key for this consumer.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • bucketName
    string
    required

    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
    string
    required

    The name of the consumer.

  • keyId
    string
    required

    The key id.

​query Parameters

  • tag
    string

    Query by tag. Example usage is tag.account=foo, where account is the name of the tag property and foo is the value.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    No response specified

​Updates an API key

PATCH
https://dev.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/keys/{keyId}

Updates an API key for this consumer.

​path Parameters

  • accountName
    string
    required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • bucketName
    string
    required

    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
    string
    required

    The name of the consumer.

  • keyId
    string
    required

    The key id.

​query Parameters

  • tag
    string

    Query by tag. Example usage is tag.account=foo, where account is the name of the tag property and foo is the value.

​Headers

  • Authorization
    string
    required

    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

  • expiresOn
    string
    optional

    When the key expires.

  • description
    string
    optional

    The description of the api key.

  • key
    string
    optional

    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

​Responses

    • createdOn
      string

      When the item was created.

    • updatedOn
      string

      When the item was last updated.

    • id
      string
    • expiresOn
      string
      optional

      When the key expires.

    • description
      string
      optional

      The description of the api key.

    • key
      string
      optional

      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

Metering - Buckets

​Lists metering buckets

GET
https://dev.zuplo.com
/v1/metering

Lists all buckets belonging to this account.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • data
      object[]
    • limit
      integer
      optional
    • offset
      integer
      optional
    • total
      integer
      optional

​Creates a bucket

POST
https://dev.zuplo.com
/v1/metering

Creates a new bucket for this account.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • createdOn
      string

      When the item was created.

    • updatedOn
      string

      When the item was last updated.

    • id
      string

​Gets a bucket

GET
https://dev.zuplo.com
/v1/metering/{bucketId}

Returns the details for a bucket.

​path Parameters

  • bucketId
    string
    required

    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.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • createdOn
      string

      When the item was created.

    • updatedOn
      string

      When the item was last updated.

    • id
      string

​Deletes a bucket

DELETE
https://dev.zuplo.com
/v1/metering/{bucketId}

Deletes a bucket and any related resources

​path Parameters

  • bucketId
    string
    required

    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.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    No response specified
Metering - Plans

​Lists plans

GET
https://dev.zuplo.com
/v1/metering/{bucketId}/plans

Lists all plans belonging to this bucket.

​path Parameters

  • bucketId
    string
    required

    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.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • data
      object[]
    • limit
      integer
      optional
    • offset
      integer
      optional
    • total
      integer
      optional

​Creates a plan

POST
https://dev.zuplo.com
/v1/metering/{bucketId}/plans

Creates a new plan for this bucket.

​path Parameters

  • bucketId
    string
    required

    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.

​Headers

  • Authorization
    string
    required

    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

  • label
    string
  • planExternalId
    string
  • meters
    object
  • trialDays
    integer
    optional
  • trialEndStatus
    string
    optional
  • isTrialCollectPayment
    boolean
    optional

​Responses

    • createdOn
      string

      When the item was created.

    • updatedOn
      string

      When the item was last updated.

    • id
      string
    • hasSubscriptions
      boolean
    • label
      string
    • planExternalId
      string
    • meters
      object
    • trialDays
      integer
      optional
    • trialEndStatus
      string
      optional
    • isTrialCollectPayment
      boolean
      optional

​Gets a plan

GET
https://dev.zuplo.com
/v1/metering/{bucketId}/plans/{planId}

Returns the details for a plan.

​path Parameters

  • bucketId
    string
    required

    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
    string
    required

    The id of the plan.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • createdOn
      string

      When the item was created.

    • updatedOn
      string

      When the item was last updated.

    • id
      string
    • hasSubscriptions
      boolean
    • label
      string
    • planExternalId
      string
    • meters
      object
    • trialDays
      integer
      optional
    • trialEndStatus
      string
      optional
    • isTrialCollectPayment
      boolean
      optional

​Deletes a plan

DELETE
https://dev.zuplo.com
/v1/metering/{bucketId}/plans/{planId}

Deletes a plan (if there are no associated subscriptions)

​path Parameters

  • bucketId
    string
    required

    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
    string
    required

    The id of the plan.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    No response specified

​Updates a plan

PATCH
https://dev.zuplo.com
/v1/metering/{bucketId}/plans/{planId}

Update the details for a plan

​path Parameters

  • bucketId
    string
    required

    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
    string
    required

    The id of the plan.

​Headers

  • Authorization
    string
    required

    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

  • label
    string
    optional
  • planExternalId
    string
    optional
  • meters
    object
    optional
  • trialDays
    integer
    optional
  • trialEndStatus
    string
    optional
  • isTrialCollectPayment
    boolean
    optional

​Responses

    • createdOn
      string

      When the item was created.

    • updatedOn
      string

      When the item was last updated.

    • id
      string
    • hasSubscriptions
      boolean
    • label
      string
    • planExternalId
      string
    • meters
      object
    • trialDays
      integer
      optional
    • trialEndStatus
      string
      optional
    • isTrialCollectPayment
      boolean
      optional
Metering - Subscriptions

​Lists subscriptions

GET
https://dev.zuplo.com
/v1/metering/{bucketId}/subscriptions

Lists all subscriptions belonging to this bucket.

​path Parameters

  • bucketId
    string
    required

    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.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • data
      object[]
    • limit
      integer
      optional
    • offset
      integer
      optional
    • total
      integer
      optional

​Creates a subscription

POST
https://dev.zuplo.com
/v1/metering/{bucketId}/subscriptions

Creates a new subscription for this bucket.

​path Parameters

  • bucketId
    string
    required

    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.

​Headers

  • Authorization
    string
    required

    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

  • planIds
    string[]
  • planExternalIds
    string[]
  • status
    string
  • type
    string
  • renewalStrategy
    string
  • region
    string
  • customerKey
    string
  • subscriptionExternalId
    string
  • customerExternalId
    string
  • quotaResetAnchor
    string
    optional
  • metadata
    object
    optional
  • trialEndStatus
    string
    optional
  • trialEndDate
    string
    optional
  • trialStartDate
    string
    optional

​Responses

    • createdOn
      string

      When the item was created.

    • updatedOn
      string

      When the item was last updated.

    • id
      string
    • planIds
      string[]
    • planExternalIds
      string[]
    • status
      string
    • type
      string
    • renewalStrategy
      string
    • region
      string
    • customerKey
      string
    • subscriptionExternalId
      string
    • customerExternalId
      string
    • quotaResetAnchor
      string
      optional
    • metadata
      object
      optional
    • trialEndStatus
      string
      optional
    • trialEndDate
      string
      optional
    • trialStartDate
      string
      optional

​Gets a subscription

GET
https://dev.zuplo.com
/v1/metering/{bucketId}/subscriptions/{subscriptionId}

Returns the details for a subscription.

​path Parameters

  • bucketId
    string
    required

    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
    string
    required

    The id of the subscription.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • createdOn
      string

      When the item was created.

    • updatedOn
      string

      When the item was last updated.

    • id
      string
    • planIds
      string[]
    • planExternalIds
      string[]
    • status
      string
    • type
      string
    • renewalStrategy
      string
    • region
      string
    • customerKey
      string
    • subscriptionExternalId
      string
    • customerExternalId
      string
    • quotaResetAnchor
      string
      optional
    • metadata
      object
      optional
    • trialEndStatus
      string
      optional
    • trialEndDate
      string
      optional
    • trialStartDate
      string
      optional

​Deletes a subscription

DELETE
https://dev.zuplo.com
/v1/metering/{bucketId}/subscriptions/{subscriptionId}

Deletes a subscription and any related resources

​path Parameters

  • bucketId
    string
    required

    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
    string
    required

    The id of the subscription.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    No response specified

​Updates a subscription

PATCH
https://dev.zuplo.com
/v1/metering/{bucketId}/subscriptions/{subscriptionId}

Updates the subscription for this bucket.

​path Parameters

  • bucketId
    string
    required

    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
    string
    required

    The id of the subscription.

​Headers

  • Authorization
    string
    required

    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

  • planExternalIds
    string[]
    optional
  • status
    string
    optional
  • prorate
    number
    optional
  • metadata
    object
    optional
  • trialEndDate
    string
    optional

​Responses

    • createdOn
      string

      When the item was created.

    • updatedOn
      string

      When the item was last updated.

    • id
      string
    • planIds
      string[]
    • planExternalIds
      string[]
    • status
      string
    • type
      string
    • renewalStrategy
      string
    • region
      string
    • customerKey
      string
    • subscriptionExternalId
      string
    • customerExternalId
      string
    • quotaResetAnchor
      string
      optional
    • metadata
      object
      optional
    • trialEndStatus
      string
      optional
    • trialEndDate
      string
      optional
    • trialStartDate
      string
      optional
Metering - Quotas

​Get quotas

GET
https://dev.zuplo.com
/v1/metering/{bucketId}/subscriptions/{subscriptionId}/quotas

Get the quotas for this subscription

​path Parameters

  • bucketId
    string
    required

    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
    string
    required

    The id of the subscription.

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    object

​OpenAPI Specification

GET
https://dev.zuplo.com
/openapi

Returns the OpenAPI V3 spec for Zuplo's Developer API

​Responses

    object

​Who Am I

GET
https://dev.zuplo.com
/v1/who-am-i

Returns basic information about the caller (using the api key)

​Headers

  • Authorization
    string
    required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

​Responses

    • account
      string