<back to all web services
UpdateConfigReq
The following routes are available for this service:POST | /config/update | Update an existing N3T global config | |
---|
UpdateConfigReq Parameters:Name | Parameter | Data Type | Required | Description |
---|
config | body | json | Yes | |
Config Parameters:Name | Parameter | Data Type | Required | Description |
---|
Id | form | Guid | No | |
Type | form | string | No | |
Servers | form | List<Server> | No | |
Mail | form | Mail | No | |
VMWareMaxSupportedSDK | form | decimal | No | |
VSphereMaxSupportedSDK | form | decimal | No | |
VMwareMaxSupportedRest | form | decimal | No | |
AWSProfileName | form | string | No | |
AWSRegion | form | string | No | |
Actifio | form | Actifio | No | |
VCenter | form | List<VCenter> | No | |
VCloudDir | form | List<VCloudDir> | No | |
Server Parameters:Name | Parameter | Data Type | Required | Description |
---|
Name | form | string | No | |
IP | form | string | No | |
Provider | form | Providers | No | |
ProviderName | form | string | No | |
Environments | form | List<N3TEnvironment> | No | |
EnvironmentsNames | form | List<string> | No | |
EnvironmentsInfo | form | List<EnvironmentInfo> | No | |
Providers Enum:vCloud | |
AWS | |
GCP | |
Azure | |
Actifio | |
Zerto | |
Veeam | |
Acronis | |
N3T | |
Auvik | |
N3TEnvironment Enum:DEV | |
QA | |
UAT | |
PROD | |
DEMO | |
EXT | |
EnvironmentInfo Parameters:Name | Parameter | Data Type | Required | Description |
---|
IP | form | string | No | |
Provider | form | Providers | No | |
Host | form | EnvironmentHost | No | |
Type | form | N3TEnvironmentType | No | |
Environment | form | N3TEnvironment | No | |
Database | form | EnvironmentDatabase | No | |
EnvironmentType | form | string | No | |
EnvironmentName | form | string | No | |
EnvironmentHost Parameters:Name | Parameter | Data Type | Required | Description |
---|
URL | form | string | No | |
Port | form | string | No | |
Protocol | form | string | No | |
EnvironmentBase Parameters:Name | Parameter | Data Type | Required | Description |
---|
Name | form | string | No | |
User | form | string | No | |
Password | form | string | No | |
N3TEnvironmentType Enum:Database | |
Host | |
EnvironmentDatabase Parameters:Name | Parameter | Data Type | Required | Description |
---|
Port | form | string | No | |
Database | form | string | No | |
providerName | form | string | No | |
ConnectionTimeout | form | int | No | |
ConnectionString | form | string | No | |
Mail Parameters:Name | Parameter | Data Type | Required | Description |
---|
Host | form | string | No | |
FromAddress | form | string | No | |
NotificationsEmail | form | string | No | |
PasswordResetWindowMin | form | int | No | |
PasswordResetTemplate | form | string | No | |
SendToInvoicesCreated | form | string[] | No | |
NotificationsEmailServer | form | string | No | |
NotificationsEmailServerPort | form | int | No | |
Actifio Parameters:Name | Parameter | Data Type | Required | Description |
---|
VendorKey | form | string | No | |
Logins | form | List<ActifioLogin> | No | |
RemoteDatastores | form | List<ActifioRemoteDatastore> | No | |
ActifioLogin Parameters:Name | Parameter | Data Type | Required | Description |
---|
Urls | form | Url | No | |
Login Parameters:Name | Parameter | Data Type | Required | Description |
---|
username | form | string | No | |
password | form | string | No | |
DTOBase Parameters:Name | Parameter | Data Type | Required | Description |
---|
sessionId | form | string | No | |
Url Parameters:Name | Parameter | Data Type | Required | Description |
---|
API | form | string | No | |
Hidden | form | string | No | |
ActifioRemoteDatastore Parameters:Name | Parameter | Data Type | Required | Description |
---|
EsxHost | form | string | No | |
VmwareId | form | int | No | |
LocationName | form | string | No | |
Location | form | DatacenterLocations | No | |
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 .xml suffix or ?format=xml
HTTP + XML
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: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateConfigReq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services.N3TConfig.Request">
<config xmlns:d2p1="http://schemas.datacontract.org/2004/07/N3TEntities.Common.N3TConfig">
<d2p1:AWSProfileName>String</d2p1:AWSProfileName>
<d2p1:AWSRegion>String</d2p1:AWSRegion>
<d2p1:Actifio>
<d2p1:Logins>
<d2p1:ActifioLogin>
<d2p1:IsEncrypted>false</d2p1:IsEncrypted>
<d2p1:Location>ACD</d2p1:Location>
<d2p1:Password>String</d2p1:Password>
<d2p1:User>String</d2p1:User>
<d2p1:Urls>
<d2p1:API>String</d2p1:API>
<d2p1:Hidden>String</d2p1:Hidden>
</d2p1:Urls>
</d2p1:ActifioLogin>
</d2p1:Logins>
<d2p1:RemoteDatastores>
<d2p1:ActifioRemoteDatastore>
<d2p1:EsxHost>String</d2p1:EsxHost>
<d2p1:Location>ACD</d2p1:Location>
<d2p1:VmwareId>0</d2p1:VmwareId>
</d2p1:ActifioRemoteDatastore>
</d2p1:RemoteDatastores>
<d2p1:VendorKey>String</d2p1:VendorKey>
</d2p1:Actifio>
<d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
<d2p1:Mail>
<d2p1:FromAddress>String</d2p1:FromAddress>
<d2p1:Host>String</d2p1:Host>
<d2p1:NotificationsEmail>String</d2p1:NotificationsEmail>
<d2p1:NotificationsEmailServer>String</d2p1:NotificationsEmailServer>
<d2p1:NotificationsEmailServerPort>0</d2p1:NotificationsEmailServerPort>
<d2p1:PasswordResetTemplate>String</d2p1:PasswordResetTemplate>
<d2p1:PasswordResetWindowMin>0</d2p1:PasswordResetWindowMin>
<d2p1:SendToInvoicesCreated xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d2p1:SendToInvoicesCreated>
</d2p1:Mail>
<d2p1:Servers>
<d2p1:Server>
<d2p1:Environments xmlns:d5p1="http://schemas.datacontract.org/2004/07/N3TEntities.Common.Enums">
<d5p1:N3TEnvironment>DEV</d5p1:N3TEnvironment>
</d2p1:Environments>
<d2p1:EnvironmentsInfo>
<d2p1:EnvironmentInfo>
<d2p1:Database>
<d2p1:Name>String</d2p1:Name>
<d2p1:Password>String</d2p1:Password>
<d2p1:User>String</d2p1:User>
<d2p1:ConnectionString>String</d2p1:ConnectionString>
<d2p1:ConnectionTimeout>0</d2p1:ConnectionTimeout>
<d2p1:Database>String</d2p1:Database>
<d2p1:Port>String</d2p1:Port>
<d2p1:providerName>String</d2p1:providerName>
</d2p1:Database>
<d2p1:Environment>DEV</d2p1:Environment>
<d2p1:Host>
<d2p1:Name>String</d2p1:Name>
<d2p1:Password>String</d2p1:Password>
<d2p1:User>String</d2p1:User>
<d2p1:Port>String</d2p1:Port>
<d2p1:Protocol>String</d2p1:Protocol>
<d2p1:URL>String</d2p1:URL>
</d2p1:Host>
<d2p1:IP>String</d2p1:IP>
<d2p1:Provider>vCloud</d2p1:Provider>
<d2p1:Type>Database</d2p1:Type>
</d2p1:EnvironmentInfo>
</d2p1:EnvironmentsInfo>
<d2p1:EnvironmentsNames xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>String</d5p1:string>
</d2p1:EnvironmentsNames>
<d2p1:IP>String</d2p1:IP>
<d2p1:Name>String</d2p1:Name>
<d2p1:Provider>vCloud</d2p1:Provider>
</d2p1:Server>
</d2p1:Servers>
<d2p1:VCenter>
<d2p1:VCenter>
<d2p1:IsEncrypted>false</d2p1:IsEncrypted>
<d2p1:Location>ACD</d2p1:Location>
<d2p1:Password>String</d2p1:Password>
<d2p1:User>String</d2p1:User>
</d2p1:VCenter>
</d2p1:VCenter>
<d2p1:VCloudDir>
<d2p1:VCloudDir>
<d2p1:IsEncrypted>false</d2p1:IsEncrypted>
<d2p1:Location>ACD</d2p1:Location>
<d2p1:Password>String</d2p1:Password>
<d2p1:User>String</d2p1:User>
</d2p1:VCloudDir>
</d2p1:VCloudDir>
<d2p1:VMWareMaxSupportedSDK>0</d2p1:VMWareMaxSupportedSDK>
<d2p1:VMwareMaxSupportedRest>0</d2p1:VMwareMaxSupportedRest>
<d2p1:VSphereMaxSupportedSDK>0</d2p1:VSphereMaxSupportedSDK>
</config>
</UpdateConfigReq>