Net3 API Interface for Customer Portal

<back to all web services

UpdateConfigReq

Requires Authentication
The following routes are available for this service:
POST/config/updateUpdate an existing N3T global config
UpdateConfigReq Parameters:
NameParameterData TypeRequiredDescription
configbodyjsonYes
Config Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
TypeformstringNo
ServersformList<Server>No
MailformMailNo
VMWareMaxSupportedSDKformdecimalNo
VSphereMaxSupportedSDKformdecimalNo
VMwareMaxSupportedRestformdecimalNo
AWSProfileNameformstringNo
AWSRegionformstringNo
ActifioformActifioNo
VCenterformList<VCenter>No
VCloudDirformList<VCloudDir>No
Server Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
IPformstringNo
ProviderformProvidersNo
ProviderNameformstringNo
EnvironmentsformList<N3TEnvironment>No
EnvironmentsNamesformList<string>No
EnvironmentsInfoformList<EnvironmentInfo>No
Providers Enum:
vCloud
AWS
GCP
Azure
Actifio
Zerto
Veeam
Acronis
N3T
Auvik
N3TEnvironment Enum:
DEV
QA
UAT
PROD
DEMO
EXT
EnvironmentInfo Parameters:
NameParameterData TypeRequiredDescription
IPformstringNo
ProviderformProvidersNo
HostformEnvironmentHostNo
TypeformN3TEnvironmentTypeNo
EnvironmentformN3TEnvironmentNo
DatabaseformEnvironmentDatabaseNo
EnvironmentTypeformstringNo
EnvironmentNameformstringNo
EnvironmentHost Parameters:
NameParameterData TypeRequiredDescription
URLformstringNo
PortformstringNo
ProtocolformstringNo
EnvironmentBase Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
UserformstringNo
PasswordformstringNo
N3TEnvironmentType Enum:
Database
Host
EnvironmentDatabase Parameters:
NameParameterData TypeRequiredDescription
PortformstringNo
DatabaseformstringNo
providerNameformstringNo
ConnectionTimeoutformintNo
ConnectionStringformstringNo
Mail Parameters:
NameParameterData TypeRequiredDescription
HostformstringNo
FromAddressformstringNo
NotificationsEmailformstringNo
PasswordResetWindowMinformintNo
PasswordResetTemplateformstringNo
SendToInvoicesCreatedformstring[]No
NotificationsEmailServerformstringNo
NotificationsEmailServerPortformintNo
Actifio Parameters:
NameParameterData TypeRequiredDescription
VendorKeyformstringNo
LoginsformList<ActifioLogin>No
RemoteDatastoresformList<ActifioRemoteDatastore>No
ActifioLogin Parameters:
NameParameterData TypeRequiredDescription
UrlsformUrlNo
Login Parameters:
NameParameterData TypeRequiredDescription
usernameformstringNo
passwordformstringNo
DTOBase Parameters:
NameParameterData TypeRequiredDescription
sessionIdformstringNo
Url Parameters:
NameParameterData TypeRequiredDescription
APIformstringNo
HiddenformstringNo
ActifioRemoteDatastore Parameters:
NameParameterData TypeRequiredDescription
EsxHostformstringNo
VmwareIdformintNo
LocationNameformstringNo
LocationformDatacenterLocationsNo
DatacenterLocations Enum:
ACD
GMU
SPA
LAS
DEV
VCD
AWS
GCP
UAT
AZU
CNW
AUV
ATL
EXT

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /config/update HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"config":{"id":"00000000000000000000000000000000","type":"Config","servers":[{"name":"String","ip":"String","provider":"vCloud","providerName":"vCloud","environments":["DEV"],"environmentsNames":["String"],"environmentsInfo":[{"ip":"String","provider":"vCloud","host":{"url":"String","port":"String","protocol":"String","name":"String","user":"String","password":"String"},"type":"Database","environment":"DEV","database":{"port":"String","database":"String","providerName":"String","connectionTimeout":0,"connectionString":"String","name":"String","user":"String","password":"String"},"environmentType":"Database","environmentName":"DEV"}]}],"mail":{"host":"String","fromAddress":"String","notificationsEmail":"String","passwordResetWindowMin":0,"passwordResetTemplate":"String","sendToInvoicesCreated":["String"],"notificationsEmailServer":"String","notificationsEmailServerPort":0},"vmWareMaxSupportedSDK":0,"vSphereMaxSupportedSDK":0,"vMwareMaxSupportedRest":0,"awsProfileName":"String","awsRegion":"String","actifio":{"vendorKey":"String","logins":[{"urls":{"api":"String","hidden":"String"},"locationName":"ACD","location":"ACD","user":"String","password":"String","isEncrypted":false}],"remoteDatastores":[{"esxHost":"String","vmwareId":0,"locationName":"ACD","location":"ACD"}]},"vCenter":[{"locationName":"ACD","location":"ACD","user":"String","password":"String","isEncrypted":false}],"vCloudDir":[{"locationName":"ACD","location":"ACD","user":"String","password":"String","isEncrypted":false}]}}