Portainer

Interact with Portainer via API

Actions190

Auth Actions
- Authenticate User
- Validate O Auth
Backup Actions
- Backup
- Restore
Custom Templates Actions
- Custom Template List
- Custom Template Delete
- Custom Template Inspect
- Custom Template Update
- Custom Template File
- Custom Template Git Fetch
- Custom Template Create File
- Custom Template Create Repository
- Custom Template Create String
Docker Actions
- Docker Container Gpus Inspect
- Docker Dashboard
- Docker Images List
Edge Groups Actions
- Edge Group Create
- Edge Group Delete
- Edge Group Inspect
- Ege Group Update
Edge Jobs Actions
- Edge Job Delete
- Edge Job Inspect
- Edge Job Update
- Edge Job File
- Edge Job Tasks List
- Edge Job Tasks Clear
- Edge Job Task Logs Inspect
- Edge Job Tasks Collect
- Edge Job Create File
- Edge Job Create String
Edge Stacks Actions
- Edge Stack Delete
- Edge Stack Inspect
- Edge Stack Update
- Edge Stack File
- Edge Stack Status Update
- Edge Stack Create File
- Edge Stack Create Repository
- Edge Stack Create String
Endpoint Groups Actions
- Endpoint Group Delete
- Endpoint Group Update
- Endpoint Group Delete Endpoint
- Endpoint Group Add Endpoint
Endpoints Actions
- Endpoint Delete Batch
- Endpoint List
- Endpoint Create
- Endpoint Delete
- Endpoint Inspect
- Endpoint Update
- Endpoint Association Delete
- Endpoint Dockerhub Status
- Endpoint Edge Status Inspect
- Endpoint Force Update Service
- Endpoint Registries List
- Endpoint Registry Access
- Endpoint Settings Update
- Endpoint Snapshot
- Endpoint Update Relations
Gitops Actions
- Git Operation Repo File Preview
Helm Actions
- Helm List
- Helm Install
- Helm Delete
- Helm Repo Search
- Helm Show
- Helm User Repositories List
- Helm User Repository Create
- Helm User Repository Delete
Intel Actions
- Open AMT Configure
- Open AMT Activate
- Open AMT Devices
- Device Action
- Device Features
- Open AMT Host Info
Kubernetes Actions
- Get All Kubernetes Applications
- Get All Kubernetes Applications Count
- Delete Cluster Role Bindings
- Delete Cluster Roles
- Get All Kubernetes Cluster Role Bindings
- Get All Kubernetes Cluster Roles
- Get All Kubernetes Config Maps
- Get All Kubernetes Config Maps Count
- Get Kubernetes Cron Jobs
- Delete Cron Jobs
- Get Kubernetes Dashboard
- Get All Kubernetes Ingress Controllers
- Update Kubernetes Ingress Controllers
- Get All Kubernetes Cluster Ingresses
- Get All Kubernetes Cluster Ingresses Count
- Delete Kubernetes Ingresses
- Get Kubernetes Jobs
- Delete Jobs
- Get Kubernetes Max Resource Limits
- Get Applications Resources
- Get Kubernetes Metrics For All Nodes
- Get Kubernetes Metrics For Node
- Get Kubernetes Metrics For All Pods
- Get Kubernetes Metrics For Pod
- Delete Kubernetes Namespace
- Get Kubernetes Namespaces
- Create Kubernetes Namespace
- Update Kubernetes Namespace Deprecated
- Get Kubernetes Namespace
- Update Kubernetes Namespace
- Get Kubernetes Config Map
- Get Kubernetes Ingress Controllers By Namespace
- Update Kubernetes Ingress Controllers By Namespace
- Get All Kubernetes Ingresses
- Create Kubernetes Ingress
- Update Kubernetes Ingress
- Get Kubernetes Ingress
- Get Kubernetes Secret
- Get Kubernetes Services By Namespace
- Create Kubernetes Service
- Update Kubernetes Service
- Kubernetes Namespaces Toggle System
- Get Kubernetes Volumes In Namespace
- Get Kubernetes Namespaces Count
- Get Kubernetes Nodes Limits
- Get Kubernetes RBAC Status
- Delete Role Bindings
- Get Kubernetes Role Bindings
- Get Kubernetes Roles
- Delete Roles
- Get Kubernetes Secrets
- Get Kubernetes Secrets Count
- Delete Service Accounts
- Get Kubernetes Service Accounts
- Get Kubernetes Services
- Get All Kubernetes Services Count
- Delete Kubernetes Services
- Get All Kubernetes Volumes
- Get Kubernetes Volume
- Get All Kubernetes Volumes Count
- Get Kubernetes Config
Ldap Actions
- LDAP Check
Registries Actions
- Registry Create
- Registry Delete
- Registry Inspect
- Registry Update
- Registry Configure
Resource Controls Actions
- Resource Control Create
- Resource Control Delete
- Resource Control Update
Settings Actions
- Settings Update
Ssl Actions
- SSL Update
Stacks Actions
- Stack List
- Stack Delete
- Stack Inspect
- Stack Update
- Stack Associate
- Stack File Inspect
- Stack Update Git
- Stack Git Redeploy
- Stack Migrate
- Stack Start
- Stack Stop
- Stack Create Kubernetes Git
- Stack Create Kubernetes File
- Stack Create Kubernetes Url
- Stack Create Docker Standalone File
- Stack Create Docker Standalone Repository
- Stack Create Docker Standalone String
- Stack Create Docker Swarm File
- Stack Create Docker Swarm Repository
- Stack Create Docker Swarm String
- Stack Delete Kubernetes By Name
- Webhook Invoke
Tags Actions
- Tag Create
- Tag Delete
Team Memberships Actions
- Team Membership Create
- Team Membership Delete
- Team Membership Update
- Team Memberships
Teams Actions
- Team List
- Team Create
- Team Delete
- Team Inspect
- Team Update
Templates Actions
- Template File
Upload Actions
- Upload TLS
Users Actions
- User List
- User Create
- User Delete
- User Inspect
- User Update
- User Memberships Inspect
- User Update Password
- User Get API Keys
- User Generate API Key
- User Remove API Key
- User Admin Init

Backup → Restore

AI-generated

Overview

This node's Backup - Restore operation allows users to restore data from a backup by sending a custom payload to the target system. It is useful in scenarios where you need to programmatically restore system states, configurations, or data snapshots via an API that accepts a restore request payload.

Practical examples include:

Restoring application settings after a failure.
Reverting to a previous state during deployment pipelines.
Automating disaster recovery processes by feeding backup data directly into the system.

Properties

Name	Meaning
Restore Payload	The JSON or string payload representing the restore request body to be sent to the API. This contains the backup data or instructions for restoration.

Output

The node outputs the response from the restore API call in the json field of the output data. This typically includes confirmation of success, error messages, or details about the restored data. If the API returns binary data (e.g., files), it would be included in the binary output, but based on the provided code and properties, the output is expected to be JSON.

Dependencies

Requires an API key credential for authenticating with the Portainer API or equivalent service.
Needs the base URL of the API endpoint configured in credentials.
Depends on the external API accepting the restore payload in the request body.

Troubleshooting

Invalid Payload Errors: Ensure the "Restore Payload" property contains correctly formatted JSON or string as expected by the API. Malformed payloads will cause the API to reject the request.
Authentication Failures: Verify that the API key or authentication token is valid and has sufficient permissions to perform restore operations.
Network Issues: Check connectivity to the API endpoint URL configured in credentials.
API Response Errors: Review the API response message in the node output for specific error codes or messages to guide troubleshooting.

Links and References

Portainer API Documentation
General REST API usage guidelines for backup and restore operations.

PortainerInstall