CoreStack Automation API

openapi: 3.2.0
info:
  title: CoreStack External Automation API
  version: 1.0.0
  termsOfService: http://corestack.io/
  license:
    name: CoreStack Inc License
    url: http://corestack.io/licenses/LICENSE-2.0.html
  description: Manage Templates, Scripts & Blueprints
servers:
- url: /
tags:
- name: Automation
  description: Manage Templates, Scripts & Blueprints
paths:
  /operation/automation/scripts/{tenant_id}:
    get:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScriptListResponse'
      summary: List Scripts
      description: List all the scripts. Global Scripts - All user will have access to Corestack's Marketplace Scripts (Can view and execute). Account - All users under that account will have access (Can view and execute). Only Account admins can update/delete. Tenant - Users with access to the specific tenant will have access scripts (Can view and execute). Tenant admins can update/delete. Private - User who created will only have access.
      operationId: ListScripts
      parameters:
      - name: tenant_id
        in: path
        required: true
        description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
        schema:
          type: string
      - description: 'Script types to filter. Allowed Values: chef, ansible, puppet, shell'
        in: query
        name: types
        schema:
          type: string
          enum:
          - chef
          - ansible
          - puppet
          - shell
      - description: 'Script types to filter. Allowed Values: Application, Languages, Database, Security, System, Web Server, Others'
        in: query
        name: category
        schema:
          type: string
          enum:
          - Application
          - Languages
          - Database
          - Security
          - System
          - Web Server
          - Others
      - description: Number of records to display
        name: limit
        in: query
        schema:
          type: integer
      - description: Page number
        name: page
        in: query
        schema:
          type: integer
      security:
      - auth_token: []
      tags:
      - Automation
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateScriptResponse'
      summary: Create Script
      description: Creates a new script under the tenant. However the script will be accessible based on its scope. Global Scripts - All user will have access to Corestack's Marketplace Scripts (Can view and execute). Account - All users under that account will have access (Can view and execute). Only Account admins can update/delete. Tenant - Users with access to the specific tenant will have access scripts (Can view and execute). Tenant admins can update/delete. Private - User who created will only have access.
      operationId: CreateScript
      parameters:
      - name: tenant_id
        in: path
        required: true
        description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Automation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateScriptRequest'
        required: true
  /operation/automation/scripts/{tenant_id}/execute:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Execution Initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecuteResponse'
      summary: Execute Script
      description: Execute scripts. Ansible script supports executing single script in multiple machines. Chef/Puppet/Shell executing multiple scripts against multiple target machines.
      operationId: ExecuteScript
      parameters:
      - name: tenant_id
        in: path
        required: true
        description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Automation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecuteScriptRequest'
        required: true
  /operation/automation/scripts/{tenant_id}/get/{script_job_id}:
    get:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScriptJobDataView'
      summary: Describe Script Job
      description: View script job details.
      operationId: DescribeScriptJob
      parameters:
      - name: tenant_id
        in: path
        required: true
        description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
        schema:
          type: string
      - name: script_job_id
        in: path
        required: true
        description: ID of the script_job. This can be fetched from listScriptJobs API/scriptExecute response
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Automation
  /operation/automation/scripts/{tenant_id}/jobs/list:
    get:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScriptJobListResponse'
      summary: List Script Jobs
      description: This API will list all script jobs initiated by the logged in user.
      operationId: ListScriptJobs
      parameters:
      - name: tenant_id
        in: path
        required: true
        description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
        schema:
          type: string
      - description: Number of records to display
        name: limit
        in: query
        schema:
          type: integer
      - description: Page number
        name: page
        in: query
        schema:
          type: integer
      security:
      - auth_token: []
      tags:
      - Automation
  /operation/automation/scripts/{tenant_id}/scan:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Scanned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanScriptResponse'
      summary: Scan Script
      description: 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
      operationId: ScanScript
      parameters:
      - name: tenant_id
        in: path
        required: true
        description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Automation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScriptScanRequest'
        required: true
  /operation/automation/template/{tenant_id}/get/{job_id}:
    get:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateJobUpdateResponse'
      summary: View Template Job
      description: View Template job details
      operationId: ViewTemplateJob
      parameters:
      - name: tenant_id
        in: path
        required: true
        description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
        schema:
          type: string
      - name: job_id
        in: path
        required: true
        description: ID of the template_job. This can be fetched from listTemplateJobs API response
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Automation
  /operation/automation/template/{tenant_id}/jobs/list:
    get:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateJobListResponse'
      summary: List Templates Jobs
      description: Jobs represent an instance of a Template or Script. Every time a Template or Script is executed, a Job is created. Jobs provide a reference of the execution, during and any time after it.
      operationId: ListTemplatesJobs
      parameters:
      - name: tenant_id
        in: path
        required: true
        description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
        schema:
          type: string
      - description: Number of records to display
        name: limit
        in: query
        schema:
          type: integer
      - description: Page number
        name: page
        in: query
        schema:
          type: integer
      security:
      - auth_token: []
      tags:
      - Automation
  /operation/automation/templates/{tenant_id}:
    get:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateListResponse'
      summary: List Templates
      description: List all the Templates. Global Scope - All the users will have access to view and execute CoreStack Marketplace Templates will not have access to update/delete the templates. Account Scope - All users under account scope will have access to view and execute the templates, only Account admins can update/delete the templates. Tenant Scope - Users having access to the specific tenant can view or execute templates. Tenant admins can only have the access toupdate/delete the templates. Private Scope - Templates created by the user will only have access for the templates under private scope.
      operationId: ListTemplates
      parameters:
      - name: tenant_id
        in: path
        required: true
        description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
        schema:
          type: string
      - description: DSL types to filter templates.
        in: query
        name: dsl
        schema:
          type: string
          enum:
          - arm
          - cfn
          - heat
          - mistral
          - terraform
      - description: Services to filter templates.
        in: query
        name: services
        schema:
          type: string
          enum:
          - Openstack
          - Azure(public)
          - Azure
          - Cloudstack
          - vCenter
          - AWS
          - Rackspace
          - OpenstackPublic
          - GCP
      - description: Number of records to display
        name: limit
        in: query
        schema:
          type: integer
      - description: Page number
        name: page
        in: query
        schema:
          type: integer
      security:
      - auth_token: []
      tags:
      - Automation
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateCreateResponse'
      summary: Create Template
      description: Creates a new Template under the tenant. However the script will be accessible based on its scope. Global Templates - All user will have access to CoreStack's Marketplace Templates (Can view and execute). Account - All users under that account will have access (Can view and execute). Only Account admins can update/delete. Tenant - Users with access to the specific tenant will have access template (Can view and execute). Tenant admins can update/delete. Private - User who created will only have access.
      operationId: CreateTemplate
      parameters:
      - name: tenant_id
        in: path
        required: true
        description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Automation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTemplateRequest'
        required: true
  /operation/automation/{tenant_id}/scripts/{script_id}:
    delete:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Deleted
          content:
            application/json:
              schema:
                type: boolean
      summary: Delete Script
      description: Deletes a script. Cannot undo this action, so be cautious when performing this operation. Use updateScript to make the script as inactive if required
      operationId: DeleteScript
      parameters:
      - name: tenant_id
        in: path
        required: true
        description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
        schema:
          type: string
      - name: script_id
        in: path
        required: true
        description: ID of the script. This can be fetched from listScripts API
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Automation
    get:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScriptDataView'
      summary: Describe Script
      description: This API will provide detailed information about the script.
      operationId: DescribeScript
      parameters:
      - name: tenant_id
        in: path
        required: true
        description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
        schema:
          type: string
      - name: script_id
        in: path
        required: true
        description: ID of the script. This can be fetched from listScripts API
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Automation
    put:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateScriptResponse'
      summary: Update Script
      description: Updates script details such as name, script path, dependencies etc.,
      operationId: UpdateScript
      parameters:
      - name: tenant_id
        in: path
        required: true
        description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
        schema:
          type: string
      - name: script_id
        in: path
        required: true
        description: ID of the script. This can be fetched from listScripts API
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Automation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateScriptRequest'
        required: true
  /operation/automation/{tenant_id}/templates/{template_id}:
    delete:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Removed
          content:
            application/json:
              schema:
                type: boolean
      summary: Delete Template
      description: Delete a Template which is no more required
      operationId: DeleteTemplate
      parameters:
      - name: tenant_id
        in: path
        required: true
        description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
        schema:
          type: string
      - name: template_id
        in: path
        required: true
        description: Specify the template id of the template to delete, template id is unique can be obtained from the list template api
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Automation
    get:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateViewResponse'
      summary: Describe Template
      description: Describe the already created Templates
      operationId: DescribeTemplate
      parameters:
      - name: tenant_id
        in: path
        required: true
        description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
        schema:
          type: string
      - name: template_id
        in: path
        required: true
        description: specify the template id to retrieve, which is a unique id can be obtained using list template api
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Automation
    put:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Updated
          content:
            application/json:
              schema:
                type: boolean
      summary: Update Template
      description: Update Template details if required after creation using the api, the update by a user depends on the scope of the template created check create template docs for more details on the scope
      operationId: UpdateTemplate
      parameters:
      - name: tenant_id
        in: path
        required: true
        description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
        schema:
          type: string
      - name: template_id
        in: path
        required: true
        description: Specify the template id to update which is a unique id can be retrieved using list template api
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Automation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTemplateRequest'
        required: true
  /operation/automation/{tenant_id}/templates/{template_id}/execute:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateExecuteResponse'
      summary: Execute Template
      description: Execute template will return a unique job id the status of the template can be checked  using the Job details api where you can pass the unique id generated to get the details or errors if any on execution
      operationId: ExecuteTemplate
      parameters:
      - name: tenant_id
        in: path
        required: true
        description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
        schema:
          type: string
      - name: template_id
        in: path
        required: true
        description: Specify the template id to execute, template id can be obtained from the list template api
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Automation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TemplateExecuteRequest'
        required: true
  /operation/automation/{tenant_id}/templates/{template_id}/get_params:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateGetParamsResponse'
      summary: Get Template Params
      description: Get the parameters required to execute a template
      operationId: GetTemplateParams
      parameters:
      - name: tenant_id
        in: path
        required: true
        description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
        schema:
          type: string
      - name: template_id
        in: path
        required: true
        description: Specify the template id to execute, template id can be obtained from the list template api
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Automation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TemplateGetParamsRequest'
        required: true
  /operation/automation/{tenant_id}/templates/{template_id}/validate:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateValidateResponse'
      summary: Validate Template
      description: Validates the Cloud Account and the input parameters provided for a template before executing the template
      operationId: ValidateTemplate
      parameters:
      - name: tenant_id
        in: path
        required: true
        description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
        schema:
          type: string
      - name: template_id
        in: path
        required: true
        description: Specify the template id to execute, template id can be obtained from the list template api
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Automation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TemplateValidateRequest'
        required: true
  /operations/automation/blueprints/{tenant_id}/create:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/M

# --- truncated at 32 KB (142 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/corestack/refs/heads/main/openapi/corestack-automation-api-openapi.yml