Portainer icon

Portainer

Work with Portainer API data to manage Docker

Actions86

Registry → Delete

AI-generated

Overview

This node operation deletes a registry resource in Portainer by its ID. It is useful for managing Docker image registries by removing those that are no longer needed or valid. For example, if a registry is deprecated or replaced, this operation can be used to clean up the registry list.

Use Case Examples

  1. Deleting a registry by specifying its Registry ID to remove it from Portainer.
  2. Force deleting a registry even if it is currently in use by setting the Force Delete option to true.

Properties

Name Meaning
Registry ID The ID of the registry to delete, required to identify which registry to remove.
Force Delete Whether to force deletion even if the registry resource is currently in use, allowing removal despite dependencies.
Request Options Additional HTTP request options such as batching, SSL certificate validation, proxy, and timeout settings to customize the API call behavior.

Output

JSON

  • body - The response body from the Portainer API after attempting to delete the registry, typically indicating success or failure status.

Dependencies

  • Requires an API key credential for Portainer API authentication.

Troubleshooting

  • Ensure the Registry ID is correct and exists in Portainer to avoid 'not found' errors.
  • If force deletion is enabled, be aware it may cause issues if the registry is actively used by other resources.
  • Check network connectivity and proxy settings if the request fails to reach the Portainer API.
  • Verify SSL settings if encountering certificate validation errors, especially when using self-signed certificates.

Links

Discussion