Help Center
Choose product document...
Veeam Availability Console 3.0
RESTful API Reference

Create a Company

You can add a company into Veeam Availability Console configuration.

Request

To create a company in Veeam Availability Console, send the POST HTTPS request to the URL of the /tenants resource.

HTTP Request

POST https://<Availability-Console>:1281/v2/tenants

Request Headers

The request header must contain the authorization token for the current logon session.

Request Body

In the request body, the client must send the properties for the company that must be added to Veeam Availability 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

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 Availability Console returns a status and a message for an action.

Example Create a Company

The following example adds a new company into Veeam Availability Console configuration.

Request:

POST https://localhost:1281/v2/tenants

 

Request Header:

Content-Type: application/json

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "cloudConnectAgentUid": "a444b725-5aa0-487c-ad4a-f6bfb573c07f",

 "description": "Company created by REST API",

 "bandwidthThrottlingEnabled": true,

 "allowedBandwidth": 15,

 "allowedBandwidthUnits": "MbitPerSec",

 "maxConcurrentTask": 2,

 "expirationEnabled": true,

 "expirationTime": "2020-03-05T17:55:29.559Z",

 "backupProtectionEnabled": true,

 "backupProtectionPeriod": 2,

 "userName": "AlphaCo",

 "firstName": "John",

 "lastName": "Lawrence",

 "title": "Mr",

 "password": "AlphaLawrence123",

 "dataTransferGb": 5,

 "networkFailoverResourcesEnabled": true,

 "numberOfPublicIp": 1,

 "publicIpEnabled": true,

 "gatewayFailoverEnabled": true,

 "tenantType": "General",

 "vcdOrganizationUid": "",

 "notes": "",

 "companyId": "Alpha",

 "name": "Alpha Company",

 "country": 1,

 "taxId": "79453187",

 "usState": 3,

 "zipCode": "85396",

 "domain": "alpha.com",

 "city": "Phoenix",

 "street": "311th Ave",

 "telephone": "+17773215749",

 "emailAddress": "j.lawrence@alpha.com",

 "cloudGatewayPoolsUids": [

   "70e992e6-37f8-4531-a434-511842471ab0"

 ]

}

 

Response Code:

201 Created

Veeam Large Logo

Deployment Guide

Guide for Service Providers

Guide for End Users

Guide for Resellers

Usage Scenarios for Service Providers

RESTful API Reference