Getting started

Here's how to get started with the Partner Application.

Create a Partner Application

  1. Sign in to the Multi-Tenant Console, click Settings, then click Application.
  2. Click Add New Application.
  3. Enter a name and privileges.
  4. Click Submit.
  5. Copy the Application ID (Guid) and Application Secret (Hash) to a text file.
    If you lose the Application Secret, you will have to regenerate a new one. This cannot be retrieved from the MTC application.
  6. Click OK.

Generate a Bearer Token

  1. Import the example JSON file into Postman.
  2. Select the /{region_code}/auth endpoint.
    • {{baseUrl}} is https://api-admin.cylance.com/public/v2.
    • {region_code} is the MTC region you sign into.
    • For example, the full URL for the US login region would be https://api-admin.cylance.com/public/v2/us/auth.
  3. Click on the Authorization Tab.
  4. Select Basic Auth from the Type list.
  5. Enter your Application ID as Username and your Application Secret as Password.

    Under the Headers Tab, in the Temporary Headers list you should see an Authorization header with a value of Basic {base64Hash}.

  6. Click on the Body Tab.
  7. Select the x-www-form-urlencoded radio button.
  8. Make sure that the value of grant_type is client_credentials.
  9. Make sure that the value of scope is api.
  10. Click Send.
    The API will respond with a 200 response code and a token response object as the following:
    JSON 
    {
"access_token": string,
"expires_in": int,
"token_type": string
}
    The access_token will be used in all subsequent calls as the Bearer token.

Making your first call to Health Check

  1. Select the /{region_code}/health-check endpoint.
    • {{baseUrl}} is https://api-admin.cylance.com/public/v2.
    • {region_code} is the MTC region you sign into.
    • Full URL for the US login region would be https://api-admin.cylance.com/public/v2/us/health-check.
  2. You should receive 200 response code and string return like the following:
    JSON 
    {
 "Version": x.x.x.x | Environment: 'Production'"
}