In order make it easy to get started interacting with the Snow Atlas API, Snow makes a Postman collection available for import.

Prepare Atlas API Access
Prepare Postman  
Test Connections
Common Errors
 

Prepare Atlas API Access

Follow the procedure below to create an application registration you will use to access the Atlas API. 
 

1. Login to Atlas.
2. Browse to Snow Atlas Settings > Application registrations and click Create registration.
3. Provide a meaningful Name and optional Description to help you identify the purpose of this application registration in the future. 

4. Under the Permissions section, select the API areas you wish to be available to this application registration. Only data available from related endpoints will be available. 

5. Click Create >. The page refreshes to the Credentials section.  
6. Record the Client ID, and Client secret securely. This information will be used in the next section. 

7.  Click Close. 

The application registration you created now appears in the list. 

 

Prepare Postman 

Next, take the information from the previous section and use it with Postman. 
 

1. Download the Snow Atlas Postman collection.
2. Download and install Postman on your workstation. Alternatively, you can use Postman in your browser as a SaaS product. 
3. Register a Postman account and launch locally. You will be prompted to confirm your address via an activation email. 
4. Postman uses workspaces to segregate your activity, usually by the products for which you are doing the testing. You can use the default My Workspace for all Snow API activity, or create multiple workspaces to your preference. 
5. From the Workspaces menu, choose the workspace you will use for Snow API activity. 
6. Beside the workspace name, choose Import. 

7. Drag and drop the extracted Snow Atlas Postman collection from step 1 onto the dialog that opens. 

8. When the import is completed, you will now see a Snow_Atlas collection in your workspace. Select it to open the collection to its Overview page. 

8. Switch to the Variables tab. 
9. Confirm the Region matches your Atlas instance (currently westeurope, eastus2, and australiasoutheast are valid choices). Add the Client ID and Client secret values recorded in the previous section. 

10. Click to save your settings. 
11. Under the Snow_Atlas collection, select Post Get-Token. Click Send. 
12. Note the access_token value from the response body.

12. Return to the Variables tab for the collection and confirm it's been populated. Tokens are valid for 30 minutes, and there is a limit to how many times tokens can be requested each 30 minutes. To refresh your token, follow Step 10 again. 

 

Test Connections

• Get Computers returns a paginated list of computers
• Get Licenses returns a paginated list of licenses
• Get Users returns a paginated list of users 
• Get Custom Objects returns a paginated list of custom objects

To do so, follow the instructions below. 

1. If it has been more than 30 minutes since you last refreshed your token in Postman, do so following the procedure in the previous section.
2. Select the test to run and click Send.
3. Review the results in the Body section.  

If you experience any failures, please refer to the error index below for assistance. 
 

Common Errors

Message: idp: token is invalid or expired
Meaning: This indicates that the current token is no longer valid.
Resolution: Refresh your token using Get-token and confirm the results match on the variables page. Save the new token and try your operation again. 

 

Message:Too many requests, please try later.
Meaning: This indicates that too many token refresh attempts have been made within 30 minutes.
Resolution: Wait 30 minutes from your last attempt before requesting a new token. Note that this can be distinguished from issues with hitting a rate limiter because those will specifically report what's happened. 

 

Message: Scope 'some.permission.r' is required but not found in token
Meaning: This indicates that the application registration used requires the named permission, but does not have it. 
Resolution: Edit the application registration to provide the named permission and try your operation again.  


 

See Also

• Snow Atlas API documentation