Overview
This node integrates with the Veeam Service Provider Console (VSPC) API, allowing users to retrieve various types of data related to their VSPC environment. It supports multiple endpoints such as active alarms, backup jobs, company details, management agents, tenant products, and VB365 organization jobs.
Typical use cases include:
- Monitoring active alarms in the VSPC environment.
- Fetching backup job statuses or details.
- Retrieving detailed information about a specific company by its UID.
- Listing management agents or tenant products.
- Accessing VB365 organization job data.
For example, a user could configure this node to fetch all active alarms with filtering and sorting options to monitor critical issues, or retrieve detailed company information for reporting purposes.
Properties
| Name | Meaning |
|---|---|
| Endpoint | Choose the VSPC API endpoint to interact with. Options: Active Alarms, Backup Jobs, Company, Management Agents, Tenant Products, VB365 Organization Jobs. |
| Company UID | UID of the company to retrieve information for. Required only when the "Company" endpoint is selected. |
| Query Options | Collection of optional query parameters for endpoints other than "Company": - Limit: Max number of results to return. - Offset: Pagination offset. - Sort: Sort criteria. - Filter: Filter criteria. - Select: Comma-separated list of explicitly requested properties. |
| Company Options | Collection of optional parameters for the "Company" endpoint: - Select: Comma-separated list of explicitly requested properties. |
| Request Options | Additional request settings: - Ignore SSL Issues: Whether to ignore SSL certificate validation problems. |
Output
The node outputs JSON data corresponding to the response from the selected VSPC API endpoint:
- For the Company endpoint, the output JSON contains detailed information about the specified company.
- For other endpoints (Active Alarms, Backup Jobs, Management Agents, Tenant Products, VB365 Organization Jobs), the output JSON contains lists or objects representing the respective resources, potentially filtered, sorted, or paginated according to input options.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the VSPC API.
- The base URL and token for the VSPC API must be configured in the credentials.
- Optional configuration to ignore SSL certificate validation issues if needed.
Troubleshooting
- Missing Company UID: When using the "Company" endpoint, the node throws an error if the Company UID is not provided. Ensure this property is set.
- Unknown Endpoint Error: If an unsupported endpoint value is selected, the node will throw an error indicating the unknown endpoint.
- API Request Failures: Errors during API calls (e.g., network issues, authentication failures) result in descriptive error messages including the endpoint and cause. Verify API credentials, network connectivity, and that the VSPC API is accessible.
- SSL Certificate Issues: If SSL validation fails, enable the "Ignore SSL Issues" option under Request Options to bypass certificate errors (use with caution).
Links and References
- Veeam Service Provider Console (VSPC) API Documentation (example link, replace with actual if available)
- n8n HTTP Request Node Documentation – for understanding underlying HTTP request behavior used in this node.