Create clients

URL

POST https://{api-url}/api/v2/tenants/{varId}/clients

Sample URLs

https://{api-url}/api/v2/tenants/msp_92/clients

Parameters

Field	Data Type	Description
name	String	Name of the client.
address	String	Address of the client.
timeZone	String	Country time zone. Opsramp supports a comprehensive list of timezones. Example: "timeZone": "America/Los_Angeles"
country		Name of the country. To view a list of countries, access the Get Countries API.
extOrgId	String	(Optional) External organization ID.
channel id	Integer	(Optional) Channel ID. To get list of available channels, access the Get Channels API.
city	String	(Optional) City name.
state	String	(Optional) State name.
zip	String	(Optional) Zip code.
nocDetails id	String	(Optional) NOC details. To get the list of available NOCs, access the Get Tenant NOCs API.
mobileNumber	String	(Optional) Mobile number of client.
phoneNumber	String	(Optional) Phone number of client.
phoneExtension	String	(Optional) Phone number extension.
rdp2swfState	Boolean	(Optional) A flag used that if rdp2swfState=true, converts remote console recordings to flash format.
enableCLIRecording	Boolean	(Optional) Set enableCLIRecording=true to enable CLI recording.
showCopyClipBoard	Boolean	(Optional) Show Copy to Clipboard.
agentPolicies1.name2.policies name enable	String	(Optional) Name of the Agent Policy. Set enable=true to enable policies.
clientDetails businessStartHour businessStartMinute businessEndHour businessEndMin businessDayStart businessDayEnd smsVoiceNotification	Integer Integer Integer Integer Integer String Boolean	(Optional)The client details: Start of the business hour. The format is 24-hour clock notation. Example: 02, 15 Start of the business minute. End of the business hour. The format is 24-hour clock notation. Example: 16, 20 End of the business minute. Start of the business day. Represented in numbers. Example: 2-Monday, 6-Friday End of the business day. Represented in numbers. Example: 1-Sunday, 7-Saturday Set as true to receive SMS Voice Notification.
8. services id technologies id	String	(Optional) List of channel services: Service ID. List of technologies of the given service.
9. serviceAccessDetails technology id hostedManager accessType ipAddress userName password port ipRange	String	(Optional) List of Alternate Access Details. To get list of available technologies, use the `Get Alert Technologies` API. Access details. IP address of the hosted system. User name required to access the hosted system. Password of the user. Port number used to access the hosted system. Range of IP addresses used to access the hosted system.
10. internetSPDetails name plan circuitId memberId url userName password phone	String	(Optional) Internet service provider details.
11. networkArchitectures name file	String	(Optional) Name of the file. file converted to base64.
12. resourceDecommission	Boolean	(Optional) A resource can be decommissioned if the resource no longer needs to be managed. A resource moved into decommissioned state cannot be managed in the future. Set resourceDecommission: true to enable the module for a client. Note: If no value is provided, the default value is false.
13. remoteAccess	Boolean	(Optional) Set remoteAccess: true to enable the remote access module for a client: If you do not provide any value, the default value is the partner level property. This feature is enabled for clients only if remote access module is enabled at partner level.
14. whiteListedIps	String	(Optional) IP whitelisting is a security feature often used for limiting and controlling access to only trusted users. IP whitelisting is used to create lists of trusted IP addresses or IP ranges from which users can access your domains. Example: IP addresses can be of the form [172.22.22.*] or a range [172.22.2.{0-50}].

The supported timezones are:

Timezones
Pacific/Asia	Pacific/Honolulu	America/Anchorage
America/Los_Angeles	America/Denver	America/Chicago
America/New_York	America/Puerto_Rico	America/St_Johns
America/Buenos_Aires	Atlantic/Azores	GMT
Europe/Paris	Europe/Istanbul	Africa/Addis_Ababa
Asia/Tehran	Asia/Yerevan	Asia/Karachi
Asia/Calcutta	Asia/Dacca	Asia/Saigon
Asia/Shanghai	Asia/Tokyo	Australia/Darwin
Australia/Sydney	Pacific/Guadalcanal	Pacific/Auckland

Status code

200 OK

Sample request

{
	"name": "GEO Services",
	"extOrgId": "Ext1010",
	"address": "Parkway",
	"channel": {
		"id": "7"
	},
	"nocDetails": {
		"id": "11"
	},
	"city": "San Jose",
	"state": "California",
	"zip": "95101",
	"country": "USA",
	"rdp2swfState": "true",
	"enableCLIRecording": "true",
	"phoneNumber": "408-555-1234",
	"phoneExtension": "+1",
	"mobileNumber": "646-222-3333",
	"timeZone": "America/Los_Angeles",
	"showCopyClipBoard": "true",
	"resourceDecommission": "false",
        "whiteListedIps" : "172.22.22.*,172.22.2.[0-50]",
	"clientDetails": {
		"smsVoiceNotification": "false",
		"businessStartHour": "10",
		"businessStartMin": "00",
		"businessEndHour": "20",
		"businessEndMin": "00",
		"businessDayStart": "2",
		"businessDayEnd": "6",
		"services": [{
			"id": "1",
			"technologies": [{
					"id": "1"
				},
				{
					"id": "2"
				},
				{
					"id": "3"
				}
			]
		}],
		"serviceAccessDetails": [{
				"technology": {
					"id": "6"
				},
				"hostedManager": {
					"accessType": "SSH",
					"ipAddress": "192.168.56.121",
					"userName": "superadmin",
					"password": "change.me",
					"port": "8443",
					"ipRange": "172.21.30.* - 172.21.32.*"
				}
			},
			{
				"technology": {
					"id": "7"
				},
				"hostedManager": {
					"accessType": "RDP",
					"ipAddress": "192.168.56.121",
					"userName": "superadmin",
					"password": "change.me",
					"port": "8443",
					"ipRange": "172.21.30.* - 172.21.32.*"
				}
			}
		],
		"internetSPDetails": [{
				"name": "SP Name",
				"plan": "Monthly",
				"circuitId": "SP-01",
				"memberId": "MEM001215",
				"url": "https://spname.net.org",
				"userName": "consumer001215x",
				"phone": "408-555-2345"
			},
			{
				"name": "SP_1 Name",
				"plan": "Yearly",
				"circuitId": "SP_1-01",
				"memberId": "MEM001216",
				"url": "https://sp1.net.org",
				"userName": "consumer001216x",
				"phone": "408-555-4567"
			}
		],
		"networkArchitectures": [{
				"name": "arch-1.png",
				"file": "iVBORw0KGgoAAAANSUhEUgAAAAQAAAAEAQMAAACTPww9AAAABlBMVEX///+up58H0gfvAAAAAXRSTlMAQObYZgAAABVJREFUeF4dwAENAAAAQDDRRbc5sgADiACBp7r5nAAAAABJRU5ErkJggg=="
			},
			{
				"name": "arch-2.png",
				"file": "iVBORw0KGgoAAAANSUhEUgAAAAQAAAAEAQMAAACTPww9AAAABlBMVEX///+up58H0gfvAAAAAXRSTlMAQObYZgAAABVJREFUeF4dwAENAAAAQDDRRbc5sgADiACBp7r5nAAAAABJRU5ErkJggg=="
			}
		],
                "remoteAccess" : "true"
	},
	"agentPolicies": [{
			"name": "Servers Policy",
			"policies": [{
					"name": "PatchManagement",
					"enable": "true"
				},
				{
					"name": "sqlitedb",
					"enable": "true"
				}
			]
		},
		{
			"name": "Desktops Policy",
			"policies": [{
					"name": "PatchManagement",
					"enable": "true"
				},
				{
					"name": "sqlitedb",
					"enable": "false"
				}
			]
		},
		{
			"name": "Agent Policy",
			"policies": [{
					"name": "PatchManagement",
					"enable": "false"
				},
				{
					"name": "sqlitedb",
					"enable": "true"
				}
			]
		}
	]
	}
}

Sample response

{
	"uniqueId": "client_69883",
	"name": "GEO Services"
}