The Zuplo Developer API, powered by Zuplo

Deployments

Endpoint:https://dev.zuplo.com

Gets a deployment status

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

Gets a deployment statuspath Parameters

  • accountNamestring · required
  • projectNamestring · required
  • statusIdstring · required

Gets a deployment statusResponses

    • 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 deploymentspath Parameters

  • accountNamestring · required
  • projectNamestring · required

Lists deploymentsResponses

    • dataobject[] · required

Upload deployment source

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

Upload deployment sourceRequest Body

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

Upload deployment sourceResponses

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

Get a deployment

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

Get a deploymentpath Parameters

  • deploymentNamestring · required

Get a deploymentResponses

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

Deletes a deployment

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

Deletes a deploymentpath Parameters

  • deploymentNamestring · required

Deletes a deploymentResponses

    No schema specified

Re-deploy a deployment

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

Re-deploy a deploymentpath Parameters

  • deploymentNamestring · required

Re-deploy a deploymentResponses

    • statusstring · required