Documentation is now available for the Fall 2020 Update release!

Create clients

This endpoint is used to create a client.

Leave Feedback

URL

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

Sample URLs

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

Parameters

FieldData TypeDescription
nameStringName of the client.
addressStringAddress of the client.
timeZoneStringCountry time zone. Opsramp supports a comprehensive list of timezones.
Example: "timeZone": "America/Los_Angeles"
countryName of the country. To view a list of countries, access the Get Countries API.
extOrgIdString(Optional) External organization ID.
channel - idInteger(Optional) Channel ID. To get list of available channels, access the Get Channels API.
cityString(Optional) City name.
stateString(Optional) State name.
zipString(Optional) Zip code.
nocDetails - idString(Optional) NOC details. To get the list of available NOCs, access the Get Tenant NOCs API.
mobileNumberString(Optional) Mobile number of client.
phoneNumberString(Optional) Phone number of client.
phoneExtensionString(Optional) Phone number extension.
rdp2swfStateBoolean(Optional) A flag used that if rdp2swfState=true, converts remote console recordings to flash format.
enableCLIRecordingBoolean(Optional) Set enableCLIRecording=true to enable CLI recording.
showCopyClipBoardBoolean(Optional) Show Copy to Clipboard.
agentPolicies1.name2.policies
  • name
  • enable
String(Optional) Name of the Agent Policy. Set enable=true to enable policies.
clientDetails : businessStartHourInteger(Optional) Start of the business hour. The format is 24-hour clock notation.
Example: 02, 15
clientDetails : businessStartMinuteInteger(Optional) Start of the business minute.
clientDetails : businessEndHourInteger(Optional) End of the business hour. The format is 24-hour clock notation.
Example: 16, 20
clientDetails : businessEndMinInteger(Optional) End of the business minute.
clientDetails : businessDayStartInteger(Optional) Start of the business day. Represented in numbers.
Example: 2-Monday, 6-Friday
clientDetails : businessDayEndInteger(Optional) End of the business day. Represented in numbers.
Example: 1-Sunday, 7-Saturday
clientDetails : services
  • id
  • technologies - id
String(Optional) List of channel services:
  • Service ID.
  • List of technologies of the given service.
clientDetails : serviceAccessDetails
  • technology : id
  • hostedManager :
    1. accessType
    2. ipAddress
    3. userName
    4. password
    5. port
    6. ipRange
String(Optional) List of Alternate Access Details.
  • technology id: Use the Get Alert Technologies API to list the available technologies.
  • hostedManager details:
    1. Access details.
    2. IP address of the hosted system.
    3. User name required to access the hosted system.
    4. Password of the user.
    5. Port number used to access the hosted system.
    6. Range of IP addresses used to access the hosted system.
clientDetails : internetSPDetails
  • name
  • plan
  • circuitId
  • memberId
  • url
  • userName
  • password
  • phone
String(Optional) Internet service provider details.
clientDetails : networkArchitectures
  • name
  • file
String(Optional)
  • Name of the file.
  • File converted to base64.
clientDetails : whiteListedIpsString(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}].

packages
  • Hybrid Discovery and Monitoring
  • Event and Incident Management
  • Remediation and Automation
Boolean(Optional) Enables packages.
addOns
  • SMS and Voice
  • Knowledgebase Management
  • OS Service Start/Stop Actions
  • Remote Access Management
  • Process Automation
  • Extended Data Retention
  • Mask Resource Identity Management
  • Event Enrichment
Boolean(Optional) Enables add ons.

Supported timezones

Timezones
Pacific/AsiaPacific/HonoluluAmerica/Anchorage
America/Los_AngelesAmerica/DenverAmerica/Chicago
America/New_YorkAmerica/Puerto_RicoAmerica/St_Johns
America/Buenos_AiresAtlantic/AzoresGMT
Europe/ParisEurope/IstanbulAfrica/Addis_Ababa
Asia/TehranAsia/YerevanAsia/Karachi
Asia/CalcuttaAsia/DaccaAsia/Saigon
Asia/ShanghaiAsia/TokyoAustralia/Darwin
Australia/SydneyPacific/GuadalcanalPacific/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",
    "whiteListedIps" : "172.22.22.*,172.22.2.[0-50]",
	"clientDetails": {
		"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=="
			}
		],
	},
	"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"
}