This is an archive version of the document. To get the most up-to-date information, see the current version.

Replace a Company

You can change parameters of a specific company by replacing it in Veeam Service Provider Console configuration.

Request

To replace a company in Veeam Service Provider Console, send the PUT HTTPS request to the URL of the /tenants resource.

HTTP Request

PUT https://<hostname>:1281/v2/tenants/{ID}

Request Headers

The request header must contain the authorization token.

Request Body

In the request body, the client must send the properties for the company that must be added to Veeam Service Provider Console. See the Properties section for the list of properties and their possible values.

The following properties must not be sent in the request:

  • id
  • instanceUid
  • siteName
  • isEnabled
  • gatewayPools
  • vMsBackedUp
  • vMsReplicated
  • vMsBackedUpToCloud
  • managedPhysicalWorkstations
  • managedCloudWorkstations
  • managedPhysicalServers
  • managedCloudServers
  • expirationDate
  • cloudConnectAgentUid
  • tenantType
  • vcdOrganizationUid

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns response code 201 Created.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the request body message: application/json; charset=utf-8

Response Body

In the response body, Veeam Service Provider Console returns a status and a message for an action.

Example Replace a Company

The following example replaces a company with ID 2 in Veeam Service Provider Console configuration.