> ## Documentation Index
> Fetch the complete documentation index at: https://university.triggr-app.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Veeam Service Provider Console

> Connect Veeam Service Provider Console to Triggr with a dedicated portal account that signs in to the VSPC REST API.

Triggr works with VSPC companies, backup infrastructure, jobs, Veeam Agents, protected workloads, alarms, licences and activity logs, and can start, stop and retry jobs. One connection serves all your clients.

Your console must be reachable from the internet on its web UI port (1280 by default), at a public IP address, with a publicly trusted certificate that matches its host name.

## Set up Veeam Service Provider Console

<Steps>
  <Step title="Create a Windows account for Triggr">
    Create a dedicated local or domain account, such as `triggr-api`, with a password (not SSO or an API key) and the Allow log on locally right on the VSPC Server machine.
  </Step>

  <Step title="Give the account a portal role">
    As a Portal Administrator, go to **Configuration > Roles & Users > My Company > Windows Users**, click **New**, find the account, set its type to User and choose a role. For Portal Operator or Read-only User, choose All companies, including newly added on the Companies step.

    | Role | Scope |
    | - | - |
    | Portal Administrator | Everything, including infrastructure, licensing and users |
    | Portal Operator | Management of the companies you assign |
    | Read-only User | Monitoring data of the companies you assign |

    See Veeam's [Portal Administrators](https://helpcenter.veeam.com/docs/vac/provider_admin/manage_admins.html), [Portal Operators](https://helpcenter.veeam.com/docs/vac/provider_admin/manage_operators.html) and [Read-only Users](https://helpcenter.veeam.com/docs/vac/provider_admin/manage_read_only_users.html) guides.
  </Step>

  <Step title="Keep MFA off for the account">
    VSPC refuses the REST API password of any account with MFA set up, so don't sign in to the web UI with it if MFA is enforced. To undo it, select the account in Windows Users, click MFA and choose Reset configured MFA ([MFA guide](https://helpcenter.veeam.com/docs/vac/provider_admin/mfa_users.html)).
  </Step>

  <Step title="Install a trusted web UI certificate">
    Import a trusted certificate into the Windows certificate store on the web UI machine, install it in **Configuration > Certificates > Install > Web UI**, then restart the Veeam Service Provider Console site in IIS Manager. See Veeam's [Configuring Web UI Certificate](https://helpcenter.veeam.com/docs/vac/provider_admin/configure_web_ui_certificate.html) guide.
  </Step>

  <Step title="Allow Triggr through your firewall">
    Allow inbound HTTPS to the web UI port from [Triggr's IP addresses](/security/ip-allowlist).
  </Step>
</Steps>

## Connect it in Triggr

<Steps>
  <Step title="Open the configuration">
    Go to **Integrations > Veeam Service Provider Console** and click **Configure** on the Base Configuration card.

    <Frame>
      <img src="https://mintcdn.com/triggr/nyuVXZ1rouDTTEvu/images/integrations-common/base-configuration.png?fit=max&auto=format&n=nyuVXZ1rouDTTEvu&q=85&s=bb81acb082055015f91beda7b4876f35" alt="The Base Configuration card with Status Not Configured, Admin Consent Not Required and a Configure button." width="2272" height="330" data-path="images/integrations-common/base-configuration.png" />
    </Frame>
  </Step>

  <Step title="Enter the console and account">
    Enter the Console URL with `https://` and the port, such as `https://vspc.example.com:1280`, with no `/api/v3` or trailing slash. Enter the Username as `DOMAIN\USERNAME` with one backslash, such as `VSPC01\triggr-api` for a local account (`VSPC01` being the server's computer name), and the Password. Click Save Configuration.

    <Frame>
      <img src="https://mintcdn.com/triggr/rFRD51HB_88hTzdJ/images/veeam-vspc/configure.png?fit=max&auto=format&n=rFRD51HB_88hTzdJ&q=85&s=61f5c3e13161a9f21d501279cf592288" alt="The Veeam Service Provider Console configuration window with Console URL, Password and Username fields, an Allow insecure TLS switch under Advanced, and a Save Configuration button." width="1344" height="1482" data-path="images/veeam-vspc/configure.png" />
    </Frame>
  </Step>
</Steps>

To check the connection, run Get Console Version in a workflow.

## Work with companies in workflows

Company actions take a `companyUid`. Run List Companies with a `filter` such as the one below and use the company's `instanceUid`:

```json theme={null}
[{"property":"name","operation":"equals","collation":"ignorecase","value":"Contoso"}]
```

List actions return 100 items per page by default; use `limit` (up to 500) and `offset` to page. See Veeam's [Query Parameters](https://helpcenter.veeam.com/references/vac/9.3/rest/3.7/tag/SectionOverview#section/Query-Parameters) for `filter` and `sort`.

## Troubleshooting

<AccordionGroup>
  <Accordion title="no access token in password grant response">
    VSPC refused the sign-in. Check Username includes the domain, the password is current, and the account is enabled, has a portal role, has no MFA and is in Allow log on locally.
  </Accordion>

  <Accordion title="failed to parse or execute the password grant token request">
    Check Console URL is the web UI address with the right port and no path, resolves to a public IP address, and allows [Triggr's IP addresses](/security/ip-allowlist). An `x509` or `certificate` error means the certificate isn't publicly trusted or doesn't match the host name.
  </Accordion>

  <Accordion title="An action is refused with 403, or companies are missing">
    Portal Operators and Read-only Users only see their assigned companies. Assign the companies, or give the account Portal Administrator.
  </Accordion>

  <Accordion title="Requests fail with 429">
    VSPC limits concurrent and per-period requests. Spread bulk workflows out or retry after a short wait.
  </Accordion>
</AccordionGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.