Endpoint
/api/v2/tenants/{tenantId}/rba/categories/{categoryId}/scripts/{scriptId}
Path Parameters
tenantId
string

Describes the client ID or msp ID of the tenant

categoryId
string

Defined category id

scriptId
string

Given script id

Responses

OK

[
  {
    "attachment": {
      "contentURL": "https://localhost:8443/downloadScript.do?action=downloadAgent\u0026fileName=apache-restart.sh\u0026version=5.00",
      "id": 0,
      "name": "apache-restart.sh"
    },
    "category": {
      "id": 28,
      "name": "CLIENT-Category"
    },
    "description": "Restart Apache Service",
    "executionType": "SHELL",
    "id": 73,
    "installTimeout": 50,
    "name": "Restart Apache Service",
    "parameters": [
      {
        "dataType": "INTEGER",
        "defaultValue": "10",
        "description": "Testing please ignore",
        "id": 94,
        "name": "Test Param - 1",
        "type": "REQUIRED"
      },
      {
        "dataType": "STRING",
        "defaultValue": "50",
        "description": "Testing please ignore",
        "id": 95,
        "name": "Test Param - 2",
        "type": "OPTIONAL"
      },
      {
        "dataType": "STRING",
        "defaultValue": "50",
        "description": "Testing please ignore",
        "id": 96,
        "name": "New param - 3",
        "type": "OPTIONAL"
      }
    ],
    "platforms": [
      "WINDOWS",
      "LINUX"
    ],
    "processName": "cmd.exe",
    "registryPath": "HKEY_CURRENT_USER/Control Panel/Desktop",
    "registryValue": "dword:00000001",
    "scriptVersion": "5.00",
    "serviceName": "OpsRampAgent"
  },
  {
    "attachment": {
      "contentURL": "https://localhost:8443/downloadScript.do?action=downloadAgent\u0026fileName=apache-restart.sh\u0026version=0.00",
      "id": 0,
      "name": "apache-restart.sh"
    },
    "category": {
      "id": 28,
      "name": "CLIENT-Category"
    },
    "description": "Restart Apache using Shell",
    "executionType": "SHELL",
    "id": 77,
    "installTimeout": 50,
    "name": "Restart Apache test",
    "parameters": [
      {
        "dataType": "INTEGER",
        "defaultValue": "10",
        "description": "Testing please ignore",
        "id": 100,
        "name": "Test Param - 1",
        "type": "REQUIRED"
      },
      {
        "dataType": "STRING",
        "defaultValue": "50",
        "description": "Testing please ignore",
        "id": 101,
        "name": "Test Param - 2",
        "type": "OPTIONAL"
      }
    ],
    "platforms": [
      "WINDOWS",
      "LINUX"
    ],
    "processName": "cmd.exe",
    "registryPath": "HKEY_CURRENT_USER/Control Panel/Desktop",
    "registryValue": "dword:00000001",
    "scriptVersion": "0.00",
    "serviceName": "OpsRampAgent"
  },
  {
    "attachment": {
      "contentURL": "https://localhost:8443/downloadScript.do?action=downloadAgent\u0026fileName=apache-restart.sh\u0026version=0.00",
      "id": 0,
      "name": "apache-restart.sh"
    },
    "category": {
      "id": 28,
      "name": "CLIENT-Category"
    },
    "description": "Restart Apache using Shell",
    "executionType": "SHELL",
    "id": 78,
    "installTimeout": 50,
    "name": "Restart Service",
    "parameters": [
      {
        "dataType": "INTEGER",
        "defaultValue": "10",
        "description": "Testing please ignore",
        "id": 102,
        "name": "Test Param - 1",
        "type": "REQUIRED"
      },
      {
        "dataType": "STRING",
        "defaultValue": "50",
        "description": "Testing please ignore",
        "id": 103,
        "name": "Test Param - 2",
        "type": "OPTIONAL"
      }
    ],
    "platforms": [
      "WINDOWS",
      "LINUX"
    ],
    "processName": "cmd.exe",
    "registryPath": "HKEY_CURRENT_USER/Control Panel/Desktop",
    "registryValue": "dword:00000001",
    "scriptVersion": "0.00",
    "serviceName": "OpsRampAgent"
  },
  {
    "attachment": {
      "contentURL": "https://localhost:8443/downloadScript.do?action=downloadAgent\u0026fileName=apache-restart.sh\u0026version=0.00",
      "id": 0,
      "name": "apache-restart.sh"
    },
    "category": {
      "id": 28,
      "name": "CLIENT-Category"
    },
    "description": "Restart Apache using Shell",
    "executionType": "SHELL",
    "id": 79,
    "installTimeout": 50,
    "name": "Restart Service shell",
    "parameters": [
      {
        "dataType": "INTEGER",
        "defaultValue": "10",
        "description": "Testing please ignore",
        "id": 104,
        "name": "Test Param - 1",
        "type": "REQUIRED"
      },
      {
        "dataType": "STRING",
        "defaultValue": "50",
        "description": "Testing please ignore",
        "id": 105,
        "name": "Test Param - 2",
        "type": "OPTIONAL"
      }
    ],
    "platforms": [
      "WINDOWS",
      "LINUX"
    ],
    "processName": "cmd.exe",
    "registryPath": "HKEY_CURRENT_USER/Control Panel/Desktop",
    "registryValue": "dword:00000001",
    "scriptVersion": "0.00",
    "serviceName": "OpsRampAgent"
  }
]
Endpoint
/api/v2/tenants/{tenantId}/rba/categories/{categoryId}/scripts/{scriptId}

To update a script:

  • Attachment files must be converted to byte stream and base64-encoded. Always include a name and file.
  • To get the list of available categories, invoke the Get Categories endpoint.

Path Parameters
tenantId
string

Describes the client ID or msp ID of the tenant

categoryId
string

Defined category id

scriptId
string

Given script id

attachment
object

attachment.file
attachment.name
description
string

executionType
string

installTimeout
boolean

name
string

parameters
array

parameters.dataType
Data Type of the parameter.
parameters.defaultValue
Default Value for the parameter.
parameters.description
Description for parameter.
parameters.name
Name of parameter.
parameters.type
Parameter is mandatory or optional.
platforms
array

processName
string

registryPath
string

registryValue
string

serviceName
string

{
  "attachment": {
    "file": "UkVTVEFSVD0iL3NiaW4vc2VydmljZSBodHRwZCByZXN0YXJ0Ig0KUEdSRVA9Ii91c3IvYmluL3BncmVwIg0KSFRUUEQ9Imh0dHBkIg0KJFBHUkVQICR7SFRUUER9DQppZiBbICQ/IC1uZSAwIF0NCnRoZW4NCiAkUkVTVEFSVA0KZmk=",
    "name": "apache-restart.sh"
  },
  "description": "Restart Apache Service",
  "executionType": "SHELL",
  "installTimeout": 50,
  "name": "Restart Apache Service",
  "parameters": [
    {
      "dataType": "INTEGER",
      "defaultValue": "10",
      "description": "Testing please ignore",
      "name": "Test Param - 1",
      "type": "REQUIRED"
    },
    {
      "dataType": "STRING",
      "defaultValue": "50",
      "description": "Testing please ignore",
      "name": "Test Param - 2",
      "type": "OPTIONAL"
    },
    {
      "dataType": "STRING",
      "defaultValue": "50",
      "description": "Testing please ignore",
      "name": "New param - 3",
      "type": "OPTIONAL"
    }
  ],
  "platforms": [
    "WINDOWS",
    "LINUX"
  ],
  "processName": "cmd.exe",
  "registryPath": "HKEY_CURRENT_USER/Control Panel/Desktop",
  "registryValue": "dword:00000001",
  "serviceName": "OpsRampAgent"
}

Responses

OK

attachment
object

attachment.contentURL
attachment.id
attachment.name
category
object

category.id
category.name
description
string

executionType
string

id
integer

installTimeout
integer

name
string

parameters
object

parameters.dataType
Data Type of the parameter.
parameters.defaultValue
Default Value for the parameter.
parameters.description
Description for parameter.
parameters.name
Name of parameter.
parameters.type
Parameter is mandatory or optional.
platforms
array

processName
string

registryPath
string

registryValue
string

scriptVersion
string

serviceName
string

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