Update clients

This endpoint is used to update a client.

Leave Feedback

URL

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

Sample URLs

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

Parameters

All of the fields are optional:

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.
extOrgIdStringExternal organization ID.
channel
  • id
IntegerChannel ID. To get list of available channels, access the Get Channels API.
cityStringCity name.
stateStringState name.
zipStringZip code.
nocDetails
  • id
StringNOC details. To get the list of available NOCs, access the Get Tenant NOCs API.
mobileNumberStringMobile number of client.
phoneNumberStringPhone number of client.
phoneExtensionStringPhone number extension.
rdp2swfStateBooleanA flag used that if rdp2swfState=true, converts remote console recordings to flash format.
enableCLIRecordingBooleanSet enableCLIRecording=true to enable CLI recording.
showCopyClipBoardBooleanShow Copy to Clipboard.
agentPolicies1.name2.policies
  • name
  • enable
StringName of the Agent Policy. Set enable=true to enable policies.
clientDetails
  1. businessStartHour
  2. businessStartMinute
  3. businessEndHour
  4. businessEndMin
  5. businessDayStart
  6. businessDayEnd
  7. smsVoiceNotification
  8. remoteAccess
  1. Integer
  2. Integer
  3. Integer
  4. Integer
  5. Integer
  6. String
  7. Boolean
  8. Boolean
  1. Start of the business hour. The format is 24-hour clock notation. Example: 02, 15
  2. Start of the business minute.
  3. End of the business hour. The format is 24-hour clock notation. Example: 16, 20
  4. End of the business minute.
  5. Start of the business day. Represented in numbers. Example: 2-Monday, 6-Friday
  6. End of the business day. Represented in numbers. Example: 1-Sunday, 7-Saturday
  7. Set as true to receive SMS Voice Notification .
  8. Set as true to enable remote access module .
Note: This feature is enabled for clients only if remote access module is enabled at partner level.
9. resourceDecommissionBooleanA resource can be decommissioned if you do not wish to manage the resource anymore. A resource moved into decommissioned state is not re-managed. Provide resourceDecommission: true to enable the module for a client. If you do not provide any value, the default value is false.
10. whiteListedIpsIP whitelisting is a security feature often used for limiting and controlling access only to trusted users. IP whitelisting allows you to create lists of trusted IP addresses or IP ranges from which your users can access your domains.
Example: IP addresses can be of the form [172.22.22.*] or a range [172.22.2.{0-50}].

Status code

200 OK

Sample response

{
	"name": "GEO Services",
	"extOrgId": "Ext1010",
	"address": "GEO Services, 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",
                "remoteAccess" : "true"
	},
	"agentPolicies": [{
			"id": "1",
			"name": "Servers Policy",
			"policies": [{
					"name": "PatchManagement",
					"enable": "true"
				},
				{
					"name": "sqlitedb",
					"enable": "true"
				}
			]
		},
		{
			"id": "2",
			"name": "Desktops Policy",
			"policies": [{
					"name": "PatchManagement",
					"enable": "true"
				},
				{
					"name": "sqlitedb",
					"enable": "false"
				}
			]
		},
		{
			"id": "3",
			"name": "Agent Policy",
			"policies": [{
					"name": "PatchManagement",
					"enable": "false"
				},
				{
					"name": "sqlitedb",
					"enable": "true"
				}
			]
		}
	]
}