IMPORTANT ANNOUNCEMENT: On May 6, 2024, Carbon Black User eXchange (UeX) and Case Management will move to a new platform!
The Community will be in read-only mode starting April 19th, 7:00 AM PDT. Check out the blog post!
You will still be able to use the case portal to create and interact with your support cases until the transition, view more information here!

App Control: How To Use Postman to Retrieve Data Via API

App Control: How To Use Postman to Retrieve Data Via API

Environment

  • App Control API: All supported Versions
  • Postman Utility for Windows

Objective

    
Retrieve data available via Carbon Black's rest API using Postman.

Resolution

  1. Generate an API Key. 
  2. Launch Postman and create a new HTTP Get Request and specify the API URL using the Server Address. Example:
    https://ServerAddress/api/bit9platform/v1/computer
  3. Specify the required Key & Value combinations in the Query Params for the API Request. Example:
    Key           Value
    Limit         0
    fields        agentVersion,Name
    q             deleted:false
    
    Note: The URL will adjust dynamically based on the key & value combinations entered in the Query Params.
    
  4. Click the Authorization tab and specify the API Key using X-Auth-Token. Example:
    • Type: API Key
    • Key: X-Auth-Token
    • Value: API Key from Step 1
    • Add to: Header
  5. Click Send.

Additional Notes

  • The above example will pull the Agent Version and Machine Name for all machines currently shown in the Console > Assets > Computers.
  • If using a Self-signed Certificate it may be necessary to disable Postman's SSL Certificate Verification: File > Settings > General > SSL Certificate Verification > OFF.

Related Content


Labels (1)
Tags (2)
Was this article helpful? Yes No
No ratings
Article Information
Author:
Creation Date:
‎09-24-2020
Views:
1232