Getting Started
Here’s how to get started with the Partner Application
Create a Partner Application
- Log into the Multi-Tenant Console, select Settings, then select Application.
- Click Add New Application.
- Enter a name and privileges.
- Click Submit.
-
Copy 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.
- Click OK.
Generate a Bearer Token
- Import the example JSON file into Postman.
-
Select the
/{region_code}/auth
endpoint.-
{{baseUrl}}
ishttps://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/{region_code}/auth
.
-
- Click on the Authorization Tab.
- Select Basic Auth from the Type drop down.
-
Enter your Application ID as Username and your Application
Secret as Password.
-
Under the Headers Tab, in the Temporary
Headers drop down you should see an Authorization header
with a value of
Basic {base64Hash}
.
-
Under the Headers Tab, in the Temporary
Headers drop down you should see an Authorization header
with a value of
- Click on the Body Tab.
-
The
x-www-form-urlencoded
radio button should be selected. -
The value of
grant_type
must beclient_credentials
. -
The value of
scope
must beapi
. - Click Send.
- The API will respond with a 200 response code and a token response object as the following:
{
"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
-
Select the
/{region_code}/health-check
endpoint.-
{{baseUrl}}
ishttps://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
.
-
- You should receive 200 response code and string return like the following:
{
"Version": x.x.x.x | Environment: 'Production'"
}