CoreStack Compliance API

openapi: 3.2.0
info:
  title: CoreStack External Compliance API
  version: 1.0.0
  termsOfService: http://corestack.io/
  license:
    name: CoreStack Inc License
    url: http://corestack.io/licenses/LICENSE-2.0.html
  description: Corestack compliance Rest API
servers:
- url: /
tags:
- name: Compliance
  description: Corestack compliance Rest API
paths:
  /compliance/compliance_control_mapping/assessment_summary_by_job:
    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/ComplianceAssessmentHistorySummary'
      summary: Get compliance assessment summary by assessment job number
      description: To get the summary of compliance assessment for the given assessment job number.
      operationId: ComplianceMappingSummary
      parameters:
      - description: Specify the assessment_job_number.This can be fetched from List Compliance Control Assessment History API.
        required: true
        name: assessment_job_number
        in: query
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Compliance
  /compliance/executive_dashboard/compliance:
    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: Fetched
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SecurityDashboardComplianceStatus'
      summary: Compliance Security Dashboard Summary
      description: Security Dashboard Compliance
      operationId: SecurityDashboardByCompliance
      security:
      - auth_token: []
      tags:
      - Compliance
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecurityDashboardRequest'
        required: true
  /compliance/executive_dashboard/control_health:
    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: Fetched
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SecurityDashboardComplianceControlHealth'
      summary: Compliance Control Health by Control Categories
      description: Compliance Control Health
      operationId: ComplianceControlHealth
      security:
      - auth_token: []
      tags:
      - Compliance
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecurityDashboardRequest'
        required: true
  /compliance/executive_dashboard/risk:
    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: Fetched
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SecurityDashboardCompliance'
      summary: Compliance Risks By Cloud Accounts
      description: Compliance Risk by Cloud Accounts
      operationId: ComplianceRiskByCloudAccounts
      security:
      - auth_token: []
      tags:
      - Compliance
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecurityDashboardRequest'
        required: true
  /compliance/posture_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/AssessmentPostureSummaryResponse'
      summary: Get Compliance assessment posture Summary
      description: objective is to return the compliance assessment posture summary of all the applicable tenants
      operationId: ComplianceAssessmentPostureSummaryList
      security:
      - auth_token: []
      tags:
      - Compliance
  /compliance/{tenant_id}/assessment_history/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/AssessmentHistoryResponse'
      summary: List Compliance Control Assessment History
      description: objective is to return all of the compliance assessment triggered in the tenant
      operationId: AssessmentHistoryList
      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
          enum:
          - '10'
          - '25'
          - '50'
          - '100'
      - description: Page number
        name: page
        in: query
        schema:
          type: integer
      - description: search assessment
        required: false
        name: search
        in: query
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Compliance
  /compliance/{tenant_id}/compliance_control_mapping/get_assessment_job_details:
    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/PolicyJobExecutionStatusResponse'
      summary: List compliance control mapping, get_assessment_job_details
      description: objective is to return Policy Job execution status  for given, the tenant,assessment job number, policy id as input
      operationId: PolicyJobExecutionStatus
      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:
      - Compliance
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolicyJobExecutionStatusRequest'
        required: true
  /compliance/{tenant_id}/compliance_control_mapping/get_on_audit_entries:
    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/ComplianceMappingResponse'
      summary: List compliance control mapping, get_on_audit_entries
      description: objective is to return all of the compliance Mapping get_on_audit_entries given, the tenant,assessment job number as input
      operationId: ComplianceMapping
      parameters:
      - name: tenant_id
        in: path
        required: true
        description: 'Specify the tenant ID. This is a unique ID and can be retrieved using theList Tenants API. '
        schema:
          type: string
      - description: Specify the assessment_job_number.This can be fetched from List Compliance Control Assessment History API.
        required: true
        name: assessment_job_number
        in: query
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Compliance
  /compliance/{tenant_id}/control_mapping/on_demand_execute_control:
    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/ComplianceControlResponse'
      summary: Compliance On Demand Control_execute
      description: Compliance On Demand Control_execute
      operationId: ComplianceOnDemandControl
      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:
      - Compliance
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComplianceControlRequest'
        required: true
  /compliance/{tenant_id}/control_mapping/on_demand_execute_standard:
    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/ComplianceStandardResponse'
      summary: Compliance On Demand Standard_execute
      description: Compliance On Demand Standard_execute
      operationId: ComplianceOnDemandStandard
      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:
      - Compliance
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComplianceStandardRequest'
        required: true
  /compliance/{tenant_id}/controls/list:
    get:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControlsListResponse'
      summary: List Compliance Controls
      description: Objective is to return all of the compliance controls given, the tenant and compliance standard as input
      operationId: ListControls
      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
        required: true
        name: limit
        in: query
        schema:
          type: integer
      - description: Page number
        name: page
        in: query
        schema:
          type: integer
      - description: uri of compliance standard, This can be fetched from the compliance standards list API call.
        required: true
        name: compliance_uri
        in: query
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Compliance
  /compliance/{tenant_id}/mapping/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/ControlsListMappingResponse'
      summary: List Compliance Control Mappings
      description: objective is to return all of the compliance control mappings given, the tenant and compliance standard as input
      operationId: ListControlMappings
      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: type of data requested
        name: caller
        in: query
        schema:
          type: string
          default: control
      - description: Page number
        name: page
        in: query
        schema:
          type: integer
      - description: uri of compliance standard This can be fetched from the compliance standards list API call.
        name: compliance_uri
        in: query
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Compliance
  /compliance/{tenant_id}/standards:
    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/ComplianceStandardsResponse'
      summary: List Compliance Standards
      description: Objective is to return all of the compliance standards given, the tenant as input
      operationId: ListStandards
      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: Select the Type of Compliance Standard
        name: type
        in: query
        schema:
          type: string
          enum:
          - all
          - marketplace
          - my_standard
      - description: Select a Valid Service Type
        in: query
        x-cs-enum-type: CloudServiceName
        required: false
        name: valid_service_type
        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: Select the scope of Compliance Standard
        name: scope
        in: query
        schema:
          type: string
          enum:
          - account
          - tenant
      - description: true/false flag to fetch framework standards
        name: framework
        in: query
        schema:
          type: boolean
      security:
      - auth_token: []
      tags:
      - Compliance
  /compliance/{tenant_id}/visibility:
    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/ComplianceVisibilityResponse'
      summary: List Compliance Visibility
      description: objective is to return all of the compliance visibility given, the tenant as input
      operationId: ComplianceVisibility
      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: ID of the cloud account. This can be fetched from ListCloudAccounts API
        name: service_account_id
        in: query
        schema:
          type: string
      - description: Select a Valid Compliance Type
        name: compliance_type
        in: query
        schema:
          type: string
          enum:
          - service
          - standard
      - description: Specify the service resource type,this can be fetched from the corestack
        name: service_resource_type
        in: query
        schema:
          type: string
      - description: uri of compliance standard, This can be fetched from the compliance standards list API call.
        name: compliance_uri
        in: query
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Compliance
  /compliance_posture/detail_for_policy/{policy_id}:
    parameters:
    - name: policy_id
      in: path
      required: true
      schema:
        type: string
    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/ComplianceDetailsForPoliciesResponse'
      summary: List Compliance posture DetailsForPolicies
      description: Objective is to return all of the compliance posture DetailsForPolicies
      operationId: DetailsForPolicies
      parameters:
      - description: status of resource to filter
        name: status
        in: query
        schema:
          type: string
      - description: Allowed values:resource_type, resource_name, resource_id
        name: search
        in: query
        schema:
          type: string
      - description: Page number
        name: page
        in: query
        schema:
          type: integer
      - description: Number of records to display
        name: limit
        in: query
        schema:
          type: integer
      security:
      - auth_token: []
      tags:
      - Compliance
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComplianceDetailsForPoliciesRequest'
        required: true
  /compliance_posture/filters:
    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/ComplianceFilterResponse'
      summary: List Compliance Filter
      description: objective is to return all of the compliance Filter given, the tenant as input
      operationId: ListFilter
      security:
      - auth_token: []
      tags:
      - Compliance
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComplianceFilterRequest'
        required: true
  /compliance_posture/filters/by_policy:
    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/ComplianceFilterByPolicyResponse'
      summary: List Compliance Filter For Heatstack
      description: Objective is to return all of the compliance Filter given, the tenant as input
      operationId: CompliancePostureFilter
      parameters:
      - description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
        name: tenant_id
        in: query
        schema:
          type: string
      - description: true/false flag to get policies filter as well
        name: policy_filters
        in: query
        schema:
          type: boolean
          enum:
          - 'true'
          - 'false'
      security:
      - auth_token: []
      tags:
      - Compliance
  /compliance_posture/policy_filters:
    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/ComplianceFilterPolicyResponse'
      summary: List Compliance Filter_Policy
      description: Objective is to return all of the compliance Filter Policy given, the tenant as input
      operationId: CompliancePostureFilterPolicy
      parameters:
      - description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
        required: true
        name: tenant_id
        in: query
        schema:
          type: string
      - description: compliance standards to filter policies
        name: standards
        in: query
        schema:
          type: string
      - description: severity filter
        name: severity
        in: query
        schema:
          type: string
      - description: 'matches policy name, display_name, engine_type, severity, services, resource_type and service_resource '
        name: search
        in: query
        schema:
          type: string
      - description: Page number
        name: page
        in: query
        schema:
          type: integer
      - description: Number of records to display
        name: limit
        in: query
        schema:
          type: integer
      security:
      - auth_token: []
      tags:
      - Compliance
  /compliance_posture/summary_by_accounts:
    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/ComplianceSummary'
      summary: List compliance_posture summary_by_accounts
      description: objective is to return all of the compliance summary_by_accounts
      operationId: ComplianceSummaryByAccounts
      parameters:
      - description: Page number
        name: page
        in: query
        schema:
          type: integer
      - description: Number of records to display
        name: limit
        in: query
        schema:
          type: integer
          enum:
          - '10'
          - '25'
          - '50'
          - '100'
      - description: Allowed values:account,standard,service
        name: search
        in: query
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Compliance
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComplianceSummaryRequest'
        required: true
  /compliance_posture/summary_by_policies:
    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/ComplianceSummaryByPoliciesResponse'
      summary: List Compliance posture SummaryByPolicies
      description: Objective is to return all of the compliance posture SummaryByPolicies
      operationId: SummaryByPolicies
      parameters:
      - description: Page number
        name: page
        in: query
        schema:
          type: integer
      - description: Number of records to display
        name: limit
        in: query
        schema:
          type: integer
      - description: Allowed values:account,standard,service
        name: search
        in: query
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Compliance
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComplianceSummaryByPoliciesRequest'
        required: true
  /v1/compliance/control_mapping/cleanup_policy_data:
    post:
      responses:
        '500':
          

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