CoreStack Operations API

openapi: 3.2.0
info:
  title: CoreStack External Operations API
  version: 1.0.0
  termsOfService: http://corestack.io/
  license:
    name: CoreStack Inc License
    url: http://corestack.io/licenses/LICENSE-2.0.html
  description: Operations Pillar
servers:
- url: /
tags:
- name: Operations
  description: Operations Pillar
paths:
  /operation/posture/dashboard_summary:
    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/OperationPostureResponse'
      summary: List Operation Posture Details For Mobile Site
      description: Operation posture dashboard
      operationId: OperationPostureDashboard
      security:
      - auth_token: []
      tags:
      - Operations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OperationPostureRequest'
        required: true
  /operation/posture/dashboard_summary/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/OperationPostureResponse'
      summary: List Operation Posture Details
      description: operation posture dashboard
      operationId: ListOperationOpsPosture
      parameters:
      - description: to filter data by cloud provider or cloud account wise.By default tenant wise data displayed
        required: true
        name: filter_by
        in: query
        schema:
          type: string
          enum:
          - cloud_account
          - cloud_provider
      - description: Number of records to display
        name: limit
        in: query
        schema:
          type: integer
          default: 10
      - description: Page number
        name: page
        in: query
        schema:
          type: integer
          default: 1
      security:
      - auth_token: []
      tags:
      - Operations
  /operation/{tenant_id}/visibility/{cloud}/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/OperationVisibilityResponse'
      summary: List Operation Visibility Details
      description: operation visibility dashboard
      operationId: ListOperationOpsVisibility
      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: cloud
        in: path
        required: true
        description: Specify the cloud service name to get the visibility details
        schema:
          type: string
          enum:
          - AWS
          - GCP
          - Azure
      - description: to filter operation data count by region, resource or zone or account
        required: true
        name: filter_by
        in: query
        schema:
          type: string
          enum:
          - resource
          - region
          - resource_group
          - zone
          - account
          default: account
      - description: filter data by alerts or activity
        required: true
        name: visibility_by
        in: query
        schema:
          type: string
          enum:
          - activity
          - alerts
          - automation_failures
          default: activity
      - description: filter data by cloud account.Invalid if filter by value is account
        name: service_account_id
        in: query
        schema:
          type: string
      - description: enable this option to list the visibility data for alerts or activity or automation failures
        name: view_list
        in: query
        schema:
          type: string
          enum:
          - 'true'
          - 'false'
      - description: to list visibility by  resource. valid if view_list option is true and region/resource_group/zone should be false/empty
        name: resource
        in: query
        schema:
          type: string
      - description: to list visibility by region.valid if view_list option is true and cloud is AWS and resource/resource_group/zone should be false/empty
        name: region
        in: query
        schema:
          type: string
      - description: to list visibility by resource group. valid if view_list option is true and cloud is Azure and resource/region/zone should be false/empty
        name: resource_group
        in: query
        schema:
          type: string
      - description: to list visibility by zone.valid if view_list option is true and cloud is GCP and resource/region/resource_group should be false/empty
        name: zone
        in: query
        schema:
          type: string
      - description: Number of records to display
        name: limit
        in: query
        schema:
          type: integer
          default: 10
      - description: Page number
        name: page
        in: query
        schema:
          type: integer
          default: 1
      security:
      - auth_token: []
      tags:
      - Operations
  /operations/activity/{cloud_name}/get_resource_detail:
    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/GetResourceDetailsResponse'
      summary: Get Operations Resource Details
      description: Get the resource details for the specified cloud service name
      operationId: GetResourceDetails
      parameters:
      - name: cloud_name
        in: path
        required: true
        description: Specify the cloud service name to get the resource details. Allowed Values - AWS, Azure, GCP
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Operations
  /operations/activity/{tenant_id}/list_activity_operations:
    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/ListOperationsResponse'
      summary: List Operations Activity Details by Resource & Resource Type
      description: List the operations based on resource and resource_type specified
      operationId: ListActivityOperations
      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
      - required: true
        name: action
        in: query
        schema:
          type: string
          default: list_operations
      - description: Service by which the cloud accounts and their configurations are segregated.
        in: query
        x-cs-enum-type: CloudServiceName
        required: true
        name: service
        schema:
          type: string
          enum:
          - AWS
          - Azure
          - AzureStack
          - Azure_CSP
          - Azure_CSP-Direct
          - Azure_EA
          - Azure_MCA
          - Cloudstack
          - GCP
          - MS_VMM
          - OCI
          - Openstack
          - PrivateCloud
          - Rackspace
          - VMware
          - VMware_VCD
          - vCenter
          default: AWS
      - description: 'Resource name of the corresponding cloud service. Resource can be fetched from Get Resource Detail API '
        required: true
        name: resource
        in: query
        schema:
          type: string
      - description: Resource type of the corresponding cloud service. Resource Type can be obtained from List Operation Visibility Details
        required: true
        name: resource_type
        in: query
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Operations
  /operations/azure_patch_management/report/trigger:
    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:
                type: boolean
      summary: Azure Patch Management Report Trigger
      description: Trigger Azure Patch Management report
      operationId: AzurePatchManagementReportTrigger
      security:
      - auth_token: []
      tags:
      - Operations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AzurePatchManagementReportTriggerRequest'
        required: true
  /operations/monitoring_and_alerts/cloud_accounts/{tenant_id}/apply_template:
    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: Applied
          content:
            application/json:
              schema:
                type: boolean
      summary: Apply Operations Alert Configuration
      description: Apply Template
      operationId: ApplyTemplate
      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:
      - Operations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplyTemplateRequest'
        required: true
  /operations/monitoring_and_alerts/cloud_accounts/{tenant_id}/list_cloud_account_configurations:
    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/ListCloudAccountConfiguration'
      summary: List Operations Alert Configuration by Cloud Account
      description: List cloud account configurations
      operationId: ListCloudAccountConfigurations
      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:
      - Operations
  /operations/monitoring_and_alerts/cloud_accounts/{tenant_id}/list_cloud_account_details:
    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/GetServiceDetails'
      summary: Get Service Details For Operations Alert Configuration
      description: Get Service Details
      operationId: GetServiceDetails
      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:
      - Operations
  /operations/monitoring_and_alerts/cloud_accounts/{tenant_id}/view_applied:
    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/ViewAppliedResponse'
      summary: View Applied Operations Alert Configuration
      description: View what is applied
      operationId: ViewApplied
      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:
      - Operations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ViewAppliedRequest'
        required: true
  /operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/clone_template:
    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/CloneTemplateResponse'
      summary: Clone Operations Alert Configuration Templates
      description: Clone Template
      operationId: CloneTemplate
      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:
      - Operations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloneTemplateRequest'
        required: true
  /operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/create_template:
    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/CreateAlertTemplateResponse'
      summary: Create Operations Alert Configuration Templates
      description: Create Template
      operationId: OperationsAlertConfigurationCreateTemplate
      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:
      - Operations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAlertTemplateRequest'
        required: true
  /operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/edit_template:
    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 Operations Alert Configuration Template
      description: Edit Template
      operationId: EditTemplate
      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: Specify the monitoring_template_uri of the template which the name to be edited
        required: true
        name: monitoring_template_uri
        in: query
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Operations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditTemplateRequest'
        required: true
  /operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/edit_template_name:
    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 Operations Alert Configuration Template Name
      description: Edit Template Name
      operationId: EditTemplateName
      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: Specify the monitoring_template_uri of the template which the name to be edited
        required: true
        name: monitoring_template_uri
        in: query
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Operations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditTemplateNameRequest'
        required: true
  /operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/enable_default_template:
    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: Set
          content:
            application/json:
              schema:
                type: boolean
      summary: Set Default Options Operations Alert Configuration
      description: Option to Set Template as Default
      operationId: SetDefaultOptions
      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:
      - Operations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetDefaultRequest'
        required: true
  /operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/list_alert_templates:
    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/ListAlertTemplates'
      summary: List Operations Alert Configuration Templates
      description: List Alert templates
      operationId: ListAlertTemplates
      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:
      - Operations
  /operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/resource_metric_hierarchy_configuration:
    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/ResourceMetricHierarchyResponse'
      summary: List Operations Resource Metric Hierarchy Configuration
      description: resource metric hierarchy configuration listing
      operationId: ResourceMetricHierarchyConfiguration
      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: Specify the criticality
        required: false
        name: criticality
        in: query
        schema:
          type: string
          enum:
          - all
          - High
          - Medium
          - Low
      - description: Specify the status
        required: false
        name: status
        in: query
        schema:
          type: string
          enum:
          - all
          - configured
          - unconfigured
      - description: Specify the metric_type
        required: false
        name: metric_type
        in: query
        schema:
          type: string
          enum:
          - all
          - Availability
          - Capacity
          - Failure
          - Performance
          - Security
          - Success
          - Utilization
      security:
      - auth_token: []
      tags:
      - Operations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourceMetricHierarchyRequest'
        required: true
  /operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/view_configuration:
    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/ViewConfigurationResponse'
      summary: View Operations Configuration Details
      description: view configuration listing
      operationId: ViewConfiguration
      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: Specify the criticality
        required: true
        name: criticality
        in: query
        schema:
          type: string
          enum:
          - all
          - High
          - Medium
          - Low
          default: all
      - description: Specify the status
        required: false
        name: status
        in: query
        schema:
          type: string
          enum:
          - all
          - configured
          - unconfigured
          default: all
      - description: Specify the metric_type
        required: true
        name: metric_type
        in: query
        schema:
          type: string
          enum:
          - all
          - Availability
          - Capacity
          - Failure
          - Performance
          - Security
          - Success
          - Utilization
          default: all
      security:
      - auth_token: []
      tags:
      - Operations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ViewConfigurationRequest'
        required: true
components:
  schemas:
    OperationPostureRequest:
      properties:
        filter_by:
          type: string
          description: to filter data by cloud provider or cloud account wise or tenant.By default tenant wise data displayed
          example: cloud_account
          enum:
          - cloud_account
          - cloud_provider
          - tenant
          x-cs-enum-type: OperationPostureFilter
        tenant_ids:
          type: string
          description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
        service_name:
          type: string
          description: select the cloud account type
          example: AWS
          enum:
          - AWS
          - Azure
          - AzureStack
          - Azure_CSP
          - Azure_CSP-Direct
          - Azure_EA
          - Azure_MCA
          - Cloudstack
          - GCP
          - MS_VMM
          - OCI
          - Openstack
          - PrivateCloud
          - Rackspace
          - VMware
          - VMware_VCD
          - vCenter
          x-cs-enum-type: CloudServiceName
        limit:
          type: integer
          description: Limit
        page:
          type: integer
          description: Page
        search:
          type: string
          description: Search by account_name wise
      type: object
    GetResourceDetailsResponse:
      required:
      - data
      properties:
        data:
          type: object
          description: Resource Details
      type: object
    ViewConfigurationResponse:
      required:
      

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