Skip to main content
All CollectionsIntegrationsAPI
Provisioning API script
Provisioning API script
Updated over a week ago

We do not provide support on how to work with APIs or on third-party applications utilized to run the script.

Introduction

We have developed a basic script with the endpoints of our Provisioning API, to simplify working with this API. In this article, we explain how to use this script.

Prerequisites

To use this script, you need the following:

  1. Download Visual Studio Code (VSC)

  2. In VSC, click the Extension tab and install the REST Client

    • Password: BGDXGDans5dj?@@R

Instructions

  1. Open the ProvisioningAPI script in VSC

  2. Replace the placeholder instance URL and provisioning key variables with your own instance URL and provisioning key, this information should be known in your organization
    Do not include a "/" at the end of the instance URL

  3. OPTIONAL - if you want to use an API request containing the %environmentname% variable, replace this with the name of the environment

  4. With all variables filled in, click Send Request above the API call that you want to use

  5. OPTIONAL - if you are using the Export/Import API calls at the bottom of the script:

    1. Run the Export API call

    2. Copy the full output starting from the first { underneath the line saying "Content-Encoding: gzip"

    3. Paste the output back into the Provisioning API script​

Changelog

Version 1.0 (March, 2024)

  • Initial version of the script

Did this answer your question?