To access the ZCSPM API, it is required to have valid API access key, ZCSPM API Application ID and secret to generate the authorization token.

STEP 1: Create ZCSPM API Application

Creating a ZCSPM API application includes configuring access to the ZCSPM API for selected accounts. The following procedure must be completed by a License Admin.

1. Log in to the ZCSPM portal.
2. Select the applicable License, for which ZCSPM API application is to be created.
3. Navigate to Configuration, then select ZCSPM API Access.
4. Click Create API Application.

5. Enter an API Application Name
6. For Select APIs to Connect, choose the ZCSPM APIs you need the application to connect to.
7. For Select APIs Scope, move the applicable accounts from the Excluded Cloud Accounts section to the Included Cloud Accounts section for API application scope
8. From the Token Expiry drop-down menu, select the expiry duration for the API token. For example, you can set the token to expire after 60 minutes.
9. For Secret Expiry, enter an expiration date (i.e., dd/mm/yyyy) or select an expiration date from the calendar menu for the API application secret.
10. Click Save.

11. After saving, a window will appear with the ZCSPM API Application Secret ID.
    1. Click the Copy icon to copy the ID, then paste it into a text editor to save it.
    2. Click Done.

You will not be able to retrieve the Application Secret after leaving this window. However, you can regenerate the secret, if necessary.

After creating the API application, be sure to record the ZCSPM API Application Id.

STEP 2: Generate ZCSPM API key

Sign Up on the ZCSPM API Portal

1. Go to the ZCSPM API portal and click Sign up.
2. Fill the required fields in the sign up form.
3. You will receive a confirmation email to complete the sign up process, click on the confirmation link.

The confirmation email will ask you to change your password. However, you can reuse the same password given when you signed up.

Activate API Key

Retrieve and activate your API key using the ZCSPM API portal.

1. Click on PRODUCTS, then select Unlimited.

3. Click Subscribe.

This will notify ZCSPM to activate your API subscription access. You must wait for activation to complete. When ZCSPM activates your subscription, you will receive an email notification.

Retrieve ZCSPM API Key

After you receive the confirmation email:

1. Click on your username, then select Profile.
2. Under Your subscriptions, for Primary key, click Show.

Be sure to copy the Primary key. You will need this information in order to acquire an access token.

STEP 3: Acquire an Access Token

Do not store access tokens in local storage.

License Token

POST https://<ZCSPM API DOMAIN>/authorize/license/<LICENSE ID>/token

URI Parameters

Header

Request Body

{
    "APIApplicationId": "<API Application Id>", 
    "Secret": "<API Application Secret>"
}

Responses

Account Token

POST https://<ZCSPM API DOMAIN>/authorize/license/<LICENSE ID>/token?accountId=<ACCOUNT ID>

URI Parameters

Header

Request Body

{
    APIApplicationId:<API Application Id>,
    Secret:<API Application Secret>
}

Responses

Appendix

Regenerate API Secret

1. Log in to the ZCSPM portal.
2. Select the applicable License.
3. Navigate to Configuration, then select ZCSPM API Access.
4. From the Configure App drop-down menu, select Regenerate Secret Key.
5. In the confirmation window that appears, click Continue.
6. After regenerating the key, a window will appear with the ZCSPM API Application Secret ID.
   1. Click the Copy icon to copy the ID, then paste it into a text editor to save it.
   2. Click Done.