v1

latestOpenAPI 3.0.0CoreStack Inc License2026-07-248001,5071.7 MB

Automation

Scan Script

Scans a script to check if all dependencies(if any) are satisfied. This API will also return parameters available in script for chef and parameter & hosts available in the script for ansible

post/operation/automation/scripts/{tenant_id}/scan

Path parameters

tenant_idstring required

Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.

Request body

config_type'chef' | 'ansible' | 'puppet' | 'shell' required

Config type of the script

playbook_yamlstring

Playbook yaml path - mandatory for ansible scripts

Example request

{
  "config_type": "chef",
  "script_info": [
    {
      "path_type": "file"
    }
  ],
  "dependencies": [
    {
      "path_type": "file"
    }
  ]
}

Response

Scanned successfully

scanned_parametersobject required

A JSON object which contains the scanned parameters of the script.

hostsstring[] required

Hosts available in the playbook if any