Kubex

https://docs.kubex.ai
Admin
Kubex is a cloud cost optimization platform that provides AI-powered recommendations for optimizing...
Tokens:249,673
Snippets:2,828
Trust Score:7.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get Compatible Instances with Effort Tolerance

Source: https://docs.kubex.ai/docs-api/WebHelp_Densify_API_Cloud/Content/API_Guide/CatalogMap

Fetch compatible instance types, filtered by both spend and effort tolerance. This example includes instances within 1.3 times the optimal cost and at a 'low' effort level or lower.

```http
https://<kubex_instance_name>/api/v2/systems/{{entityId}}/analysis-details?target=compatible_instances/&spendTolerance=1.3&effort_tolerance=low
```

--------------------------------

### Get Compatible Instances with Spend Tolerance

Source: https://docs.kubex.ai/docs-api/WebHelp_Densify_API_Cloud/Content/API_Guide/CatalogMap

Retrieve compatible instance types, filtered by a spend tolerance multiplier. This example shows instances costing up to 1.3 times the optimal instance type cost.

```http
https://<kubex_instance_name>/api/v2/systems/{{entityId}}/analysis-details?target=compatible_instances/&spendTolerance=1.3
```

--------------------------------

### Create One Subscription Example

Source: https://docs.kubex.ai/docs-api/WebHelp_Densify_API_Cloud/Content/API_Guide/Subscriptions/createSubscriptions

This example demonstrates how to create a single cloud subscription with detailed configuration, including webhook, tags, properties, suppressions, return structure, and schedule. Ensure all required fields are correctly populated.

```yaml
openapi: 3.0.3
info:
  title: Kubex – Subscriptions API
  version: 1.0.0
  description: >
    Create and manage subscription-based notifications for Kubex cloud and
    container recommendations.

    - `GET /subscriptions/{platformType}` lists subscriptions with filters.

    - `POST /subscriptions/{platformType}` creates **one or more** subscriptions
    (bulk add, all-or-nothing).

    - `PUT /subscriptions/{platformType}/{subscriptionRef}` replaces an existing
    subscription.

    - `DELETE /subscriptions/{platformType}` deletes **one or more**
    subscriptions.

    - `DELETE /subscriptions/{platformType}/{subscriptionRef}` deletes a single
    subscription.

    Notes:

    • `platformType` is `cloud` or `containers`; `/subscriptions` (no platform)
    behaves like `/subscriptions/cloud` for backward compatibility. 
servers:
  - url: https://{host}
    variables:
      host:
        default: api.example.com
security: []
tags:
  - name: Subscriptions
paths:
  /subscriptions/{platformType}:
    post:
      tags:
        - Subscriptions
      summary: Create subscriptions (bulk)
      description: >
        Creates a **collection** of platform-specific subscriptions in one
        request. The operation

        is committed as a whole: any creation failure rolls back the entire
        batch. Non-admin users

        are auto-assigned as `owner`; admins may create global (owner="") or
        assign any owner. 
      operationId: createSubscriptions
      parameters:
        - $ref: '#/components/parameters/platformType'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              minItems: 1
              items:
                $ref: '#/components/schemas/SubscriptionUpsert'
            examples:
              createOne:
                value:
                  - subscriptionName: My Weekly Cloud Feed
                    description: Finance BU, prod apps; weekly
                    owner: ''
                    active: 'true'
                    webhook:
                      uri: https://hooks.example/teams
                      authType: basic
                      authValue: user:pass
                    tagReferences:
                      - tagID: business_unit
                        operator: equals
                        values:
                          - Finance
                    propertyReferences:
                      - propertyID: serviceType
                        operator: equals
                        values:
                          - Virtual Machine
                    suppressionReferences:
                      - suppressionID: no-m3
                        operator: like
                        values:
                          - m3*
                        revokeBy: '1735689600000'
                    returnStructure:
                      showAliases: true
                      fields:
                        - name
                        - region
                        - currentType
                        - recommendedType
                        - savingsEstimate
                        - rptHref
                    schedule:
                      frequency: WEEKLY
                      at: '08:30'
      responses:
        '200':
          description: Created (batch result)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Subscription'
        '400':
          description: Validation/logic error; entire batch rolled back.
        '401':
          description: Authentication failed.
        '500':
          description: Server error.
components:
  parameters:
    platformType:
      name: platformType
      in: path
      required: true
      description: Technology platform (`cloud` or `containers`).
      schema:
        type: string
        enum:
          - cloud
          - containers
  schemas:
    SubscriptionUpsert:
      type: object
      properties:
        subscriptionName:
          type: string
          description: Unique per platform if global; unique per owner if private.
        owner:
          type: string
          description: >-
            "" for global (admin only) or username for private; non-admins
            default to their username. 
        description:
          type: string
        outputType:
          type: string
          enum:
            - application/json
          default: application/json
          description: Only supported output type.
        active:
          type: string
          enum:
            - 'true'
            - 'false'
          default: 'false'
          description: >-
            true=active; false=dormant (no scheduled posts; on-demand still
            available).
        webhook:

```

--------------------------------

### Terraform Map Example for Azure Recommendations

Source: https://docs.kubex.ai/docs-api/WebHelp_Densify_API_Cloud/Content/API_Guide/Analysis_Azure_Results/listAzureRecommendations

This example demonstrates the structure of a Terraform map for an Azure recommendation, showing details like provisioning ID, current and recommended instance types, and savings estimates. It is an abbreviated version.

```yaml
tfExample:
  summary: Terraform-map example (abbrev.)
  value:
    - provisioningId: vm01
      approvalType: na
      currentType: Standard_D2s_v3
      densifyPolicy: Default Azure Policy
      effortEstimate: Low
      implementationMethod: Manual
      powerState: running
      recommendationType: Downsize
      predictedUptime: '98.5'
      recommendedType: Standard_B2s
      savingsEstimate: '24.50'
      avgInstanceCountCurrent: 1
      avgInstanceCountRecommended: 1
      minGroupCurrent: 1
      minGroupRecommended: 1
      maxGroupCurrent: 1
      maxGroupRecommended: 1
```

--------------------------------

### GCP Historical Audit Request Examples

Source: https://docs.kubex.ai/docs-api/WebHelp_Densify_API_Cloud/Content/API_Guide/Analysis_GCP_Analyze/historicalAuditGcp

Provides examples for triggering a historical audit. The `audit30dDefault` example uses default offsets, while `auditCustomRange` specifies custom start and end day offsets.

```yaml
audit30dDefault:
  value:
    credential: …service-account JSON…
    projectId: pm-testing-608378
    triggerAdhocAudit: 'true'
```

```yaml
auditCustomRange:
  value:
    credential: …service-account JSON…
    projectId: pm-testing-608378
    triggerAdhocAudit: 'true'
    startDayOffset: '10'
    endDayOffset: '5'
```

--------------------------------

### OpenAPI Specification for Get Analysis Status

Source: https://docs.kubex.ai/docs-api/WebHelp_Densify_API_Cloud/Content/API_Guide/Analysis_Status/getAnalysisStatus

This OpenAPI 3.1.0 specification defines the GET /analysis/{platformType}/{platformSubType}/{analysisId}/status endpoint. It includes details on parameters, request/response schemas, and example responses for different analysis stages.

```yaml
openapi: 3.1.0
info:
  title: Kubex – Analysis Status API
  version: 1.0.0
  description: >
    GET `/analysis/{platformType}/{platformSubType}/{analysisId}/status` returns
    the current analysis stage and webhook status for an analysis (cloud or
    containers).
servers:
  - url: https://{host}
    variables:
      host:
        default: api.example.com
security: []
tags:
  - name: Analysis Status
paths:
  /analysis/{platformType}/{platformSubType}/{analysisId}/status:
    get:
      tags:
        - Analysis Status
      summary: Get analysis status
      description: |
        Returns the current status for an analysis.
        Examples in docs show AWS/Azure/GCP and Kubernetes variants.
      operationId: getAnalysisStatus
      parameters:
        - name: platformType
          in: path
          required: true
          schema:
            type: string
            enum:
              - cloud
              - containers
          description: Technology platform.
        - name: platformSubType
          in: path
          required: true
          schema:
            type: string
            enum:
              - aws
              - gcp
              - azure
              - kubernetes
          description: Vendor/subtype (depends on platformType).
        - name: analysisId
          in: path
          required: true
          schema:
            type: string
          description: Analysis GUID.
      responses:
        '200':
          description: Status payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalysisStatus'
              examples:
                completed:
                  value:
                    analysisStage: Completed
                    webHookStatus: Success
                    statusMessage: >-
                      Analysis … was last completed on Thu Jan 24 09:36:36 EST
                      2019.
        '400':
          description: Invalid parameters.
        '401':
          description: Authentication failed.
        '404':
          description: Resource not found.
        '500':
          description: Internal server error.
components:
  schemas:
    AnalysisStatus:
      type: object
      properties:
        analysisStage:
          type: string
          description: 'e.g., "Analyzing : 38% Completed", "Not analyzed", "Completed".'
        webHookStatus:
          type: string
          description: Status of last webhook POST.
        statusMessage:
          type: string
          description: Message for the analysis status.
        message:
          type: string
        status:
          type: integer
          description: 200, 400, 401, 404, 500.

```

--------------------------------

### Initial GCP Analysis Run Request

Source: https://docs.kubex.ai/docs-api/WebHelp_Densify_API_Cloud/Content/API_Guide/Analysis_GCP_Analyze/analyzeGcp

Use this example to create a connection, collect data, run analysis, and optionally send results to a webhook during the first run.

```yaml
openapi: 3.1.0
info:
  title: Kubex – GCP Analysis API
  version: 1.0.0
  description: |
    POST `/analysis/gcp/analyze`:
      - First run: creates the connection (for the given GCP service account + project),
        collects data, runs analysis, and (optionally) sends results to a webhook.
      - Re-run: runs analysis only (no data collection); can update webhook.
      - Historical audit: once-off collection of up to 30 days of past data via
        `/analysis/cloud/gcp/analyze` with offsets.
    GET `/analysis/cloud/gcp`: lists generated analyses to obtain `analysisId`.
servers:
  - url: https://{host}
    variables:
      host:
        default: api.example.com
security: []
tags:
  - name: GCP Analysis
paths:
  /analysis/gcp/analyze:
    post:
      tags:
        - GCP Analysis
      summary: Run GCP data collection+analysis, or re-run analysis
      description: >
        - **Initial run**: provide a GCP service account credential and
        `projectId`. Schedules
          nightly collection and analysis; can set `connectionName` and a `webHook`.
        - **Re-run**: call again with the same `projectId` (+ optional new
        `webHook`); does **not**
          collect data.
        - Request is rejected if collection/analysis is in progress or within
        ~30 minutes of the
          scheduled tasks.
      operationId: analyzeGcp
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GcpAnalyzeRequest'
            examples:
              initialRun:
                summary: Create connection, collect, analyze, set webhook
                value:
                  connectionName: gcp-testing
                  policyInstanceId: 583e0068-45a3-4c4e-baec-473d4daa4095
                  projectId: pm-testing-608378
                  credential:
                    type: service_account
                    project_id: engineering-183318
                    private_key_id: REDACTED
                    private_key: |-
                      -----BEGIN PRIVATE KEY-----
                      ...
                      -----END PRIVATE KEY-----
                    client_email: '[email protected]'
                    client_id: '28884131006232124'
                    auth_uri: https://accounts.google.com/o/oauth2/auth
                    token_uri: https://oauth2.googleapis.com/token
                    auth_provider_x509_cert_url: https://www.googleapis.com/oauth2/v1/certs
                    client_x509_cert_url: https://www.googleapis.com/robot/v1/metadata/x509/…
                  webHook:
                    uri: http://mywebhookserver/webhook/results
                    authType: basic
                    authValue: tester:testerpassword
              rerun:
                summary: Re-run analysis only (no collection)
                value:
                  projectId: pm-testing-608378
                  credential: …same service-account JSON as string or object…
                  webHook:
                    uri: https://example.test/webhook/results
      responses:
        '200':
          description: Accepted / analysis initiated or in progress
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyzeStatusMessage'
              examples:
                inProgress:
                  value:
                    href: Not available
                    message: Analysis in progress
                    status: 200
        '400':
          description: Invalid parameters.
        '401':
          description: Authentication failed.
        '404':
          description: Resource not found.
        '500':
          description: Internal server error.
components:
  schemas:
    GcpAnalyzeRequest:
      type: object
      properties:
        connectionName:
          type: string
          maxLength: 32
          description: Unique within GCP connections; defaults to the project ID.
        policyInstanceId:
          type: string
          description: Policy instance to use for analysis (optional, shown in example).
        projectId:
          type: string
          description: >-
            GCP project ID to analyze (required even if the credential maps to
            multiple projects).
        credential:
          $ref: '#/components/schemas/CredentialStringOrObject'
        webHook:
          $ref: '#/components/schemas/WebHook'
      required:
        - projectId
        - credential
    AnalyzeStatusMessage:
      type: object
      properties:
        href:
          type: string
          description: Link to recommendations (if available).
        message:
          type: string
        status:
          type: integer
          format: int32
          description: One of 200, 400, 401, 404, 500.
      required:
        - message

```

--------------------------------

### List AWS Analysis Systems OpenAPI Specification

Source: https://docs.kubex.ai/docs-api/WebHelp_Densify_API_Cloud/Content/API_Guide/Analysis_AWS_Systems/listAwsAnalysisSystems

OpenAPI specification for the GET /analysis/cloud/aws/{analysisId}/systems endpoint. This defines the request parameters, response structure, and provides an example of the returned data.

```yaml
openapi: 3.0.3
info:
  title: Kubex API – AWS Systems
  version: '1.0'
servers:
  - url: https://{host}/api/v2
    variables:
      host:
        default: api.example.com
security: []
paths:
  /analysis/cloud/aws/{analysisId}/systems:
    get:
      tags:
        - AWS Analysis
      summary: List all systems included in an AWS analysis
      description: >
        Returns all systems (EC2, RDS, ASG) that were part of the specified AWS
        optimization analysis. Some systems may not have recommendations; use
        `/analysis/cloud/aws/{analysisId}/results` to fetch recommendation
        details.
      operationId: listAwsAnalysisSystems
      parameters:
        - in: path
          name: analysisId
          required: true
          description: Unique reference ID of the AWS analysis.
          schema:
            type: string
      responses:
        '200':
          description: Array of system summaries.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AwsSystemSummary'
              examples:
                sample:
                  value:
                    - serviceType: EC2
                      resourceId: i-bc1037760797bc103
                      powerState: Running
                      currentType: t2.medium
                      displayName: ex-prod-ecds-216
                      entityId: 008a502d-0a1a-40d4-bb83-42413289fe1e
                      href: /systems/008a502d-0a1a-40d4-bb83-42413289fe1e
                    - serviceType: EC2
                      resourceId: i-00bc71015587bc83
                      powerState: Running
                      currentType: m4.2xlarge
                      displayName: ex-dev-abds-131
                      entityId: 0090c272-7e02-4dd5-b7f3-ad4bc225fbd2
                      href: /systems/0090c272-7e02-4dd5-b7f3-ad4bc225fbd2
        '401':
          description: Authentication failed.
        '404':
          description: Analysis not found.
        '500':
          description: Server error.
components:
  schemas:
    AwsSystemSummary:
      type: object
      properties:
        serviceType:
          type: string
          enum:
            - EC2
            - RDS
            - ASG
          description: |
            Cloud service type.
        resourceId:
          type: string
          description: Cloud provider resource identifier.
        powerState:
          type: string
          description: Power state of the instance/system.
        currentType:
          type: string
          description: Current instance type.
        displayName:
          type: string
          description: AWS-assigned system name.
        entityId:
          type: string
          description: Kubex entity ID for the system.
        href:
          type: string
          description: API href to the system resource (see `/systems`).
      required:
        - serviceType
        - resourceId
        - entityId
        - href

```

--------------------------------

### Get Individual System

Source: https://docs.kubex.ai/llms.txt

Returns configuration and attribute information for a specific system.

```APIDOC
## Get Individual System

### Description
Returns configuration and attribute information for a specific system.

### Method
GET

### Endpoint
/systems/{systemId}
```

--------------------------------

### List Azure Systems OpenAPI Specification

Source: https://docs.kubex.ai/docs-api/WebHelp_Densify_API_Cloud/Content/API_Guide/Analysis_Azure_Systems/listAzureSystems

This OpenAPI specification defines the GET endpoint for listing Azure systems within a specified analysis. It includes request parameters, response schemas, and example responses.

```yaml
openapi: 3.1.0
info:
  title: Kubex – Azure Systems API
  version: 1.0.0
  description: >
    Lists all systems (Azure Virtual Machines) included in a given Azure
    optimization analysis.

    Source: – Analysis: Azure Systems– 
servers:
  - url: https://{host}
    variables:
      host:
        default: api.example.com
security: []
tags:
  - name: Azure Analysis
paths:
  /analysis/cloud/azure/{analysisId}/systems:
    get:
      tags:
        - Azure Analysis
      summary: List systems included in an Azure analysis
      description: >
        Returns the collection of Azure systems analyzed in the specified
        analysis.

        The set of analyzed systems can be larger than the set of
        recommendations.
      operationId: listAzureSystems
      parameters:
        - name: analysisId
          in: path
          required: true
          description: Unique ID of the Azure analysis.
          schema:
            type: string
      responses:
        '200':
          description: Array of systems in the analysis
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AzureSystem'
              examples:
                sample:
                  summary: Example response (abbrev.)
                  value:
                    - serviceType: Virtual Machine
                      resourceId: st02-db-edge-695
                      powerState: Running
                      currentType: standard_a2_v2
                      displayName: st02-db-edge-695
                      entityId: 0137f635-eacd-44da-878f-a4482166f9c1
                      href: /systems/0137f635-eacd-44da-878f-a4482166f9c1
                    - serviceType: Virtual Machine
                      resourceId: st01-io-asop-216
                      powerState: Running
                      currentType: standard_d1_v2
                      displayName: st01-io-asop-216
                      entityId: 065c44d5-040a-4392-9d08-5f581bedb401
                      href: /systems/065c44d5-040a-4392-9d08-5f581bedb401
        '401':
          description: Authentication failed.
        '404':
          description: Analysis not found.
        '500':
          description: Server error.
components:
  schemas:
    AzureSystem:
      type: object
      description: System (VM) included in the Azure analysis.
      properties:
        serviceType:
          type: string
          description: Cloud service type (e.g., "Virtual Machine").
        resourceId:
          type: string
          description: Azure unique identifier for the VM.
        powerState:
          type: string
          description: Current power state of the VM.
        currentType:
          type: string
          description: Current VM size/type.
        displayName:
          type: string
          description: Display name of the VM (same as resourceId for Azure VMs).
        entityId:
          type: string
          description: Kubex entity ID of the system.
        href:
          type: string
          description: Link to the /systems/{entityId} resource for this system.
      required:
        - serviceType
        - resourceId
        - currentType
        - displayName
        - entityId
        - href

```

--------------------------------

### Initiate Azure Analysis - Initial Run

Source: https://docs.kubex.ai/docs-api/WebHelp_Densify_API_Cloud/Content/API_Guide/Analysis_Azure_Analyze/analyzeAzure

Use this payload to schedule nightly data collection and analysis for a new Azure subscription. Ensure all required credentials and connection details are provided.

```json
{
  "subscriptionId": "cc377154-9605-4cb0-8b41-1b39e1c4ac0f",
  "applicationId": "bd6529bf-85d8-410d-a207-ce963b4dd398",
  "secretKey": "REDACTED",
  "tenantId": "6c9190a7-bca6-4fcd-b35e-36378aadc695",
  "connectionName": "AzureEnvTest",
  "webHook": {
    "uri": "https://example.test/webhook/results",
    "authType": "basic",
    "authValue": "user:pass"
  }
}
```

--------------------------------

### EC2 Instance Recommendation Example

Source: https://docs.kubex.ai/docs-api/WebHelp_Densify_API_Cloud/Content/API_Guide/Analysis_AWS_Results/getAwsRecommendations

This JSON object details a recommendation for an EC2 instance, including current and recommended types, cost estimates, and uptime predictions. It is useful for understanding individual resource optimization opportunities.

```json
{
  "entityId": "49fb3629-1f2b-4039-b146-918eb8009184",
  "resourceId": "i-06d390ca1a0c59d95",
  "accountIdRef": "209726931496",
  "region": "us-east-1",
  "currentType": "t3.micro",
  "recommendationType": "Upsize",
  "recommendedType": "t3.small",
  "implementationMethod": "Manual",
  "predictedUptime": 92.29,
  "totalHoursRunning": 1329,
  "name": "SQL Express",
  "rptHref": ">-                        /systems/49fb3629-1f2b-4039-b146-918eb8009184/analysis-report",
  "approvalType": "na",
  "densifyPolicy": "Initial Assessment",
  "savingsEstimate": -5.4850235,
  "effortEstimate": "Very Low",
  "powerState": "Running",
  "recommendedHostEntityId": "9a67bfc4-7d30-4e75-9c4d-1ca501b0c4fd",
  "serviceType": "EC2",
  "currentCost": 14.31,
  "recommendedCost": 28.62,
  "currentHourlyRate": 0.02,
  "recommendedHourlyRate": 0.04,
  "currentRiCoverage": 0,
  "recommFirstSeen": 1579680587657,
  "recommLastSeen": 1589008760293,
  "recommSeenCount": 24,
  "auditInfo": {
    "dataCollection": {
      "dateFirstAudited": 1571949272133,
      "dateLastAudited": 1588997132907,
      "auditCount": 103
    },
    "workloadDataLast30": {
      "firstDate": 1687009600000,
      "lastDate": 1688910400000,
      "totalDays": 23,
      "seenDays": 7
    }
  },
  "dataQuality": [
    {
      "workloadName": "CPU Utilization",
      "firstSeen": 1666705600000,
      "lastSeen": 1688910400000,
      "completeDays": 161,
      "partialDays": 0
    }
  ]
}
```

--------------------------------

### Start CloudWatch Agent

Source: https://docs.kubex.ai/docs/WebHelp_Densify_Cloud/Content/Data_Collection_for_Public_Cloud_Systems/AWS_Data_Collection_Prerequisites_for_an_IAM_Role__CloudWatch_only_

This command starts the CloudWatch Agent service after configuration. It is essential for metrics collection to begin.

```bash
sudo /opt/aws/amazon-cloudwatch-agent/bin/start-amazon-cloudwatch-agent
```

--------------------------------

### Install NVIDIA CUDA Toolkit on Ubuntu

Source: https://docs.kubex.ai/docs/WebHelp_Densify_Cloud/Content/Data_Collection_for_Public_Cloud_Systems/AWS_Data_Collection_Prerequisites_for_an_IAM_Role__CloudWatch_only_

Use this command to install the NVIDIA CUDA Toolkit on Ubuntu systems. This is required for gathering GPU metrics.

```bash
sudo apt-get update
sudo apt-get install -y nvidia-cuda-toolkit
```

--------------------------------

### Filtering a List for Host Systems

Source: https://docs.kubex.ai/docs-api/WebHelp_Densify_API_Cloud/Content/API_Guide/Common_Operations

This example demonstrates how to filter a collection of systems to retrieve only those of type 'host'. It shows the request format and a sample JSON response.

```APIDOC
## GET /systems/?type=host

### Description
Filters a collection of systems to return only those of a specific type.

### Method
GET

### Endpoint
/<resource object>/?<element>=<value>

### Parameters
#### Query Parameters
- **type** (string) - Required - The type of system to filter by.

### Request Example
```
GET /systems/?type=host
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the system.
- **name** (string) - The name of the system.
- **href** (string) - The self-referential URL for the system.
- **resource_id** (string) - The resource identifier.
- **type** (string) - The type of the system.
- **platform_model** (string) - The platform model of the system.

#### Response Example
```json
[
  {
    "id": "844608bd-2e6a-4201-a9f2-edb4b84389bc",
    "name": "esx-host-82",
    "href": "/systems/844608bd-2e6a-4201-a9f2-edb4b84389bc",
    "resource_id": "ac-59d7-339",
    "type": "host",
    "platform_model": "PowerEdge M610",
    ...
  }
]
```
```

--------------------------------

### Example Request Body for Modifying System Attributes

Source: https://docs.kubex.ai/docs-api/WebHelp_Densify_API_Cloud/Content/API_Guide/Systems/modifySystemAttributes

This example demonstrates the structure of the JSON payload for the `modifySystemAttributes` API call. It shows how to provide an array of attribute objects, each with a 'name' and 'value'.

```json
[
  {
    "name": "Observed Uptime",
    "value": "0.33"
  },
  {
    "name": "Cost",
    "value": "17"
  }
]
```

--------------------------------

### Get an individual Existing System

Source: https://docs.kubex.ai/docs-api/WebHelp_Densify_API_Cloud/Content/API_Guide/Existing_Systems/getExistingSystem

Retrieves a single system by its unique ID. You can optionally include additional details like manufacturer, OS, and benchmarks by setting the 'details' query parameter to true.

```APIDOC
## GET /existing-systems/{id}

### Description
Retrieve a single system by ID. Optionally include additional detail fields (e.g., manufacturer, os, benchmarks) by setting the `details` query parameter to `true`.

### Method
GET

### Endpoint
/existing-systems/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Unique system ID.

#### Query Parameters
- **details** (boolean) - Optional - When true, include additional detail fields (e.g., manufacturer, os, benchmarks). Defaults to false.

### Responses
#### Success Response (200)
- **id** (string) - The unique identifier of the system.
- **name** (string) - The name of the system.
- **href** (string) - A link to the system resource.
- **type** (string) - The type of the system (HOST or GUEST).
- **platform_model** (string) - Host model or instance type (when available).
- **total_physical_cpus** (string) - Total physical CPUs.
- **cores_per_cpu** (string) - Cores per CPU.
- **memory** (string) - Normalized total memory in MB.
- **total_logical_cpus** (string) - Total logical CPUs.
- **threads_per_core** (string) - Threads per core.
- **cpu_speed** (string) - Normalized CPU speed in MHz.
- **cpu_model** (string) - CPU model.
- **entity_type** (string) - The entity type.
- **entity_role_name** (string) - The entity role name.
- **parent** (string) - Parent host name for GUEST; "N/A" for HOST.
- **children** (string) - Number of child VMs for HOST; "N/A" for GUEST.
- **os** (string) - The operating system of the system.
- **os_version** (string) - The operating system version.
- **os_patch_level** (string) - The operating system patch level.
- **ip_address** (string) - The IP address of the system.
- **mac_address** (string) - The MAC address of the system.
- **serial_number** (string) - The serial number of the system.
- **hostId** (string) - The host ID.
- **control_environment** (object) - Reference to the control environment.
  - **id** (string)
  - **name** (string)
  - **platform_category** (string) - Enum: External Cloud, Internal Virtual.
  - **href** (string)
  - **icon** (string)
- **infrastructure_group** (object) - Reference to the infrastructure group.
  - **id** (string)
  - **name** (string)
  - **href** (string)
- **cpu_benchmarks** (array) - Array of CPU benchmark objects.
  - **name** (string) - One of "CINT2000", "CINT2000 Rate", "CINT2006 Rate", "RPE2".
  - **score_type** (string) - One of "cint2000", "cint2000rate", "cint2006rate", "rpe2".
  - **value** (number)
- **I/O_benchmarks** (array) - Array of I/O benchmark objects.
  - **name** (string) - One of "Maximum Disk Throughput (bytes/s)", "Maximum Network Throughput (bytes/s)".
  - **score_type** (string) - One of "disk", "net".
  - **value** (number)
- **size** (string) - Hidden element used internally for size sorting.

#### Error Response (401)
Unauthorized access.

#### Error Response (404)
System not found.

#### Error Response (500)
Server error.
```

--------------------------------

### Install NVIDIA CUDA Toolkit on Amazon Linux 2

Source: https://docs.kubex.ai/docs/WebHelp_Densify_Cloud/Content/Data_Collection_for_Public_Cloud_Systems/AWS_Data_Collection_Prerequisites_for_an_IAM_Role__CloudWatch_only_

Use this command to install the NVIDIA CUDA toolkit on Amazon Linux 2 instances. This is necessary for collecting GPU metrics.

```bash
sudo yum install -y nvidia cuda
```

--------------------------------

### OpenAPI Specification for Get Subscription Status

Source: https://docs.kubex.ai/docs-api/WebHelp_Densify_API_Cloud/Content/API_Guide/Subscriptions_Status/getSubscriptionStatus

This OpenAPI specification defines the GET endpoint for retrieving subscription status, including parameters for platform type and subscription reference, and outlines possible responses.

```yaml
openapi: 3.0.3
info:
  title: Kubex – Subscriptions Status API
  version: 1.0.0
  description: |
    Return the last on-demand/scheduled trigger and the last webhook post status
    for a specific subscription. Includes a back-compat alias without platform
    that behaves like the cloud endpoint. 
servers:
  - url: https://{host}
    variables:
      host:
        default: api.example.com
security: []
tags:
  - name: Subscriptions
paths:
  /subscriptions/{platformType}/{subscriptionRef}/status:
    get:
      tags:
        - Subscriptions
      summary: Get subscription status (results + webhook)
      description: >
        Returns `lastTriggered` (On-Demand/Scheduled Success/Failure with
        timestamp)

        and `webHookStatus` (Success/Failure with timestamp) for the specified

        subscription. 
      operationId: getSubscriptionStatus
      parameters:
        - name: platformType
          in: path
          required: true
          description: Technology platform (`cloud` or `containers`).
          schema:
            type: string
            enum:
              - cloud
              - containers
        - name: subscriptionRef
          in: path
          required: true
          description: Unique subscription identifier.
          schema:
            type: string
      responses:
        '200':
          description: Status payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionStatus'
              examples:
                sample:
                  value:
                    lastTriggered: On-Demand Success. Thu Jan 02 16:41:52 EST 2020
                    webHookStatus: >-
                      Failure. … Connection refused … Thu Jan 02 16:41:53 EST
                      2020
        '204':
          description: Success, no content.
        '400':
          description: Bad request (invalid parameters / logic).
        '401':
          description: Authentication failed.
        '404':
          description: Not found / no privileges.
        '415':
          description: Unsupported media type.
        '500':
          description: Internal server error.
components:
  schemas:
    SubscriptionStatus:
      type: object
      properties:
        lastTriggered:
          type: string
          description: >
            Status + timestamp of last request: On-Demand Success/Failure or
            Scheduled Success/Failure. 
        webHookStatus:
          type: string
          description: | 
            Status + timestamp of last webhook post: Success or Failure. 
        message:
          type: string
          description: Message for the status response (on error).
        status:
          type: integer
          description: One of 200, 204, 400, 401, 404, 415, 500.

```

--------------------------------

### Get Existing Systems

Source: https://docs.kubex.ai/docs-api/WebHelp_Densify_API_Cloud/Content/API_Guide/Existing_Systems/getExistingSystems

Fetches an array of systems (HOST or GUEST) that exist in a control environment. Query filters are supported, but general 'Common Operations' like paging and 'Sort By' are not.

```APIDOC
## Get Existing Systems collection

### Description
Returns an array of systems (HOST or GUEST) that exist in a control environment. General "Common Operations" (e.g., paging helpers) and "Sort By" are not supported. However, query filters shown below are supported.

### Method
GET

### Endpoint
/api/v1/systems

### Query Parameters
#### Supported Filters
- **type** (string) - Optional - Filters systems by type (e.g., 'HOST', 'GUEST').
- **status** (string) - Optional - Filters systems by status (e.g., 'ACTIVE', 'INACTIVE').

### Response
#### Success Response (200)
- **systems** (array) - An array of system objects.
  - **id** (string) - The unique identifier of the system.
  - **name** (string) - The name of the system.
  - **type** (string) - The type of the system (e.g., 'HOST', 'GUEST').
  - **status** (string) - The current status of the system (e.g., 'ACTIVE', 'INACTIVE').

#### Response Example
```json
{
  "systems": [
    {
      "id": "sys-12345",
      "name": "Web Server 01",
      "type": "HOST",
      "status": "ACTIVE"
    },
    {
      "id": "sys-67890",
      "name": "Database Server 01",
      "type": "GUEST",
      "status": "ACTIVE"
    }
  ]
}
```
```

--------------------------------

### Get Individual System

Source: https://docs.kubex.ai/docs-api/WebHelp_Densify_API_Cloud/Content/API_Guide/Systems/getSystem

Retrieves configuration and attribute information for a specific system by its ID. The `details` query parameter can be used to include extra information.

```APIDOC
## GET /systems/{id}

### Description
Returns configuration and attribute information for a specific system.

### Method
GET

### Endpoint
/systems/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Kubex unique system ID

#### Query Parameters
- **details** (boolean) - Optional - Include extra details for applicable elements (e.g., `children`, `manufacturer`, `os`). Defaults to false.

### Responses
#### Success Response (200)
- **System** (object) - System details

#### Error Responses
- **401** - Unauthorized
- **404** - System not found
- **500** - Internal server error
```

--------------------------------

### Get Subscription Tag OpenAPI Specification

Source: https://docs.kubex.ai/docs-api/WebHelp_Densify_API_Cloud/Content/API_Guide/Subscriptions_Tags/getSubscriptionTag

This OpenAPI specification defines the GET request for retrieving a subscription tag by its ID and platform type. It includes parameter definitions, response schemas, and error codes.

```yaml
openapi: 3.1.0
info:
  title: Kubex – Subscriptions Tags API
  version: 1.0.0
  description: >
    Catalog of system attribute *tags* that subscriptions can reference via
    `tagReferences`.

    Each platform has its own catalog (`cloud` or `containers`); only
    matching-platform

    subscriptions can reference tags from that catalog. Comparisons on tags are
    **string /

    lexicographic**, not numeric. The alias without `platformType` behaves like
    `cloud`. 
servers:
  - url: https://{host}
    variables:
      host:
        default: api.example.com
security: []
tags:
  - name: Subscriptions Tags
paths:
  /subscriptions/{platformType}/tags/{tagRef}:
    get:
      tags:
        - Subscriptions Tags
      summary: Get a tag by ID
      operationId: getSubscriptionTag
      parameters:
        - $ref: '#/components/parameters/platformType'
        - $ref: '#/components/parameters/tagRef'
      responses:
        '200':
          description: Tag
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionTag'
        '401':
          description: Authentication failed.
        '404':
          description: Not found / not visible.
        '415':
          description: Unsupported media type.
        '500':
          description: Server error.
components:
  parameters:
    platformType:
      name: platformType
      in: path
      required: true
      description: Platform catalog (`cloud` or `containers`).
      schema:
        type: string
        enum:
          - cloud
          - containers
    tagRef:
      name: tagRef
      in: path
      required: true
      description: Unique tag identifier.
      schema:
        type: string
  schemas:
    SubscriptionTag:
      type: object
      description: Subscriptions attribute tag entry.
      properties:
        tagRef:
          type: string
          description: Unique reference ID.
        tagName:
          type: string
          description: Tag name (unique per scope).
        attributeName:
          type: string
          description: >-
            Must be a Kubex standard attribute or technology-specific ('Resource
            Tags' / 'Container Labels').
        aliasName:
          type: string
          description: Display alias (scope-unique per rules).
        technology:
          type: string
          description: Technology for resource attributes.
          enum:
            - AWS
            - CONTAINER
        key:
          type: string
          description: Key used with technology-specific resource attributes.
        owner:
          type: string
          description: Empty = global; otherwise username for private tag.
        message:
          type: string
          description: Status message (on error).
        status:
          type: integer
          description: HTTP-like status code (200, 204, 400, 401, 404, 415, 500).

```

--------------------------------

### OpenAPI Specification for Get Suppression

Source: https://docs.kubex.ai/docs-api/WebHelp_Densify_API_Cloud/Content/API_Guide/Subscriptions_Suppressions/getSuppression

This OpenAPI 3.1.0 specification defines the GET endpoint for retrieving a suppression by its ID. It includes parameters for platform type and suppression reference, and defines the structure of the suppression response.

```yaml
openapi: 3.1.0
info:
  title: Kubex – Subscriptions Suppressions API
  version: 1.0.0
  description: >
    Catalog of suppression entries (attribute tags or recommendation properties)

    that can be referenced by subscriptions via `suppressionReferences`. Each

    platform (`cloud` or `containers`) has its own catalog; the alias without

    platform behaves like the cloud catalog. Bulk adds/updates are
    all-or-nothing,

    while bulk deletes process entries independently.
servers:
  - url: https://{host}
    variables:
      host:
        default: api.example.com
security: []
tags:
  - name: Subscriptions Suppressions
paths:
  /subscriptions/{platformType}/suppressions/{suppressionRef}:
    get:
      tags:
        - Subscriptions Suppressions
      summary: Get a suppression by ID
      operationId: getSuppression
      parameters:
        - $ref: '#/components/parameters/platformType'
        - $ref: '#/components/parameters/suppressionRef'
      responses:
        '200':
          description: Suppression
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Suppression'
        '404':
          description: Not found / not visible.
components:
  parameters:
    platformType:
      name: platformType
      in: path
      required: true
      description: Platform catalog to target (`cloud` or `containers`).
      schema:
        type: string
        enum:
          - cloud
          - containers
    suppressionRef:
      name: suppressionRef
      in: path
      required: true
      description: Unique suppression identifier.
      schema:
        type: string
  schemas:
    Suppression:
      type: object
      properties:
        suppressionRef:
          type: string
          description: Unique reference ID.
        suppressionName:
          type: string
          description: Suppression name.
        aliasName:
          type: string
          description: Alias for display.
        attributeName:
          type: string
          description: >
            Attribute name (e.g., “Business Applications”, “Resource Tags”,
            “Container Labels”). For “Resource Tags”/“Container Labels”, supply
            `key` and `technology`. Must exist in Kubex standard attributes.
        key:
          type: string
          description: Resource tag/label key (with technology).
        technology:
          type: string
          description: 'Technology for resource attribute (supported: AWS, CONTAINER).'
          enum:
            - AWS
            - CONTAINER
        propertyName:
          type: string
          description: >
            Recommendation element name (must exist in Recommendations schema
            for the platform).
        owner:
          type: string
          description: >
            Empty = global; otherwise username for private entry. Admins can set
            empty (global); non-admins limited to self.
        message:
          type: string
          description: Error/status message (on error).
        status:
          type: integer
          description: HTTP-like status code (200, 204, 400, 401, 404, 415, 500).
```

--------------------------------

### Filter Systems by Type

Source: https://docs.kubex.ai/docs-api/WebHelp_Densify_API_Cloud/Content/API_Guide/Common_Operations

Retrieve a list of systems filtered by their type. This example shows how to filter for systems of type 'host'.

```http
GET /systems/?type=host
```
Tokens:
Raw