Adding Action Script targets using the API

The Action Script target can be added through the UI or the API. This topic outlines the steps for adding the target using the API. Refer to the Action Script Server topic for configuration information.

Obtaining private key string

In order to pass the private key as a string, newlines must be inserted appropriately with the \n character, as the JSON format will not preserve these required newlines. One method to insert these lines on *nix systems is the awk command. This command should follow the following format:

awk 'ORS="\\n"' path/to/keyfile > path/to/modified/keyfile

For example:

awk 'ORS="\\n"' ~/.ssh/id_rsa > /tmp/privkey.txt

You can then cat or vi/vim the file to copy the text and insert it into the API call.

Example private key file, before modification:

The same private key, after running the preceding command:

Adding Action Script targets

The TargetApiInputDTO for this target has the following parameters:

nameOrAddress

IP or FQDN of the script execution server.
port

Port used to connect to the script execution server.
userid

Username used to connect to the script execution server.
privateKeyString

Path to the SSH private token corresponding to the user used to connect to the script execution server.
manifestPath

Path to the Action Script manifest file on the script execution server.

Use the POST https://10.10.10.10/api/v3/targets request to add this target. Send the constructed TargetApiInputDTO as the body of the request.

Example Input:


{
  "category":"Orchestrator",
  "inputFields":[
    {
      "name":"nameOrAddress",
      "value":"10.10.10.10"
    },
    {
      "name":"port",
      "value":"22"
    },
    {
      "name":"userid",
      "value":"shepp"
    },
    {
      "name":"privateKeyString",
      "value":"-----BEGIN RSA PRIVATE KEY-----\nMIIJKQIBAAKCAgEAxeKUk6WLFMf8seI2KztL4DoKKw0d6AG/39SH6or5SiNbAGkM\nUmv8ABA0aCQqMF01j9V3kzGn71DIWWTxLOMBH06I01dvd9XYPVRJotGjpxus+xmV\nGbeXxJsdHfXrbtMeLnpkwGC7gIu6W2o5Ez6YuLDKf+CeFZhGMOtVLiB2NWtzn33D\nKBh96tIom9EqKseovtQAj5VYDwPeuTaWX1RGMTl1tsNGyezEc4Z2sppT4VFVhsUV\nL+voDZzrtMfFiHUIgjPH4pK9c/iPj0um7YzmyMyARftyCsUg7iUZH4NlNLpikXVy\nxKiro6Quu7SZ4kcvr3ZF3970CON0hHzC3mFsvZvRFgYKzgc8/BcZ8ZzEUFfqBqY4\ndejCU+jo86dYFL2Q8RfF2zsJenG0WbVRLtLGkc7RbMdBGjtt5roV5VAp+TyR9Hdd\nDc5FYvt4fAAMJtcmTIzdEAPSbVzDhkSajxRhOXvezJn+2Ddr34/9ZvFE7nJNgP/8\nKOGJ5H1dgG5mc7H+Ly3x5dXzPhcVNSUdNGgKnEvzFgMJaGByAg5AZc5HOmiIwFKs\nKSE/m8dSRoHrHmenGGm5TtA4lu1IMUnvCC1mKkbUEJ2V6Rl7x8zmM4DYNRSTwcSL\nSZ7U/yDuwpHwzeozNeoekGKeC23+jgyzr9/mzgmPF08q5F+wVg/7nlDRSXsCAwEA\nAQKCAgBPHMPbt25AM6gCEfcoF3/BOFMCXS8cpz5npRdlnIQHsNTb+CN1/Df2aoQZ\nMoQva8RTKbuxfEOweLJwktuc33B+bK5lF+q3lSXrdvwtfPSZhYYFqXejnXOupXjh\nloS2fO7vE/2dr86mmLY7f98ro3X5OKzsrQdmiMdfHWajl1TLDJdgJy5TpF8K91RG\n3zuleMcs66MBxGo9LoXntDwwBog9e8Rk+fMeHWt46EQiKXLpfNPdmoNa8kyGzLqr\nPsbpRCjPrRX3rkTRzYjPeCZXiGJn2uJZmCpCxgbhTrGZmLVofC+WCceFeg2M0cHh\nR1XSUjVtR7KtyvvzZcQah6p8r6SCASQFeVbb13FJVkBd0J8Hzk5e4N5Qk3bv9V4W\nF7CC8dRV66kcAkf68ytLGXkQAsgo5RPBDYSp8E2JDLF4m+9w6aouPlg//QxG5+XA\nwqGJseTipiHbiALcIGsCpc5QCqab2SNddaDtIIpnp2Zmo5E1OjutGeUAE3k+cnJ1\nJIFCkRL0vsPk0xODSXbV2PMaUjMT65ue7uBkDqCtgHiSBXTk6DiWBjduDnoZlAmC\nI8M4o42mSPs2uoKcngJ2fboY5iSsXLQ8VT5Tix8fk7VzBFmOvchBUSFlyx6o3/0l\n0SV3Qrqz7tb1Xx+axQapIUEVbLV14OkOjepvxF3HVELXRQd2eQKCAQEA8EzXro5j\nN/VgDQJ9pGphwUyQ9mNBC1c1jviAHHskh8gwa4BxhBLzZ+aUUoIx0/mAYK0rihN+\nQJLI84c9tA62Au6Tq+CT60ad4SwxQ5m9mQZjq888T3dRssmY+f+5kYBzmaPHvl8I\nSohh2tHqNh68T1KmLbCABahc0ppqJTjP0Oi0kR7XUk5gEeDNNb65oDOtuNytiVd4\ncNEq/cO8rqk2rTupLLjhVKzP9lgVXL/SBw/HBjpMyJ3DMrcPXH84JeMshJay/OnW\neY3Y+hsghw37zRxeuUtn5to0wVYayAmEhyXVing7EVV5wsyUaJQE25ZZWLjjiBHP\nZpLsSRc++uugnwKCAQEA0tBSQrDdOH+O6Ydu9Tno1IUeilTQ8+VGx3esFlKtiDTW\ncSEZSfZKbf/GQgHKbxLVXjCLhbfPbCvCcojbmGSmtWRWxlySYPSW4tBiYJSk6Fo8\nJ2hEYW3HQzyj23RjXIghCUqY5wNWj1brU4CRxHtMyV1eYJWGmTaBfDm8VoBghu9g\nFAyPkJs4WZUkUI7Sbg2vcJyLLP4XETPlfACMptLrPs8RCyUjJAJYxpSdaSjLC7r9\n9gBusQOlIGpClrx+/86NYhdKDWmnd0lyjXNvMVwPIpoSVblXTZK7xRBgcNTsd2eh\nh1HLuhLXZ76SplvtNH6MQP46WoblounEx7ONnsddpQKCAQEA1lVD339DQktLo+7/\n0CHPFZHMjueSwaHEtMQzyLORrsbBYXGMTqh0kM0aqMlV1mNpvVFYT2z5pHEIaibL\nw4mHkO/pqVnDtgwjkA9R1aEQeqg3SKysd5jOtzCXkQ0mIIC5G2X5KHUtOQWSepHX\nXPRnND1c2c3fMqysNnDiklatDgIx5Grk1ZXwnKGth+2ZNipCHmw/IQxy8fWvae8n\noYZurW9Ugv5YhaUqTOjeDP9PP1s0QvrHN/13eQnM2szicPDC6XRdK7cKxRrfWJ3P\nkobHfHh8iLuYblFc0sGRW7EZk04MvNhmnxxlYXoGOY0lFBNzl+45jEmOe0g7Fypz\n021NswKCAQAHx/6xTXvs4PByeDhFPuz0IzG8Y2MPDZBuPmGQtV6IX4LmzBT14Oxg\nYQd9WjmRnf1YK6yKs/0o/fiAZ8LLPjPVEC4Pxkz03TJQjuaCsBniJaqAvd2ARyAK\nwEtAB2y/dprZj/JS3JGuWsP24hD/UpnD+PlJ0VsVfqiK4EquWrC1alJ+ivQln0UW\nMWYUvyDPRRwLqQuODpblYKgAyrhmU/Sw7c2wPp+sbZW/Rq8Euae8+Br1oJB1YjAP\nITzx+WUqpgIb88Yc9qBiy8g5pmAdT0uTuGIi3eN2Dot1u6QDpihQQ/f3WbKOXLGs\nt6EMGOqJfH5Ky9d1jfMd70j/IgaBLNStAoIBAQCKqJNuH7FSta/KQ5fJzFrD/Mil\nQ6yfB9D92UEabBlEt22Zr7Ry5WAv4DRcYWVlHrBJQBOw4Gc5WZcEnE1HvhkX519w\nhccp1P+tyRf+h6ppYqdl/YaW2vEMTR1gvvtV8+2aMYTNRQJuTjJIsk1vWvX42IhQ\nxqKM9xqmKGEsW+6e7UheaXY8afkjf20/euGgzTuEPoy+IA8vKrSAnLLWm4xDYjMV\ni9PFbuSyRV6tJqQZxZ58dS2ykL5YpTLM+ZFyZmhAqSJWULpsKAxxE2fnmniXOYVF\nE4VxEPsgNYH1k2eqtGRQwYR0ML/fihHbJIlQnMr6o7/tKljx+3PCZeRaVR4/\n-----END RSA PRIVATE KEY-----\n"
    },
    {
      "name":"manifestPath",
      "value":"/home/shepp/action-script/manifest.json"
    }
  ],
  "type":"Action Script"
}

The API will return the TargetApiDTO for the Action Script target upon success, or an error message upon failure.

Example Response:


{
  "uuid": "73356329749216",
  "displayName": "10.10.10.10-/home/shepp/action-script/manifest.json",
  "category": "Orchestrator",
  "inputFields": [
    {
      "displayName": "Name or Address",
      "name": "nameOrAddress",
      "value": "10.10.10.10",
      "isMandatory": true,
      "isSecret": false,
      "isTargetDisplayName": false,
      "valueType": "STRING",
      "description": "IP or FQDNS for the Script Execution Server",
      "verificationRegex": ".*"
    },
    {
      "displayName": "Port",
      "name": "port",
      "value": "22",
      "defaultValue": "22",
      "isMandatory": false,
      "isSecret": false,
      "isTargetDisplayName": false,
      "valueType": "STRING",
      "description": "Port to use for the Script Execution Server",
      "verificationRegex": ".*"
    },
    {
      "displayName": "User ID",
      "name": "userid",
      "value": "shepp",
      "isMandatory": true,
      "isSecret": false,
      "isTargetDisplayName": false,
      "valueType": "STRING",
      "description": "Userid to use to execute command on the Script Execution Server",
      "verificationRegex": ".*"
    },
    {
      "displayName": "Private Token",
      "name": "privateKeyString",
      "isMandatory": true,
      "isSecret": true,
      "isTargetDisplayName": false,
      "valueType": "STRING",
      "description": "SSH Private Token corresponding to the Userid",
      "verificationRegex": ".*"
    },
    {
      "displayName": "Script Path",
      "name": "manifestPath",
      "value": "/home/shepp/action-script/manifest.json",
      "isMandatory": true,
      "isSecret": false,
      "isTargetDisplayName": false,
      "valueType": "STRING",
      "description": "File Path to the ActionScript manifest file on the Execution Server",
      "verificationRegex": ".*"
    },
    {
      "displayName": "Public Host Key",
      "name": "hostKey",
      "isMandatory": false,
      "isSecret": false,
      "isTargetDisplayName": false,
      "valueType": "STRING",
      "description": "Public key presented by the SSH server for host authenticaion; if not provided, the presented key will be accepted and integrated into the target definition for future operations",
      "verificationRegex": ".*"
    }
  ],
  "lastValidated": "2020-07-28T20:46:22Z",
  "status": "Validated",
  "type": "Action Script",
  "readonly": false
}

Response headers

 cache-control: no-cache, no-store, max-age=

Once the success response is received, the target is validated and ready for use.