STACKIT Stackitx API

openapi: 3.2.0
info:
  title: Stackitx API
  version: 2.0.0
  x-refined-note:
  - x-source differs across the merged source definitions and was not carried
  description: 'Operations tagged Stackitx across 2 of this provider''s published API definitions: stackit-pim-v2.json, stackit-pim-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://pim.api.stackit.cloud
  variables:
    region:
      default: global
tags:
- name: Stackitx
paths:
  /v2/stackitx/skus:
    get:
      description: Get all STACKIT:X SKUs data that has maturity model different than alpha.
      operationId: listSTAXSKUs
      parameters:
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/language'
      - $ref: '#/components/parameters/categoryName'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/skuName'
      - $ref: '#/components/parameters/region'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/PublicSKU'
                    type: array
                  meta:
                    $ref: '#/components/schemas/MetaInformation'
                type: object
          description: Successful response
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: List all STACKIT:X SKUs
      x-stackit-authorization:
        disabled: true
      tags:
      - Stackitx
    servers:
    - url: https://pim.api.stackit.cloud
      variables:
        region:
          default: global
  /v2/stackitx/skus/{skuId}:
    get:
      description: Retrieves a specific STACKIT:X SKU by its ID, available for general public.
      operationId: getSTAXSKU
      parameters:
      - $ref: '#/components/parameters/skuId'
      - $ref: '#/components/parameters/language'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicSKU'
          description: Successful response
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Get STACKIT:X SKU by ID
      x-stackit-authorization:
        disabled: true
      tags:
      - Stackitx
    servers:
    - url: https://pim.api.stackit.cloud
      variables:
        region:
          default: global
components:
  schemas:
    FinOpsFocus:
      properties:
        serviceCategory:
          description: FinOps Focus service category
          type: string
        serviceSubCategory:
          description: FinOps Focus service subcategory
          type: string
      type: object
    PublicDatabaseSpecificAttributes:
      properties:
        discriminator:
          type: string
        diskStoragePerNode:
          description: diskStoragePerNode
          example: '10'
          type:
          - string
          - 'null'
        flavor:
          description: Flavor
          example: c1.1
          type:
          - string
          - 'null'
        nodes:
          description: Nodes
          example: 2
          format: int64
          type:
          - integer
          - 'null'
        performanceClasses:
          description: Performance Classes
          items:
            example: ST-0039001
            type: string
          type: array
        ram:
          description: RAM (in GB)
          example: 2
          format: float
          type:
          - number
          - 'null'
        storageMaxGb:
          description: Max Storage in Gb
          example: 10
          format: int64
          type:
          - integer
          - 'null'
        storageMinGb:
          description: Min Storage in Gb
          example: 5
          format: int64
          type:
          - integer
          - 'null'
        type:
          description: Type (e.g. `single`, `replica`)
          example: Single
          type:
          - string
          - 'null'
        vCPU:
          description: Number of vCPU
          example: 1
          format: int64
          type:
          - integer
          - 'null'
      required:
      - discriminator
      type: object
    DataAndAI:
      properties:
        discriminator:
          type: string
        type:
          description: Type (e.g. `capacity`, `performance`)
          example: capacity
          type:
          - string
          - 'null'
      required:
      - discriminator
      type: object
    PublicSavingsPlan:
      properties:
        discount:
          description: Discount percentage for the savings plan
          example: 10
          format: double
          type: number
        validityPeriodInYears:
          description: Number of years the savings plan is valid
          example: 1
          format: int64
          type: integer
      type: object
    ComputeEngineGPUSpecificAttributes:
      properties:
        discriminator:
          type: string
        flavor:
          description: Flavor
          example: c1.1
          type:
          - string
          - 'null'
        hardware:
          description: Hardware
          example: Intel
          type:
          - string
          - 'null'
        metro:
          description: metro
          example: false
          type:
          - boolean
          - 'null'
        os:
          description: Operating System (e.g. `windows`, `windows-managed`)
          example: windows
          type:
          - string
          - 'null'
        ram:
          description: RAM (in GB)
          example: 2
          format: float
          type:
          - number
          - 'null'
        vCPU:
          description: Number of vCPU
          example: 1
          format: int64
          type:
          - integer
          - 'null'
      required:
      - discriminator
      type: object
    SKU:
      properties:
        categoryId:
          description: The unique identifier for the category, which is object id from the DB
          example: 5099803df3f4948bd2f98391
          type:
          - string
          - 'null'
        categoryName:
          description: Generic categorization to structure the customer's invoice transparently (e.g. `Compute Engine`, `Database`, `Storage`)
          example: Compute Engine
          type:
          - string
          - 'null'
        chargeDescription:
          description: Charge description
          example: Charge description
          type:
          - string
          - 'null'
        cpuOverprovisioning:
          description: CPU overprovisioning
          example: false
          type:
          - boolean
          - 'null'
        denominator:
          description: Conversion of the quantity value from the quantity input unit to the invoice unit.
          example: 1024
          format: float
          type: number
        deprecated:
          description: Attribute that indicates if product is deprecated or not.
          example: 'yes'
          type:
          - string
          - 'null'
        documentation:
          description: Documentation URL
          example: https://docs.stackit.cloud/stackit/en/test-0123456789.html
          type:
          - string
          - 'null'
        finOpsFocus:
          $ref: '#/components/schemas/FinOpsFocus'
        focusConsumedUnit:
          description: The unit displayed in the Focus Report.
          example: Hours
          type: string
        focusDocumentation:
          description: The documentation in the Focus Report.
          example: focus documentation example
          type:
          - string
          - 'null'
        generalProductGroup:
          description: Category designation one level below the generic designation that describes the overall product group to which all the SKUs are allocated to.
          example: Managed Windows Server
          type:
          - string
          - 'null'
        hourlyAggregation:
          description: Aggregation logic to be applied to the sent events within the metering bucket (currently 1 day)
          example: SUM
          type: string
        id:
          description: SKU ID \ Complete SAP article number with prefix. Will be shown on the invoice like this
          example: ST-01234567
          type: string
        language:
          description: Language of sku
          example: en
          type: string
        licenseName:
          description: Name of license
          example: confidential-kubernetes
          type:
          - string
          - 'null'
        maturityModelState:
          description: State of the SKU following the mandatory product‘s maturity model progress (e.g. `beta`, `ga`)
          example: beta
          type:
          - string
          - 'null'
        meteringType:
          description: Defines which type of calculation is applied. Either discrete (point-in-time) or continuously (continuous).
          example: discrete
          type: string
        metric:
          description: Metric of service
          example: CPU
          type:
          - string
          - 'null'
        name:
          description: How the line item will appear on the bill
          example: Compute Optimized Server
          type:
          - string
          - 'null'
        priceListVisibility:
          description: Attribute that indicates if PriceList is visible or not.
          example: 'yes'
          type:
          - string
          - 'null'
        prices:
          description: List of prices
          items:
            $ref: '#/components/schemas/Price'
          type: array
        productId:
          description: The unique identifier for the product, which is object id from the DB
          example: 5099803df3f4948bd2f98391
          type:
          - string
          - 'null'
        productName:
          description: Generic product (e.g. `Windows Server`, `Server Backup Management`, `Server`)
          example: Windows Server
          type:
          - string
          - 'null'
        quantityInputUnit:
          description: The unit sent in the quantity field of the Consumption API and Metering API.
          example: Bytes
          type: string
        rateType:
          description: Rate type of service
          example: flat
          type:
          - string
          - 'null'
        region:
          description: Region of sku
          example: 90
          type: string
        serviceId:
          description: List of unique service look up ids (ASCII ordered, ascending)
          items:
            type: string
          type: array
        technicalProductGroup:
          description: Technical differentiation
          example: mongodbflex
          type:
          - string
          - 'null'
        tierMaxValue:
          description: Tier max value
          example: 10
          format: int64
          type:
          - integer
          - 'null'
        tierMinValue:
          description: Tier min value
          example: 1
          format: int64
          type:
          - integer
          - 'null'
        title:
          description: Service name
          example: Compute Optimized Server
          type: string
        unit:
          description: The unit of measurement for the invoiced items, as to be displayed on the invoice.
          example: Hours
          type: string
        unitBilling:
          description: Unit billing
          example: per hour
          type: string
        validStart:
          description: Date when the current version was approved and became valid in PIM
          example: '2023-01-15T10:30:00'
          format: date-time
          type: string
        version:
          description: Number of the revision from PIM
          example: 10
          type: string
      type: object
    currencyCodes:
      description: Prices' currency code regarding ISO4217
      enum:
      - EUR
      - USD
      - GBP
      format: iso4217
      type: string
    Price:
      properties:
        currencyCode:
          $ref: '#/components/schemas/currencyCodes'
        currencySymbol:
          $ref: '#/components/schemas/currencySymbols'
        monthlyPrice:
          description: Monthly price value that is valid at request time, shown with full precision
          example: '0.0123456'
          format: decimal
          type:
          - string
          - 'null'
        priceId:
          description: Price ID
          example: testId
          type:
          - string
          - 'null'
        roundedMonthlyPrice:
          description: Used in Portal rounded to the minimal usable precision 2 digits after 0
          example: 0.00012345 -> 0.0012, 1,234556 -> 1,23
          format: decimal
          type: string
        roundedValue:
          description: Used in Portal rounded to the minimal usable precision 2 digits after 0
          example: 0.00012345 -> 0.0012, 1,234556 -> 1,23
          format: decimal
          type: string
        validFrom:
          format: date-time
          type: string
        value:
          description: Price value that is valid at request time, shown with full precision with 11 decimals
          example: '0.0012345678911'
          format: decimal
          type: string
        valueAsInt:
          description: Price as integer representation 1e11
          example: '12345678911'
          format: int64
          type: integer
      type: object
    MetaInformation:
      properties:
        nextCursor:
          description: The cursor base64 encoded is used to retrieve the next page of results
          example: eyJ1dWlkIjoiZGU3NjllMzYtM2RlOS00Y2M4hjdsbhdsiuwbnLRDl9fZ29vZ2xlLmV4YW1wbGU6InJlYWx0IiwgImNvbnNlcnZlciI6eyJhYmNk
          type: string
        pageSize:
          description: The number of items per page
          example: 10
          format: int64
          type: integer
      type: object
    Error:
      properties:
        code:
          description: HTTP status code
          format: int64
          type: integer
        details:
          description: Additional common information
          items:
            additionalProperties: true
            type: object
          type: array
        message:
          description: Error description
          type: string
      required:
      - code
      - message
      type: object
    StorageSpecificAttributes:
      properties:
        class:
          description: Storage Class type
          example: storage_premium_perf0
          type:
          - string
          - 'null'
        discriminator:
          type: string
        maxIOPerSec:
          description: Storage maxIOPerSec
          example: 100
          format: int64
          type:
          - integer
          - 'null'
        maxTroughInMB:
          description: Storage maxTroughInMB
          example: 25
          format: int64
          type:
          - integer
          - 'null'
        metro:
          description: metro
          example: true
          type:
          - boolean
          - 'null'
        storage:
          description: Storage (e.g. `image`, `postgresql`, `snapshot`, `volume`)
          example: image
          type:
          - string
          - 'null'
        type:
          description: Type (e.g. 'capacity', 'input')
          example: image
          type:
          - string
          - 'null'
      required:
      - discriminator
      type: object
    currencySymbols:
      description: Prices' currency symbol
      enum:
      - €
      - $
      example: €
      type:
      - string
      - 'null'
    ArchivingSpecificAttributes:
      properties:
        discriminator:
          type: string
        metro:
          description: metro
          example: false
          type:
          - boolean
          - 'null'
      required:
      - discriminator
      type: object
    LoggingAndMonitoringSpecificAttributes:
      properties:
        discriminator:
          type: string
        diskStoragePerNode:
          description: diskStoragePerNode
          example: '10'
          type:
          - string
          - 'null'
        metricPerMin:
          description: metricPerMin
          example: 30000
          format: int64
          type:
          - integer
          - 'null'
        nodes:
          description: Nodes
          example: 2
          format: int64
          type:
          - integer
          - 'null'
        targets:
          description: Targets
          example: 6
          format: int64
          type:
          - integer
          - 'null'
        type:
          description: Type (e.g. `single`, `replica`)
          example: Single
          type:
          - string
          - 'null'
      required:
      - discriminator
      type: object
    ConfidentialComputingSpecificAttributes:
      properties:
        discriminator:
          type: string
        flavor:
          description: Flavor
          example: c1.1
          type:
          - string
          - 'null'
        hardware:
          description: Hardware
          example: Intel
          type:
          - string
          - 'null'
        metro:
          description: metro
          example: false
          type:
          - boolean
          - 'null'
        os:
          description: Operating System (e.g. `windows`, `windows-managed`)
          example: windows
          type:
          - string
          - 'null'
        ram:
          description: RAM (in GB)
          example: 2
          format: float
          type:
          - number
          - 'null'
        vCPU:
          description: Number of vCPU
          example: 1
          format: int64
          type:
          - integer
          - 'null'
      required:
      - discriminator
      type: object
    SupportSpecificAttributes:
      properties:
        communicationChannel:
          description: Communication Channel
          example:
          - Telephone
          - Portal
          items:
            type: string
          type: array
        contractNoticePeriodInDays:
          description: Contract notice period in days
          example: 30
          format: int64
          type:
          - integer
          - 'null'
        discriminator:
          type: string
        escalationAvailabilityBCINC:
          description: Escalation availability BC INC
          example: STACKIT 24/7
          type:
          - string
          - 'null'
        escalationAvailabilityINC:
          description: Escalation availability INC
          example: STACKIT 8to18
          type:
          - string
          - 'null'
        escalationAvailabilitySR:
          description: Escalation availability for Service Requests
          example: STACKIT 8to18
          type:
          - string
          - 'null'
        escalationThresholdBCINCInMins:
          description: Escalation threshold BC INC (in minutes)
          example: 180
          format: int64
          type:
          - integer
          - 'null'
        escalationThresholdINCInMins:
          description: Escalation threshold INC (in minutes)
          example: 90
          format: int64
          type:
          - integer
          - 'null'
        escalationThresholdSRInMins:
          description: Escalation threshold for Service Requests
          example: 180
          format: int64
          type:
          - integer
          - 'null'
        finPenaltySLAVio80Pct:
          description: Financial Penalty for SLA Violation <80 (in %)
          example: 30
          format: int64
          type:
          - integer
          - 'null'
        finPenaltySLAVio90-80Pct:
          description: Financial Penalty for SLA Violation <90 - 80 (in %)
          example: 50
          format: int64
          type:
          - integer
          - 'null'
        initialRuntimeInMonths:
          description: Initial runtime in months
          example: 12
          format: int64
          type:
          - integer
          - 'null'
        leadTimeInWorkDays:
          description: Lead time in workdays
          example: 10
          format: int64
          type:
          - integer
          - 'null'
        location:
          description: Location
          example: Europe
          type:
          - string
          - 'null'
        projectNoticePeriodInWorkDays:
          description: Project notice period in workdays
          example: 7
          format: int64
          type:
          - integer
          - 'null'
        reactionTimeInMins:
          description: Reaction time (in minutes)
          example: 15
          format: int64
          type:
          - integer
          - 'null'
        repeatedRuntimeInMonths:
          description: Repeated runtime in months
          example: 12
          format: int64
          type:
          - integer
          - 'null'
        responseTimeBCINCInMins:
          description: Response time BC INC (in minutes)
          example: 120
          format: int64
          type:
          - integer
          - 'null'
        responseTimeINCInMins:
          description: Response time INC (in minutes)
          example: 30
          format: int64
          type:
          - integer
          - 'null'
        responseTimeSRInMins:
          description: Response time (in minutes) for Service Requests
          example: 480
          format: int64
          type:
          - integer
          - 'null'
        serviceHoursBCINC:
          description: Service hours BC INC
          example: STACKIT 24/7
          type:
          - string
          - 'null'
        serviceHoursINC:
          description: Service hours INC
          example: STACKIT 8to18
          type:
          - string
          - 'null'
        serviceHoursSR:
          description: Service hours for Service Requests
          example: STACKIT 8to18
          type:
          - string
          - 'null'
        slaGoalInPercentage:
          description: SLA goal in percentage
          example: 99
          format: int64
          type:
          - integer
          - 'null'
      required:
      - discriminator
      type: object
    PublicSKU:
      allOf:
      - $ref: '#/components/schemas/SKU'
      - properties:
          productSpecificAttributes:
            discriminator:
              mapping:
                Archiving: '#/components/schemas/ArchivingSpecificAttributes'
                ComputeEngine: '#/components/schemas/ComputeEngineSpecificAttributes'
                ComputeEngineGPU: '#/components/schemas/ComputeEngineGPUSpecificAttributes'
                ConfidentialComputing: '#/components/schemas/ConfidentialComputingSpecificAttributes'
                Data&AI: '#/components/schemas/DataAndAI'
                Database: '#/components/schemas/PublicDatabaseSpecificAttributes'
                DeveloperPlatform: '#/components/schemas/DeveloperPlatformSpecificAttributes'
                LoggingAndMonitoring: '#/components/schemas/LoggingAndMonitoringSpecificAttributes'
                Messaging: '#/components/schemas/MessagingSpecificAttributes'
                Network: '#/components/schemas/NetworkSpecificAttributes'
                Runtime: '#/components/schemas/RuntimeSpecificAttributes'
                Storage: '#/components/schemas/StorageSpecificAttributes'
                Support: '#/components/schemas/SupportSpecificAttributes'
              propertyName: discriminator
            oneOf:
            - $ref: '#/components/schemas/PublicDatabaseSpecificAttributes'
            - $ref: '#/components/schemas/ArchivingSpecificAttributes'
            - $ref: '#/components/schemas/ComputeEngineSpecificAttributes'
            - $ref: '#/components/schemas/ComputeEngineGPUSpecificAttributes'
            - $ref: '#/components/schemas/NetworkSpecificAttributes'
            - $ref: '#/components/schemas/MessagingSpecificAttributes'
            - $ref: '#/components/schemas/LoggingAndMonitoringSpecificAttributes'
            - $ref: '#/components/schemas/ConfidentialComputingSpecificAttributes'
            - $ref: '#/components/schemas/StorageSpecificAttributes'
            - $ref: '#/components/schemas/DataAndAI'
            - $ref: '#/components/schemas/RuntimeSpecificAttributes'
            - $ref: '#/components/schemas/SupportSpecificAttributes'
            - $ref: '#/components/schemas/DeveloperPlatformSpecificAttributes'
          savingsPlans:
            items:
              $ref: '#/components/schemas/PublicSavingsPlan'
            type: array
        required:
        - id
        - version
        - validStart
        - categoryName
        - categoryId
        - deprecated
        - documentation
        - generalProductGroup
        - maturityModelState
        - name
        - productName
        - productId
        - title
        - priceListVisibility
        - unit
        - quantityInputUnit
        - unitBilling
        - meteringType
        - focusConsumedUnit
        - hourlyAggregation
        - denominator
        - region
        - prices
        - finOpsFocus
        type: object
      type: object
    NetworkSpecificAttributes:
      properties:
        connectionLimitPerLoadBalancer:
          description: Connection limit per Load Balancer
          example: 500
          format: float
          type:
          - number
          - 'null'
        discriminator:
          type: string
        maxBandWidth:
          description: Maximum Bandwidth
          example: 100
          format: int64
          type:
          - integer
          - 'null'
        maxConnections:
          description: Maximum Connections
          example: 100
          format: int64
          type:
          - integer
          - 'null'
        planId:
          description: Plan ID
          example: ST-0039001
          type:
          - string
          - 'null'
        recordLimitPerZone:
          description: Record limit per zone
          example: 500
          format: float
          type:
          - number
          - 'null'
        type:
          description: Type (e.g. `single`, `replica`)
          example: Single
          type:
          - string
          - 'null'
      required:
      - discriminator
      type: object
    DeveloperPlatformSpecificAttributes:
      properties:
        discriminator:
          type: string
        diskStoragePerNode:
          description: diskStoragePerNode
          example: '10'
          type:
          - string
          - 'null'
        storage:
          description: Storage (e.g. `image`, `postgresql`, `snapshot`, `volume`)
          example: image
          type:
          - string
          - 'null'
        type:
          description: Type (e.g. `single`, `replica`)
          example: Single
          type:
          - string
          - 'null'
      required:
      - discriminator
      type: object
    RuntimeSpecificAttributes:
      properties:
        discriminator:
          type: string
        planId:
          description: Plan ID
          example: ST-0039001
          type:
          - string
          - 'null'
        type:
          description: Type (e.g. `single`, `replica`)
          example: Single
          type:
          - string
          - 'null'
      required:
      - discriminator
      type: object
    MessagingSpecificAttributes:
      properties:
        discriminator:
          type: string
        diskStoragePerNode:
          description: diskStoragePerNode
          example: '10'
          type:
          - string
          - 'null'
        nodes:
          description: Nodes
          example: 2
          format: int64
          type:
          - integer
          - 'null'
        ram:
          description: RAM (in GB)
          example: 2
          format: float
          type:
          - number
          - 'null'
        type:
          description: Type (e.g. `single`, `replica`)
          example: Single
          type:
          - string
          - 'null'
        vCPU:
          description: Number of vCPU
          example: 1
          format: int64
          type:
          - integer
          - 'null'
      required:
      - discriminator
      type: object
    ComputeEngineSpecificAttributes:
      properties:
        discriminator:
          type: string
        flavor:
          description: Flavor
          example: c1.1
          type:
          - string
          - 'null'
        hardware:
          description: Hardware
          example: Intel
          type:
          - string
          - 'null'
        metro:
          description: metro
          example: false
          type:
          - boolean
          - 'null'
        os:
          description: Operating System (e.g. `windows`, `windows-managed`)
          example: windows
          type:
          - string
          - 'null'
        ram:
          description: RAM (in GB)
          example: 2
          format: float
          type:
          - number
          - 'null'
        vCPU:
          description: Number of vCPU
          example: 1
          format: int64
          type:
          - integer
          - 'null'
      required:
      - discriminator
      type: object
  parameters:
    cursor:
      description: The cursor base64 encoded is used to retrieve the next page of results
      in: query
      name: cursor
      schema:
        type: string
    categoryName:
      description: The category's name to retrieve the data for
      in: query
      name: categoryName
      schema:
        type: string
    skuName:
      description: The SKU's name to retrieve the data for
      in: query
      name: skuName
      schema:
        type: string
    language:
      description: The language to retrieve the data in, available for en and de
      in: query
      name: language
      schema:
        enum:
        - en
        - de
        type: string
    productName:
      description: The product's name to retrieve the data for
      in: query
      name: productName
      schema:
        type: string
    pageSize:
      description: The number of items to retrieve per page
      in: query
      name: pageSize
      schema:
        default: 10
        format: int64
        maximum: 100
        minimum: 1
        type: integer
    region:
      description: The region to retrieve the data in
      in: query
      name: region
      schema:
        items:
          type: string
        type: array
    skuId:
      description: The unique identifier for a SKU.
      in: path
      name: skuId
      required: true
      schema:
        type: string
  responses:
    InternalServerError:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: An unexpected server common occurred
    NotFound:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: The requested resource was not found
    Forbidden:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: The authenticated user lacks permission to access this resource
    Unauthorized:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Authentication credentials are required
    BadRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: The request was invalid or malformed
x-refined-from:
- stackit-pim-v2.json
- stackit-pim-openapi.yml