Zuplo
The Zuplo Developer API, powered by Zuplo

​Deployments

Endpoint:https://dev.zuplo.com

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.

​Gets a deployment status › path Parameters

  • accountNamestring · required

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

  • projectNamestring · required

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

  • statusIdstring · required

    The UUID of the uploaded sources.

​Gets a deployment status › Responses

    • 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

​Lists deployments

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

Lists the deployments for the specified account and project.

​Lists deployments › path Parameters

  • accountNamestring · required

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

  • projectNamestring · required

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

​Lists deployments › Responses

    • dataobject[] · required

​Upload deployment source

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

Creates a URL for uploading sources.

​Upload deployment source › Request Body

  • 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

​Upload deployment source › Responses

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

​Get a deployment

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

Gets the specified deployment.

​Get a deployment › path Parameters

  • deploymentNamestring · required

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

​Get a deployment › Responses

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

​Deletes a deployment

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

Deletes the specified deployment.

​Deletes a deployment › path Parameters

  • deploymentNamestring · required

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

​Deletes a deployment › Responses

    No schema 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.

​Re-deploy a deployment › path Parameters

  • deploymentNamestring · required

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

​Re-deploy a deployment › Responses

    • statusstring · required
TunnelsVariables