Table of contents

Extractor Profiles API

Extractor Profiles contain configurations for multiple extractors, which are applied at the container level. NOTE: Prior to initiating analysis, the Extractor Profile itself should be created and configured through the Extractor Profiles page in the UI.

List all Extractor Profiles

In order 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"
		}
	]
}

List of all enabled extractors for a profile

In order to list all currently enabled extractors for a specific profile, make the following request:

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

This call will return a list of all currently enabled extractors within the requested Extractor Profile, as well as the individual extractor id(s).

Assign an Extractor Profile to a container

In order 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 (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 to true will allow the container to be walked on next scheduled walk.

This documentation is generated from the latest version of GrayMeta Platform. For documentation relevant to your own deployed version, please use the documentation inside the application.

© 2021 GrayMeta, Inc.