Skip to content

README.md

Latest commit

 

History

History
46 lines (34 loc) · 2.14 KB

README.md

File metadata and controls

46 lines (34 loc) · 2.14 KB

Custom Integration: <INSERT_INTEGRATION_NAME_HERE>

runZero requirements

<INSERT_PRODUCT> requirements

  • <INSERT_REQUIREMENT_1> - example API Client Credentials
  • <INSERT_REQUIREMENT_2> - example API URL

Steps

<INSERT_PRODUCT> configuration

  1. <INSERT_STEP_1> - example get API URL
  2. <INSERT_STEP_2> - create API credentials
  3. <INSERT_STEP_3> - example update API_URL in the code

runZero configuration

  1. (OPTIONAL) - make any neccessary changes to the script to align with your environment.
    • Modify API calls as needed to filter assets
    • Modify datapoints uploaded to runZero as needed
  2. Create the Credential for the Custom Integration
    • Select the type Custom Integration Script Secrets
    • Both access_key and access_secret are required, but not all scripts will use both
    • Input a placeholde value like foo if the value is unused
  3. Create the Custom Integration
    • Add a Name and Icon
    • Toggle Enable custom integration script to input your finalized script
    • Click Validate to ensure it has valide syntax
    • Click Save to create the Custom Integration
  4. Create the Custom Integration task
    • Select the Credential and Custom Integration created in steps 2 and 3
    • Update the task schedule to recur at the desired timeframes
    • Select the Explorer you'd like the Custom Integration to run from
    • Click Save to kick off the first task

What's next?

  • You will see the task kick off on the tasks page like any other integration
  • The task will update the existing assets with the data pulled from the Custom Integration source
  • The task will create new assets for when there are no existing assets that meet merge criteria (hostname, MAC, etc)
  • You can search for assets enriched by this custom integration with the runZero search custom_integration:<INSERT_NAME_HERE>