Skip to content

Custom Deployment tokens

To perform a Custom Deployment with VIP-CLI or a continuous integration process, a unique token must be generated and the token’s value must be assigned to the WPVIP_DEPLOY_TOKEN environment variable on the target environment.

Limitations

  • A Custom Deployment token expires 1 year after it is generated.
  • A token will become invalid if it is not used for 90 consecutive days.

Access

Prerequisite

To access, generate or delete tokens in the VIP Dashboard for Custom Deployment, a user must have at minimum an Org admin role or an App admin role for that application.

Tokens can only be generated and retrieved at a time when Custom Deployment is enabled for an environment.

  1. Navigate to the VIP Dashboard for an application.
  2. Select an environment from the dropdown located at the upper left of the dashboard. Tokens for Custom Deployment are environment-specific. Select the environment that will be the target of Custom Deployment.
  3. Select “Code” from the sidebar navigation at the left of the screen.
  4. Select “Repository Management” from the navigation submenu.

List of generated tokens

A list of Custom Deployment tokens that have been generated for an environment can be reviewed and managed in a table in the lower portion of the “Repository Management” panel.

Information related to each token is displayed across five columns.

  • Token ID: Numerical identifier for the token.
  • Expiry: The date and time of the token’s expiration.
  • Last Used: The date and time of the most recent use of the for a Custom Deployment.
  • Issuer: First and last name values of the user who generated the token.
  • Action: A button labeled “Delete” can be selected to delete the token.

Generate a token

Generate a token for Custom Deployment and retrieve its value. A token’s value is only made available in the last step of the generation process, and cannot be retrieved at any other time in any other way.

  1. Navigate to the VIP Dashboard for an application.
  2. Select an environment from the environment dropdown located at the upper left of the VIP Dashboard.
  3. Select “Code” from the sidebar navigation at the left of the screen.
  4. Select “Repository Management” from the navigation submenu.
  5. Select the button labeled “Generate Token“.
  6. Select the button labeled “Copy” to add the value of the token to the clipboard of the user’s local machine.

The value of the token should be stored in a secure location (e.g. a password manager application). A new token can be generated if an existing token’s value is lost or if a token has expired.

Last updated: September 29, 2025

Relevant to

  • WordPress