Unraid API icon

Unraid API

Interact with the Unraid API

Docker → Get by Name

AI-generated

Summary

Searches Unraid Docker containers by name, image, or either field and returns all matching containers. Matching is case-insensitive and can require an exact match.

Inputs

  • Search Term (required) — Name or image text to search for.
  • Match Field — Choose Container Name, Image Name, or Either; defaults to Container Name.
  • Exact Match — When enabled, requires an exact match; defaults to false, which matches partial text.

Output shape

A single item containing a containers array of matching container records.

Each record includes the fields requested by the node’s container-list query, such as ID, names, image, state, status, ports, and update availability. If no containers match, the array is empty.

Links

Discussion