Extractor Profiles API in Wasabi AiR
    • 20 May 2024
    • 1 Minute to read
    • PDF

    Extractor Profiles API in Wasabi AiR

    • PDF

    Article summary

    Extractor profiles contain configurations for multiple extractors, which are applied at the container level. 

    Prior to initiating analysis, the extractor profile should be created and configured through the Extractor Profiles page in the user interface.

    Listing All Extractor Profiles

    To list all extractor profiles, make the following request:

    GET /api/data/h2/extractor-profiles

    Response

    {
    	"profiles": [
    		{
    			"id": "default",
    			"name": "default",
    			"description": "default profile"
    		},
    		{
    			"id": "5f34150bbcf4bbc4903a5546470bf4b3",
    			"name": "JRG Extractor Profile",
    			"description": "This profile will be for compliance analyzation"
    		},
    		{
    			"id": "5f3fb8f46d91b2bdbb2249fd8b817ebb",
    			"name": "New Extractor Profile",
    			"description": "Profile for test container"
    		}
    	]

    Listing All Enabled Extractors for a Profile

    To list all currently enabled extractors for a specific profile, make the following request:

    GET /api/data/h2/extractor-profiles/{id}

    Response

    This call returns a list of all currently enabled extractors within the requested extractor profile as well as the individual extractor id(s).

    Assigning an Extractor Profile to a Container

    To assign an extractor profile to a storage container, make the following request:

    PUT /api/data/containers
    {
    	"id":"id",
    	"location_id":"location_id",
    	"profile_id":"profile_id",
    	"enabled":false
    }
    • id - (string) The container name, which will vary by provider.
    • location_id - (string) The location_id of the storage.
    • profile_id - (string) The profile_id for the extractor profile to be assigned to the container.
    • enabled - (bool) Intended status. Setting this to true enables the container to be walked on the next scheduled walk.