openapi: 3.2.0
info:
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  description: LogicMonitor is a SaaS-based performance monitoring platform that provides full visibility into complex, hybrid infrastructures, offering granular performance monitoring and actionable data and insights.
  title: LogicMonitor REST Cost Optimization Recommendations API
  version: 3.0.0
servers:
- url: /santaba/rest
tags:
- name: Cost Optimization Recommendations
paths:
  /cost-optimization/recommendations:
    get:
      summary: Get recommendation list
      security:
      - LMv1: []
      x-minimum-permissions:
        Cost Optimization -> Recommendations: View
        Resources: View
      description: Retrieves a list of recommendations
      operationId: getRecommendationsList
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestCloudRecommendationV3'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: query
        name: fields
        required: false
        schema:
          type: string
      - in: query
        name: size
        description: The number of recommendations to return. Max permitted value is 500
        required: false
        schema:
          type: integer
          format: int32
          default: 50
      - in: query
        name: offset
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - in: query
        name: filter
        description: 'Filtering is available with the : (equals) operator for recommendationStatus and recommendationCategory. Only one value at a time is supported for recommendationCategory, but multiple recommendationStatuses may be filtered on with the | (OR) operator. Also, only the , (AND) relation is supported when combining multiple filters'
        required: false
        schema:
          type: string
      tags:
      - Cost Optimization Recommendations
  /cost-optimization/recommendations/categories:
    get:
      summary: Get recommendation category list
      security:
      - LMv1: []
      x-minimum-permissions:
        Note: No RBAC permissions needed
      description: Retrieves the list of recommendation categories
      operationId: getRecommendationCategoriesList
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestCloudRecommendationCategoryV3'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: query
        name: fields
        required: false
        schema:
          type: string
      - in: query
        name: size
        required: false
        schema:
          type: integer
          format: int32
          default: 50
      - in: query
        name: offset
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - in: query
        name: filter
        required: false
        schema:
          type: string
      tags:
      - Cost Optimization Recommendations
  /cost-optimization/recommendations/{id}:
    get:
      summary: Get recommendation by ID
      security:
      - LMv1: []
      x-minimum-permissions:
        Cost Optimization -> Recommendations: View
        Resources: View
      description: Retrieves a recommendation by its ID
      operationId: getRecommendationById
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestCloudRecommendationV3'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - in: path
        name: id
        description: an alphanumeric identifier composed of the recommendation's database ID, the associated resource ID, and the recommendation type, delimited with hyphens, e.g. 123-456-EBS_UNATTACHED
        required: true
        schema:
          type: string
      - in: query
        name: fields
        required: false
        schema:
          type: string
      tags:
      - Cost Optimization Recommendations
components:
  schemas:
    RestCloudRecommendationCategoryV3:
      type: object
      properties:
        name:
          description: Name of the recommendation category
          type: string
        description:
          description: Description of the recommendation category
          type: string
    RestCloudRecommendationV3:
      type: object
      properties:
        resourceDisplayName:
          description: Display name of the resource associated with the recommendation
          type: string
        resourceId:
          format: int32
          description: ID of the resource associated with the recommendation
          type: integer
        providerConsoleUrl:
          description: URL to the resource in the cloud provider's console
          type: string
        annualSavings:
          format: double
          description: Potential annual cost savings in USD
          type: number
        recommendationCategory:
          description: Recommendation category
          type: string
        createdAtMS:
          format: int64
          description: Date when the recommendation was generated, in epoch milliseconds
          type: integer
        criteria:
          description: Criteria for the recommendation
          type: string
        cloudAccountId:
          description: ID of the cloud account associated with the recommendation
          type: string
        deviceSubtype:
          description: Device subtype associated with the recommendation
          type: string
        recommendation:
          description: Recommendation details
          type: string
        recommendationId:
          format: int64
          description: Unique numerical identifier for the recommendation
          type: integer
        recommendationStatus:
          description: Status of the recommendation
          type: string
        updatedAtMS:
          format: int64
          description: Date when the recommendation was last updated, in epoch milliseconds
          type: integer
        cloudProvider:
          description: Cloud provider type associated with the recommendation
          type: string
        cloudServiceType:
          description: Cloud service type associated with the recommendation
          type: string
        id:
          description: Unique identifier for the recommendation, including the recommendation category
          type: string
    ErrorResponse:
      type: object
      properties:
        errorMessage:
          description: The error message
          readOnly: true
          type: string
        errorCode:
          format: int32
          description: The error code
          readOnly: true
          type: integer
        errorDetail:
          description: The error detail
          readOnly: true
          type: object
  securitySchemes:
    LMv1:
      in: header
      name: Authorization
      type: apiKey
externalDocs:
  description: LogicMonitor Support Docs
  url: https://www.logicmonitor.com/support/rest-api-developers-guide/