Harness SP Inventory APIs API

openapi: 3.2.0
info:
  title: Harness SP Inventory APIs API
  version: '1.0'
  description: The Harness Software Delivery Platform uses OpenAPI Specification v3.0.
  contact:
    name: API Support
    email: contact@harness.io
    url: https://harness.io/
  x-logo:
    url: https://mma.prnewswire.com/media/779232/Harnes_logo_horizontal.jpg?p=facebook
    altText: Harness
  termsOfService: https://harness.io/terms-of-use/
servers:
- url: https://app.harness.io
  description: Harness host URL
- url: https://{vanity}
  description: Vanity URL
  variables:
    vanity:
      default: app.harness.io
security:
- x-api-key: []
tags:
- name: SP Inventory APIs
paths:
  /gateway/lw/api/accounts/{account_id}/v2/inventory/sp/list:
    post:
      tags:
      - SP Inventory APIs
      summary: List Savings Plans
      description: Retrieves a paginated list of Savings Plans with optional filtering
      operationId: ListSavingsPlans
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
        description: Account Identifier for the Entity
      - name: routingId
        in: query
        required: true
        schema:
          type: string
        description: Routing identifier for request processing
      - name: start_date
        in: query
        required: false
        schema:
          type: string
          format: date
          example: '2020-01-01'
        description: Start date for filtering Savings Plans
      - name: end_date
        in: query
        required: false
        schema:
          type: string
          format: date
          example: '2025-08-30'
        description: End date for filtering Savings Plans
      requestBody:
        description: Pagination and filtering options
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListSavingsPlansRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSavingsPlansResponse'
        '400':
          description: Invalid request parameters
  /gateway/lw/api/accounts/{account_id}/v2/inventory/sp/{spId}/detail:
    get:
      tags:
      - SP Inventory APIs
      summary: Get Savings Plan Details
      description: Retrieves detailed information about a specific Savings Plan
      operationId: GetSavingsPlanDetails
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
        description: Account Identifier for the Entity
      - name: spId
        in: path
        required: true
        schema:
          type: string
        description: Unique identifier of the Savings Plan
      - name: routingId
        in: query
        required: true
        schema:
          type: string
        description: Routing identifier for request processing
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SavingsPlanDetailsResponse'
        '400':
          description: Invalid request parameters
        '404':
          description: Savings Plan not found
  /gateway/lw/api/accounts/{account_id}/v2/filters/sp:
    get:
      tags:
      - SP Inventory APIs
      summary: Get Savings Plans Filter Options
      description: Retrieves available filter options for Savings Plans including account IDs, instance families, payment options, etc.
      operationId: GetSPFilterOptions
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
        description: Account Identifier for the Entity
      - name: routingId
        in: query
        required: true
        schema:
          type: string
        description: Routing identifier for request processing
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  ts:
                    type: integer
                    description: Response timestamp
                  success:
                    type: boolean
                    description: Indicates if the request was successful
                  errors:
                    type:
                    - string
                    - 'null'
                    description: Error details, if any
                  response:
                    $ref: '#/components/schemas/InventorySPAPIFilter'
        '400':
          description: Invalid request parameters
components:
  schemas:
    SavingsPlanDetail:
      type: object
      properties:
        account_info:
          $ref: '#/components/schemas/AccountInfo'
          description: Associated account information
        instance_family:
          type: string
          description: Instance family if applicable
        region:
          type: string
          description: Region for the Savings Plan
        platform:
          type: string
          description: Operating system platform
        type:
          type: string
          description: Type of Savings Plan
        mtd_utilization:
          type: number
          format: double
          description: Month-to-date utilization percentage
        status:
          type: string
          description: Current status of the Savings Plan
        start_date:
          type: string
          format: date-time
          description: Start date of the Savings Plan
        expiry_date:
          type: string
          format: date-time
          description: End date of the Savings Plan
        purchase_term_years:
          type: string
          description: Term length of the Savings Plan
        payment_option:
          type: string
          description: Payment option selected
        commitment:
          type: number
          format: double
          description: Hourly commitment amount
        mtd_commitment:
          type: number
          format: double
          description: Month-to-date commitment amount
        upfront_fee:
          type: number
          format: double
          description: Upfront payment amount
        hourly_cost:
          type: number
          format: double
          description: Hourly cost amount
        mtd_net_savings:
          type: number
          format: double
          description: Month-to-date net savings amount
        approval_info:
          $ref: '#/components/schemas/SPApprovalInfo'
          description: Approval information if applicable
        is_harness_managed:
          type: boolean
          description: Indicates if the Savings Plan is managed by Harness
    PaginationInput:
      type: object
      properties:
        limit:
          type: integer
          maximum: 100
          example: 20
        page:
          type: integer
          example: 1
          maximum: 100
    ListSavingsPlansResponse:
      type: object
      properties:
        ts:
          type: integer
          description: Response timestamp
        success:
          type: boolean
          description: Indicates if the request was successful
        errors:
          type:
          - string
          - 'null'
          description: Error details, if any
        response:
          $ref: '#/components/schemas/SavingsPlansDataResponse'
    SavingsPlansDataResponse:
      type: object
      properties:
        total:
          type: integer
          format: int64
          description: Total number of Savings Plans
        pages:
          type: integer
          format: int64
          description: Total number of pages
        items:
          type: array
          items:
            $ref: '#/components/schemas/SavingsPlan'
        pagination:
          $ref: '#/components/schemas/PaginationInput'
    InventorySPAPIFilter:
      type: object
      properties:
        account_ids:
          type: array
          items:
            type: string
          description: List of provider account IDs
        cloud_account_ids:
          type: array
          items:
            type: string
          description: List of cloud account IDs
        instance_families:
          type: array
          items:
            type: string
          description: List of instance families
        payment_options:
          type: array
          items:
            type: string
            enum:
            - No Upfront
            - Partial Upfront
            - All Upfront
          description: List of payment options
        terms:
          type: array
          items:
            type: number
            format: float64
          description: List of term lengths in years
        plan_types:
          type: array
          items:
            type: string
            enum:
            - ComputeSavingsPlans
            - EC2InstanceSavingsPlans
            - SageMakerSavingsPlans
          description: List of Savings Plan types
        status:
          type: array
          items:
            type: string
            enum:
            - active
            - expired
            - pending
            - retired
          description: List of statuses
        is_harness_managed:
          type:
          - boolean
          - 'null'
          description: Filter by Harness managed status
        service:
          type: string
          description: Service to filter by
        regions:
          type: array
          items:
            type: string
          description: List of regions
    ListSavingsPlansRequest:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/PaginationInput'
        filters:
          $ref: '#/components/schemas/InventorySPAPIFilter'
        sort_by:
          type: string
          description: Field to sort results by
        sort_order:
          type: string
          enum:
          - asc
          - desc
          description: Sort order direction
    AccountInfo:
      type: object
      properties:
        account_id:
          type: string
          description: Account identifier
        account_name:
          type: string
          description: Name of the account
        id:
          type: string
          description: Unique identifier (ARN) of the Savings Plan
    SPApprovalInfo:
      type: object
      properties:
        approved_by:
          type: string
          description: User who approved the Savings Plan
        approved_at:
          type: string
          description: Timestamp of approval
        status:
          type: string
          description: Current approval status
    SavingsPlanDetailsResponse:
      type: object
      properties:
        ts:
          type: integer
          description: Response timestamp
        success:
          type: boolean
          description: Indicates if the request was successful
        errors:
          type:
          - string
          - 'null'
          description: Error details, if any
        response:
          $ref: '#/components/schemas/SavingsPlanDetail'
    SavingsPlan:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the Savings Plan
        type:
          type: string
          description: Type of Savings Plan
        instance_family:
          type: string
          description: Instance family if applicable
        region:
          type: string
          description: Region for the Savings Plan
        commitment:
          type: number
          format: double
          description: Hourly commitment amount
        start_date:
          type: string
          format: date-time
          description: Start date of the Savings Plan
        expires_on:
          type: string
          format: date-time
          description: Expiration date of the Savings Plan
        status:
          type: string
          description: Current status of the Savings Plan
        is_harness_managed:
          type: boolean
          description: Indicates if the Savings Plan is managed by Harness
        payment_option:
          type: string
          description: Payment option for the Savings Plan
        plan_type:
          type: string
          description: Type of the Savings Plan
        upfront_fee:
          type: number
          format: double
          description: Upfront fee amount if applicable
  securitySchemes:
    x-api-key:
      name: x-api-key
      type: apiKey
      in: header
      description: API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.
externalDocs:
  description: Find out more about Swagger
  url: http://swagger.io
x-stoplight:
  id: oc91t4vrfnjyi
x-tagGroups:
- name: Organizations
  tags:
  - Organization
- name: Projects
  tags:
  - Org Project
  - Project
- name: Secrets
  tags:
  - Account Secret
  - Org Secret
  - Project Secret
  - Secrets
- name: Connectors
  tags:
  - Account Connector
  - Org Connector
  - Project Connector
  - Connectors
  - GoogleSecretManagerConnector
- name: Roles
  tags:
  - Account Roles
  - Organization Roles
  - Project Roles
  - Roles
- name: Resource Groups
  tags:
  - Account Resource Groups
  - Organization Resource Groups
  - Project Resource Groups
  - Filter Resource Groups
  - Harness Resource Group
  - Zendesk
- name: Role Assignments
  tags:
  - Account Role Assignments
  - Org Role Assignments
  - Project Role Assignments
  - Role Assignments
- name: Platform
  tags:
  - Access Control List
  - Account Banner
  - Account Banner
  - Account Licensed Modules
  - Account License Type
  - Account Webhooks
  - AccountSetting
  - Accounts
  - Analyze Account Access Policy
  - Analyze Organization Access Policy
  - Analyze Project Access Policy
  - ApiKey
  - Audit
  - AuditFilters
  - Authentication Settings
  - Canny
  - Devops Essentials License Data By Account
  - EULA
  - Filter
  - Harness Resource Type
  - Invite
  - IP Allowlist
  - Nextgen Ldap
  - Notification Channels
  - Notification Rules
  - OIDC
  - Oidc-Access-Token
  - Oidc-ID-Token
  - Org Webhooks
  - Permissions
  - Project Webhooks
  - Secret Managers
  - Service Account
  - Setting
  - SMTP
  - Source Code Manager
  - Token
  - User
  - User Group
  - Variables
- name: Delegate
  tags:
  - Agent mTLS Endpoint Management
  - Delegate Download Resource
  - Delegate Group Tags Resource
  - Delegate Setup Resource
  - Delegate Token Resource
- name: Pipelines
  tags:
  - Pipelines
  - Input Sets
  - Approvals
  - Pipeline Execution
  - Pipeline Dashboard
  - Pipeline Input Set
  - Pipeline
  - Pipeline Execution Details
  - Pipeline Execute
  - Pipeline Refresh
  - Pipeline data retention
  - Triggers
  - TriggersEvents
  - Webhook Triggers
  - Webhook Event Handler
  - DryRunPipeline
- name: Artifact Registry
  tags:
  - Registries
  - Artifacts
  - Docker Artifacts
  - Helm Artifacts
  - quarantine
  - Webhooks
  - Spaces
  - Replication
  - Registry V3 - Registries
  - Registry V3 - Packages
  - Registry V3 - Versions
  - Registry V3 - Files
  - Registry V3 - Metadata
  - Registry V3 - Firewall
  - Registry V3 - Transfer
- name: Database DevOps
  tags:
  - Database Schema
  - Database Instance
  - Deployed State
  - Execution Config
  - Migration State
- name: CD
  tags:
  - K8s Release Service Mapping
  - CustomDeployment
  - Environments
  - EnvironmentGroup
  - Infrastructures
  - Usage
  - File Store
  - Service Dashboard
  - ServiceOverrides
  - Rollback
  - tas
- name: Deployment Freeze
  tags:
  - Freeze CRUD
  - Freeze Evaluation
  - Freeze Schema
- name: Services
  tags:
  - Account Services
  - Org Services
  - Project Services
  - Services
- name: Rancher Infrastructures
  tags:
  - Account Rancher Infrastructure
  - Org Rancher Infrastructure
  - Project Rancher Infrastructure
- name: Templates
  tags:
  - Account Template
  - Org Template
  - Project Template
  - Templates
  - Global Templates
- name: GitOps
  tags:
  - Agents
  - Application
  - Applications
  - Certificates
  - Clusters
  - Dashboard Aggregates
  - Dashboards
  - GnuPGP Keys
  - GPG Keys
  - Hosts
  - Project mappings
  - Projects
  - Reconciler
  - Repositories
  - Repository Certificates
  - Repository credentials
  - ValidateHost
- name: GitX
  tags:
  - GitX Webhooks
  - Org Gitx Webhooks
  - Project Gitx Webhooks
- name: CACM
  tags:
  - Anomalies Ignorelist Rule
  - Anomalies
  - BI Dashboards
  - Budgets
  - Budget Groups
  - Cost Categories
  - Cloud Accounts
  - K8S Connectors Metadata
  - Notification Settings v2
  - Overview
  - Data Job Status
  - Recommendation cost settings
  - Unit Metric
  - Anomaly Comments
  - Cloud and AI cost anomaly details
  - Cloud and AI cost anomalies v2
  - Cost Details
  - Currency Preferences
  - External Data Provider
  - AiEngine
  - CACM governance cost settings
  - Governance Enforcement Recommendation APIs
  - Governance Alert
  - Governance Overview
  - Governance Recommendation APIs
  - RuleEnforcement
  - Rule Executions
  - Rule
  - Rule Sets
  - Perspectives Folders
  - Perspective Reports
  - Perspectives
  - Cost Category Jira Project Mapping
  - Recommendations Details
  - Recommendations
  - Recommendation Jira
  - Recommendation Preferences
  - Recommendation Presets
  - Recommendation Servicenow
  - Recommendation Tags
  - Recommendation Ignore List
  - AutoStopping Rules
  - AutoStopping Rules V2
  - AutoStopping Load Balancers
  - AutoStopping Fixed Schedules
  - AutoStopping Alerts
  - Commitment Orchestrator Events APIs
- name: Feature Flags
  tags:
  - API Keys
  - Feature Flags
  - Targets
  - Target Groups
  - Environment Perspectives
  - Anomalies
  - Proxy
  - Tags
- name: SRM
  tags:
  - Monitored Services
  - SLOs dashboard
  - NG SLOs
  - SLOs
  - Downtime
  - Srm Notification
- name: Internal Developer Portal - IDP
  tags:
  - Entities
  - Teams
  - CatalogCustomProperties
  - Scores
  - DataSource
  - KubernetesDataPoints
  - AggregationRules
  - AppConfig
  - PluginInfo
  - LayoutProxy
  - Kinds
  - LayoutsV3
  - LayoutsV4
- name: Environment Management - IDP
  tags:
  - Environment
  - Infrastructure
  - Instance
- name: Custom Dashboards
  tags:
  - aida
  - dashboards
  - downloads
  - embed
  - folders
- name: Policy Management
  tags:
  - dashboard
  - examples
  - policies
  - evaluate
  - evaluations
  - policysets
  - system
- name: Code
  tags:
  - repository
  - status_checks
  - pullreq
  - upload
  - webhook
  - resource
  - rules
  - labels
- name: IaCM
  tags:
  - usage
  - approvals
  - costs
  - executions
  - module-registry
  - workspaces
  - settings
  - tf-standard-backend
  - variables
- name: STO
  tags:
  - Exemptions
  - Issues
  - Scans
  - Products
  - Test Targets
  - Target Variants
- name: SEI
  tags:
  - Collection categories
  - Collections
  - Contributors
  - DORA
- name: Git Sync (deprecated)
  tags:
  - Git Branches
  - Git Full Sync
  - Git Sync Settings
  - Git Sync
  - Git Sync Errors
- name: Error Models
  tags:
  - Error Response
  - Governance Metadata
- name: Supply Chain Security
  tags:
  - integration
  - PipelineInfraConfig
  - SBOM
  - Integration Step Config
  - Delete Step Config
  - Delete Repositories
  - Pipeline Store Config
  - Evidence Vault [Beta]
- name: Release Management
  tags:
  - Release Groups
  - Releases
  - Orchestration Processes
  - Orchestration Activities
  - Orchestration Executions
  - Conflicts
  - Freeze
  - Reports
  - Uploads
- name: Resilience Testing
  tags:
  - Actions
  - Action Templates
  - Chaos Components
  - Chaos Hubs
  - ChaosGuard Conditions
  - ChaosGuard Rules
  - DR Tests
  - Experiments
  - Experiment Templates
  - Faults
  - Fault Templates
  - Chaos Infrastructure
  - Health
  - Network Maps
  - Onboarding
  - Probes
  - Probe Templates
  - Chaos Recommendations
  - Risks