Creates an HCG server

post

{protocol}://{server}{basePath}/accounts/{accountId}/hybrid-cloud-gateways

This API requires the Account Administrator role.

Creates an Avaya Hybrid Cloud Gateway for specified account

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account.

Body Params

Avaya Hybrid Cloud Gateway acts as a gateway to Avaya Aura clients and applications utilizing WebRTC signaling and media.

name

string

required

length between 3 and 255

^[a-zA-Z0-9\p{L}\-\_\.\ ]+$

description

string

length ≤ 1024

(^$|^[a-zA-Z0-9\p{L}\-\_\.\ \n]+$)

systemId

uuid

required

System-Id of Avaya Hybrid Cloud Gateway

publicKey

string

required

length between 1 and 4096

Public key of the Avaya Hybrid Cloud Gateway.

publicKeyAlgorithm

string

enum

Defaults to ES256

Algorithm for the public key. This is a mandatory field for configuring a Hyrbid Cloud Gateway. Currently it is internally set to ES256, if not specified.

Allowed:

locationCode

string

required

length between 1 and 7

ISO 3166-2 location code for country and region. For various country and region codes, check : https://www.iso.org/obp/ui/#search

sessionManagerFqdnList

array of strings

required

length between 1 and 50

List of Fully-Qualified Domain-Name (FQDN) of all the deployed Session Managers for the tenant.

sessionManagerFqdnList*

isMediaLatchingEnable

boolean

Defaults to true

isTermsAndConditionsAccepted

boolean

required

Defaults to false

Avaya cloud solutions are designed to scale while maintaining deep security and high availability. This cloud solution supports secure media, which is recommended by Avaya. If secure media is disabled on your existing system, media traffic will flow on the internet and through Avaya servers unencrypted. The security benefits of encrypted traffic will not be available. For more information, please see https://www.avaya.com/en/trust-center-cloud-security/

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses