Manage extractors and images

Find extractors, list their images, update their details, and archive the ones you no longer need.

Python

from nominal.core.container_image import ContainerImageStatus

# Find extractors whose active image accepts a given file suffix (no leading dot)
extractors = client.search_containerized_extractors(file_extension="bin")

# List an extractor's images, or filter to the ones that failed to push
images = extractor.search_container_images(status=ContainerImageStatus.FAILED)

# Rename, re-describe, or activate a different image
extractor.update(description="Parses v2 bespoke binary logs")

# Hide from the default upload flow and search, reversibly
extractor.archive()
extractor.unarchive()

CLI

The nom CLI mirrors these as nom container extractor search|get|update|archive|unarchive and nom container image search|get|delete. An image cannot be deleted while an extractor still has it active.

Archive an extractor

If you no longer need an extractor, archive it. Archived extractors are hidden from the default upload flow and search results, and can be unarchived later.

Over the REST API, patch isArchived to true (and back to false to unarchive):

curl -X PATCH ${API_SERVER}/api/extractors/v2/your_extractor_rid -H "Authorization: Bearer <token>" -H "Content-Type: application/json" -d '{
  "workspaceRid": "your_workspace_rid",
  "isArchived": true
}'