Ikoula API Veeam
Interact with Ikoula Veeam API for backup management. Developed by Ascenzia - www.ascenzia.fr
Actions26
- Backup Actions
- Backup Policy Actions
- Management Actions
- Veeam Actions
Overview
The "Stop Backup Job" operation in the Ikoula API Veeam node allows users to stop a running backup job within their Veeam backup environment managed via Ikoula's API. This is useful in scenarios where a backup job needs to be halted due to errors, resource constraints, or changes in backup strategy.
Practical examples include:
- Stopping a backup job that is taking too long or consuming excessive resources.
- Halting a backup job before making configuration changes to the backup agent or policies.
- Interrupting a backup job triggered by mistake or no longer needed.
This operation is part of a broader set of Veeam backup management capabilities provided by the node, enabling comprehensive control over backup jobs, agents, policies, and accounts.
Properties
| Name | Meaning |
|---|---|
| Subscription ID | The ID of the Veeam subscription. |
| Backup ID | The ID of the backup agent associated with the backup job. |
| Job ID | The ID of the specific backup job to stop. |
| Response Format | The format of the API response. Options: JSON, XML. |
Output
The output of this operation is the API response from the Ikoula Veeam service indicating the result of the stop backup job request. The json field contains either:
- A JSON object representing the status or confirmation of the stopped job if the response format is JSON.
- A string containing XML data if the response format is XML.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authentication with the Ikoula Veeam API.
- The node uses the Ikoula API endpoint (default:
https://api.ikoula.com) to send requests. - The password is encrypted using RSA public key encryption before transmission.
- Proper subscription, backup agent, and job IDs must be provided to identify the backup job to stop.
Troubleshooting
- Missing Credentials: If no credentials are provided, the node will throw an error "No credentials provided!". Ensure that valid API authentication details are configured.
- Invalid IDs: Providing incorrect subscription, backup, or job IDs may result in API errors or failure to stop the job. Verify these IDs in your Veeam account.
- API Response Errors: The API might return errors if the job is already stopped, does not exist, or if there are permission issues. Check the API response message for details.
- Network Issues: Connectivity problems to the Ikoula API endpoint can cause request failures. Confirm network access and endpoint availability.
Links and References
- Ikoula Veeam API Documentation (general reference)
- Veeam Backup & Replication Official Site