Documentation is now available for the Fall 2020 Update release!

Get script

This endpoint is used to retrieve details of the script.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/rba/categories/{categoryId}/scripts/{scriptId}

Sample URLs

https://{api-url}/api/v2/tenants/client_93/rba/categories/15/scripts/66
https://{api-url}/api/v2/tenants/msp_92/rba/categories/14/scripts/68

Status code

200 OK

Sample response

{
	"id": 73,
	"name": "Restart Apache Service",
	"description": "Restart Apache Service",
	"category": {
		"id": 28,
		"name": "CLIENT-Category"
	},
	"platforms": [
		"WINDOWS",
		"LINUX"
	],
	"parameters": [{
			"id": 94,
			"name": "Test Param - 1",
			"description": "Testing please ignore",
			"defaultValue": "10",
			"type": "REQUIRED",
			"dataType": "INTEGER"
		},
		{
			"id": 95,
			"name": "Test Param - 2",
			"description": "Testing please ignore",
			"defaultValue": "50",
			"type": "OPTIONAL",
			"dataType": "STRING"
		},
		{
			"id": 96,
			"name": "New param - 3",
			"description": "Testing please ignore",
			"defaultValue": "50",
			"type": "OPTIONAL",
			"dataType": "STRING"
		}
	],
	"executionType": "SHELL",
	"installTimeout": 50,
	"attachment": {
		"id": 0,
		"name": "apache-restart.sh",
		"contentURL": "https://localhost:8443/downloadScript.do?action=downloadAgent&fileName=apache-restart.sh&version=5.00"
	},
	"scriptVersion": "5.00",
	"registryPath": "HKEY_CURRENT_USER/Control Panel/Desktop",
	"registryValue": "dword:00000001",
	"processName": "cmd.exe",
	"serviceName": "OpsRampAgent"
}