Add an Amazon ELB Device

Payload

Name Description
name

String

 (Mandatory) Name of the device.
Constraints:

  • Accepted special characters: '-' , '_' , '.' , '*' , '|' , '!' and space only.

  • Length 2 - 64 characters.
vendor

String

 (Mandatory) Vendor of the device.
communicationAddressType

String

 (Mandatory) Communication type to the device. The possible values are:
  • IP
  • FQDN
ip

String

 (Mandatory) IP of the device.

Constraints:

  • Required only if communicationAddressType is IP.
  • The IP address must be in IPV4 format.
fqdn

String

 (Mandatory) FQDN of the device.

Constraints: Required only if communicationAddressType is FQDN.
credentialType

String

 (Mandatory) Type of credential to be associated for the device.
The possible values are:
  • Manual Entry
  • Credential List - AppViewX
  • Credential List - CyberArk
userName

String

 (Mandatory) User name of the device.

Constraints: Required only if credential Type is Manual entry.

It will not accept ‘,”,<,>.
password

String

 (Mandatory) Encoded value of the password to authenticate with the device.

Constraints: Required only if credential Type is Manual entry.
credentialName

String

 (Mandatory) Name of the credential to be associated with the device.
Constraints:

  • Required only if credential type is ’Credential List - AppViewX or ’Credential List - CyberArk’.

  • Credential of the requested name should be added in AppViewX already.

  • Accepted special characters: '-' , '_' , '.' , '*' , '|' , '!' and space only.

  • Length 2 - 64 characters.
module

String[]

 (Mandatory) Modules with which the device is to be added.
certSync

String

 (Optional) Certificate sync mode.
The possible values are:
  • Managed
  • Monitored
  • Ignored
The default value is Ignored.
sshPort 
String
 (Optional) Device communication port.

The default value is 22.

It must be between 1 and 65535.
certSync

String

 (Optional) Certificate sync mode.
The possible values are:
  • Managed
  • Monitored
  • Ignored
The default value is Ignored.
isAppViewXSyncRequired

Boolean

 (Optional) Boolean value to denote whether AppViewX group is required. Only for applicable vendors.

The default value is False.
isAutoDetectSecondary

Boolean

 (Optional) Boolean value to denote whether secondary devices should be automatically discovered and added to AppViewX.

The default value is False.
dataCenter

String

 (Optional) Data center with which the device is to be added.

Response Structure

  • Status Code: 202 OK
  • Message: Successful
  • Headers:
    • Content-Type: application/json
Name Description
response

String

 Success message or failure description in case of error.
message

String

 Success message or failure description in case of error.
appStatusCode

String

 Application specific status code for the response. Will be non-null for failure response.
tags

String

 More info in case of failure response.

Status Codes

HTTP Status Code appStatusCode Message Possible remediation
202 Accepted - Device has been successfully added and configuration parse is triggered -
400 Bad Request ADC_INV_0004 Validation error One or more fields are invalid. Reason for validation failure and possible remediation will be available in ‘tags’ field of response.
409 Conflict ADC_INV_0001 Device(s) Already Exists Device already exists in AppViewX. Change the name of the device and IP/FQDN.
409 Conflict ADC_INV_0006 Device Name Already Exists. Change the name of the device and retry adding.
409 Conflict ADC_INV_0007 IP Already Exists Change the IP of the device and retry adding.
409 Conflict ADC_INV_0027 FQDN already exists Change the FQDN field of the device and retry adding.
404 Not Found ADC_INV_1076 Device not available for the given details. Check if the requested device is added in the inventory.

Sample Request/Response

Use Case

NA

Sample Request

NA

Sample Response

NA

What's Next