Avaya Infinity™Avaya Experience Platform™
API Reference

Updates an HCG server

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

This API requires the Account Administrator role.

Updates an existing Avaya Hybrid Cloud Gateway with Avaya Hybrid Cloud Gateway id by account id

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 6 and 6
^[a-zA-Z]{6}$

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

uuid
required

The unique id of the Hybrid Cloud Gateway server

Body Params

Request object to update an Avaya Hybrid Cloud Gateway. Once a Hybrid Cloud Gateway element is created in NGM, it's systemId field isn't allowed to be updated. Hence the systemId field is excluded from this model.

string
required
length between 3 and 255
^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
string
length ≤ 1024
(^$|^[a-zA-Z0-9\p{L}\(\)\-\_\.\ \n]+$)
string
required
length between 1 and 4096

Public key of the Avaya Hybrid Cloud Gateway.

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:
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*
boolean
Defaults to true
boolean
required

Indicates if User agrees to terms and conditions.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json

Updated 5 months ago

Did this page help you?