v1

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

Automation

Describe Script

This API will provide detailed information about the script.

get/operation/automation/{tenant_id}/scripts/{script_id}

Path parameters

tenant_idstring required

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

script_idstring required

ID of the script. This can be fetched from listScripts API

Response

Success

script_idstring required

Unique Id of the script

script_namestring required

Name of the script

uristring required

Unique URI for script

descriptionstring required

Description about script

statusstring required

Status of the script(active/inactive). Only active scripts can be executed

categorystring[] required

Category the script belongs to the script

platformstring[] required

Platforms supported by script.

operating_systemobject[] required

OS supported by script

typestring required

Config type of the script (chef/ansible/shell/puppet)

scopestring required

Scope of the script (global/account/tenant/private)

path_typestring required

Script path type such as git/url/repository(puppet_alone)/galaxy(ansible).

playbook_pathstring required

Playbook path - available for ansible alone

playbook_namestring required

Playbook name - available for ansible alone

cookbook_pathstring required

Cookbook path - available for chef alone.

cookbook_namestring required

Cookbook path - available for chef alone

shell_script_pathstring required

Shell script path - available for shell alone

shell_script_namestring required

Shell script path - available for shell alone

module_pathstring required

Module path - available for puppet alone

module_namestring required

Module path - available for puppet alone.

parametersobject required

A JSON object which contains the parameters of the script.

created_bystring required

Name of the user who created the script.

created_atstring required

Script creation time in UTC

updated_bystring required

Name of the user who updated the script.

updated_atstring required

Script update time in UTC

Example response

{
  "category": [
    "Application"
  ],
  "platform": [
    "linux"
  ]
}