Zuplo
The Zuplo Developer API, powered by Zuplo

​Variables

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

Endpoint:https://developer-api-main-8600723.self.zuplo.com

​Creates a variable

POST
https://developer-api-main-8600723.self.zuplo.com
/v1/accounts/{accountName}/projects/{projectName}/branches/{branchName}/variables

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

​Creates a variable › 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.

​Creates a variable › Request Body

  • name
    string · required

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

  • isSecret
    boolean · required

    Whether the variable is a secret.

  • value
    string · required

    The value of the variable.

​Creates a variable › Responses

    • branch
      string · readOnly · required
    • createdOn
      string · date-time · readOnly · required

      When the item was created.

    • updatedOn
      string · date-time · readOnly · required

      When the item was last updated.

    • name
      string · required

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

    • isSecret
      boolean · required

      Whether the variable is a secret.

    • value
      string · required

      The value of the variable.

​Updates a variable

PATCH
https://developer-api-main-8600723.self.zuplo.com
/v1/accounts/{accountName}/projects/{projectName}/branches/{branchName}/variables/{variableName}

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

​Updates a variable › 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.

​Updates a variable › Request Body

  • value
    string

    The value of the variable.

​Updates a variable › Responses

    • branch
      string · readOnly · required
    • createdOn
      string · date-time · readOnly · required

      When the item was created.

    • updatedOn
      string · date-time · readOnly · required

      When the item was last updated.

    • name
      string · required

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

    • isSecret
      boolean · required

      Whether the variable is a secret.

    • value
      string · required

      The value of the variable.