CoreStack Guardrails API

openapi: 3.2.0
info:
  title: CoreStack External Guardrails 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 Policy
servers:
- url: /
tags:
- name: Guardrails
  description: Manage Policy
paths:
  /governance/guardrails/policies/batch:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '404':
          description: Not Found
          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:
                type: array
                items:
                  $ref: '#/components/schemas/PolicyDescription'
      summary: List of policy details fetched for given policy uris or policy ids
      description: 'Fetch policy details for given policy uris or policy ids. Supports a maximum of 1000 results per request

        Supports a maximum of 1000 results per request'
      operationId: BatchPoliciesUsingIds
      security:
      - auth_token: []
      tags:
      - Guardrails
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolicyRequest'
        required: true
  /governance/guardrails/policies/{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/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateScheduleResponse'
      summary: Create Policy Schedules
      description: create policy schedules
      operationId: CreatePolicySchedules
      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:
      - Guardrails
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateScheduleRequest'
        required: true
  /governance/guardrails/policies/{tenant_id}/delete/{schedule_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 Policy Schedules
      description: Delete policy schedules
      operationId: DeletePolicySchedules
      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: schedule_id
        in: path
        required: true
        description: Specify the schedule Id to fetch the schedule data
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Guardrails
  /governance/guardrails/policies/{tenant_id}/get/{schedule_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/ViewScheduleResponse'
      summary: View Policy Schedules
      description: view policy schedules
      operationId: ViewPolicySchedules
      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: schedule_id
        in: path
        required: true
        description: Specify the schedule Id to fetch the schedule data
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Guardrails
  /governance/guardrails/policies/{tenant_id}/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/ListScheduleResponse'
      summary: List Policy Schedules
      description: list policy schedules
      operationId: ListPolicySchedules
      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:
      - Guardrails
  /governance/guardrails/policies/{tenant_id}/update/{schedule_id}:
    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: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateScheduleResponse'
      summary: Update Policy Schedules
      description: update policy schedules
      operationId: UpdatePolicySchedules
      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: schedule_id
        in: path
        required: true
        description: Specify the schedule Id to fetch the schedule data
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Guardrails
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateScheduleRequest'
        required: true
  /governance/guardrails/{tenant_id}/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'
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyData'
      summary: Create Policy
      description: Creates a new policy under the tenant which will generate a unique policy id in the response this is can be used to describe details about the policy, update policy, execute or delete policy. However the policy will be accessible based on its scope  Account scope - All users under that account will have access to describe and execute. Only Account admins can update/delete. Tenant - Users with access to the specific tenant will have access scripts to describe and execute. Tenant admins can update/delete. Private - User who created will only have access.
      operationId: CreatePolicy
      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:
      - Guardrails
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePolicyRequest'
        required: true
  /governance/guardrails/{tenant_id}/policies/batch:
    post:
      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:
                type: array
                items:
                  $ref: '#/components/schemas/PolicyDescription'
      summary: List of policy details fetched for given policy uris
      description: Fetch policy details for given policy uris
      operationId: policies-batch
      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:
      - Guardrails
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolicyDescriptionRequest'
        required: true
  /governance/guardrails/{tenant_id}/policies/list:
    parameters:
    - name: tenant_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/PolicyListResponse'
      summary: List Policies
      description: List all the policies. Global Policies Scope- All user will have access to Corestack Marketplace Policies these policies cannot be updated and deleted can be only describe and executed. Account Scope:- All users under that account will have access to view and execute Only Account admins can update/delete the policies.Tenant Scope - Users with access to the specific tenant will have access to policies who can describe or execute policies. Tenant admins can  only update/delete. Private Scope - User who created will only have access
      operationId: ListPolicies
      security:
      - auth_token: []
      tags:
      - Guardrails
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolicyListRequest'
        required: true
  /governance/guardrails/{tenant_id}/policies/validate_parameters:
    post:
      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/ValidationResults'
      summary: Validate parameters for a given policy
      description: Validate a set of parameters for a given policy
      operationId: policies-validate-parameters
      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:
      - Guardrails
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolicyNamedParameterValidationRequest'
        required: true
  /governance/guardrails/{tenant_id}/policies/{policy_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 Policy
      description: Delete a policy which is no more required
      operationId: DeletePolicy
      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: policy_id
        in: path
        required: true
        description: Specify the policy id to execute, policy id can be obtained from the list policy api
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Guardrails
    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/PolicyViewResponse'
      summary: Describe Policy
      description: Describe the already created Polices
      operationId: DescribePolicy
      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: policy_id
        in: path
        required: true
        description: Specify the policy id to execute, policy id can be obtained from the list policy api
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Guardrails
    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 Policy
      description: Update Policy details if required after creation using the api, the update by a user depends on the scope of the policy created check create policy docs for more details on the scope
      operationId: UpdatePolicy
      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: policy_id
        in: path
        required: true
        description: Specify the policy id to execute, policy id can be obtained from the list policy api
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Guardrails
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePolicyRequest'
        required: true
  /governance/guardrails/{tenant_id}/policies/{policy_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/PolicyExecuteResponse'
      summary: Execute Policy
      description: Execute policy will return a unique job id the status of the policy 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: ExecutePolicy
      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: policy_id
        in: path
        required: true
        description: Specify the policy id to execute, policy id can be obtained from the list policy api
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Guardrails
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolicyExecuteRequest'
        required: true
  /governance/guardrails/{tenant_id}/policy_jobs/{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/JobExecutionDetailsResponse'
      summary: Describe Policy Job Details
      description: 'Retrieve policy job details using the unique job id, this can be used to check the status of the policy execution or any failure

        :param tenant_id:

        :param job_id:

        :return:'
      operationId: JobDetails
      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: Specify the job id to retrieve details of policy execution, job id is unique can be obtained from the execute policy response
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Guardrails
  /governance/guardrails/{tenant_id}/recommendations:
    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/PolicyRecommendationListResponse'
      summary: List Policy Recommendations
      description: Policy recommendations are the guide line to the users to solve a policy violation by executing the recommendations the this can be a instruction or a combination of multipleinstructions defined to solve a problem
      operationId: PolicyRecommendations
      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 policy id for the recommendations which is a unique id can be obtained from policy listing api
        required: true
        name: policy_id
        in: query
        schema:
          type: string
      - description: Specify the cloud account id  for the recommendation which is a unique id can be retrieved from the cloud listing api
        name: cloud_account_id
        in: query
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Guardrails
  /governance/guardrails/{tenant_id}/recommendations/{recommendation_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/PolicyRecommendationViewResponse'
      summary: Describe Policy Recommendations
      description: This is the api to view the recommendation associated with the policy and the resources which will get effected on execution of the recommendations. We can also get a idea on the actions which can be performed
      operationId: DescribePolicyRecommendations
      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: recommendation_id
        in: path
        required: true
        description: This is a unique identifier for recommendation, can be obtained from the PolicyRecommendations api response
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Guardrails
    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: Execute Policy Recommendation
      description: This is the api to execute recommendations for a policy violation, The recommended steps to resolve the violations can be executed with the help of data like action_name, resource_recommendation_id, will be available in Recommendation View API. The Recommendations can be executed with dynamic parameter which may or may not be passed in the input
      operationId: ExecuteRecommendation
      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: recommendation_id
        in: path
        required: true
        description: This is a unique identifier for recommendation, can be obtained from the PolicyRecommendations api response
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Guardrails
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecuteRecommendationRequest'
        required: true
  /v1/master_accounts/{master_account_id}/policy_configurations/{policy_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 Policy parameter configuration Master Account
      description: Delete Policy configuration parameters for a master account level
      operationId: deleteMasterAccountPolicyConfiguration
      parameters:
      - name: master_account_id
        in: path
        required: true
        description: Specify the master account id to delete the policy configuration.
        schema:
          type: string
      - name: policy_id
        in: path
        required: true
        description: Specify the policy id to delete configuration, policy id can be obtained from the list policy api
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Guardrails
    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/PolicyParameterConfiguration'
      summary: Get Policy parameter configuration Master Account
      description: Fetch the Policy parameters configuration for a master account level
      operationId: getMasterAccountPolicyConfiguration
      parameters:
      - name: master_account_id
        in: path
        required: true
        description: Specify the master account id to fetch the configuration for master account.
        schema:
          type: string
      - name: policy_id
        in: path
        required: true
        description: Specify the policy id to configure, policy id can be obtained from the list policy api
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Guardrails
    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: Updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyParameterConfiguration'
      summary: Update Policy parameter configuration Master Acco

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