Net3 API Interface for Customer Portal

<back to all web services

Recovery

Requires Authentication
The following routes are available for this service:
POST/brs/linksRetrieve list of BRS links for self-service portal access.
Recovery Parameters:
NameParameterData TypeRequiredDescription
orgsbodyList<TypeOrg>No
companyIdentifiersbodyList<TypeCompanyIdentifier>No
TypeOrg Parameters:
NameParameterData TypeRequiredDescription
hrefformstringNo
idformstringNo
nameformstringNo
typeformstringNo
DatacenterLocationformDatacenterLocationsNo
modifydateformstringNo
descriptionformstringNo
createdateformstringNo
NetworksformList<TypeNetworkConfiguration>No
DatacenterLocations Enum:
GMU
SPA
LAS
DEV
VCD
AWS
GCP
UAT
AZU
AUV
ATL
TypeNetworkConfiguration Parameters:
NameParameterData TypeRequiredDescription
hrefformstringNo
idformstringNo
nameformstringNo
typeformstringNo
DescriptionformstringNo
ConfigurationformConfigurationNo
ProviderInfoformstringNo
Configuration Parameters:
NameParameterData TypeRequiredDescription
IpScopesformList<IpScope>No
FenceModeformstringNo
RetainNetInfoAcrossDeploymentsformboolNo
BackwardCompatibilityModeformboolNo
SubInterfaceformboolNo
DistributedInterfaceformboolNo
GuestVlanAllowedformboolNo
ConnectedformboolNo
DualStackNetworkformboolNo
IpScope Parameters:
NameParameterData TypeRequiredDescription
IsInheritedformboolNo
GatewayformstringNo
NetmaskformstringNo
Dns1formstringNo
Dns2formstringNo
DnsSuffixformstringNo
IsEnabledformboolNo
IpRangesformList<IpRange>No
IpRange Parameters:
NameParameterData TypeRequiredDescription
StartAddressformstringNo
EndAddressformstringNo
TypeCompanyIdentifier Parameters:
NameParameterData TypeRequiredDescription
CompanyIdentifierIdformintNo
CompanyIdformGuidNo
LocationIdformGuidNo
ApplicationIdformGuidNo
OrgNameformstringNo
OrgUserNameformstringNo
OrgIdentifierformstringNo
IsRemoteformboolNo
ApplicationNameformstringNo
CompanyNameformstringNo
LocationformstringNo
LocationTypeformstringNo
DatacenterCodeformstringNo
DatacenterNameformstringNo
CompanyNameShortformstringNo
RecoveryResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformObjectNo
ResponseStatusformResponseStatusNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /brs/links HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"orgs":[{"href":"String","id":"String","name":"String","type":"String","datacenterLocation":"GMU","modifydate":"String","description":"String","createdate":"String","networks":[{"href":"String","id":"String","name":"String","type":"String","description":"String","configuration":{"ipScopes":[{"isInherited":false,"gateway":"String","netmask":"String","dns1":"String","dns2":"String","dnsSuffix":"String","isEnabled":false,"ipRanges":[{"startAddress":"String","endAddress":"String"}]}],"fenceMode":"String","retainNetInfoAcrossDeployments":false,"backwardCompatibilityMode":false,"subInterface":false,"distributedInterface":false,"guestVlanAllowed":false,"connected":false,"dualStackNetwork":false},"providerInfo":"String"}]}],"companyIdentifiers":[{"companyIdentifierId":0,"companyId":"00000000000000000000000000000000","locationId":"00000000000000000000000000000000","applicationId":"00000000000000000000000000000000","orgName":"String","orgUserName":"String","orgIdentifier":"String","isRemote":false,"applicationName":"String","companyName":"String","location":"String","locationType":"String","datacenterCode":"String","datacenterName":"String","companyNameShort":"String"}]}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"result":{},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}