Cast AI Inventory Management API

openapi: 3.2.0
info:
  title: Inventory Management API
  version: 0.0.1
  description: Provides the API for managing instance blacklist rules.
servers:
- url: https://api.cast.ai/
  description: US endpoint
- url: https://api.eu.cast.ai/
  description: EU endpoint
security:
- BearerAuth: []
- ApiKeyAuth: []
tags:
- name: InventoryManagementAPI
  description: Provides the API for managing instance blacklist rules.
paths:
  /inventory/v1/instance-blacklist-rules:
    get:
      tags:
      - InventoryManagementAPI
      summary: List instance blacklist rules
      description: Lists instance blacklist rules.
      operationId: InventoryManagementAPI_ListInstanceBlacklistRules
      parameters:
      - name: provider
        in: query
        description: "Optional provider filter.\n When not provided or set to CLOUD_UNSPECIFIED, returns all providers."
        schema:
          enum:
          - CLOUD_UNSPECIFIED
          - GCP
          - AWS
          - AZURE
          - ORACLE
          - NEBIUS
          type: string
          format: enum
      - name: region
        in: query
        description: Optional region filter.
        schema:
          type: string
      - name: page.limit
        in: query
        description: Defines the number of items that should be returned
        schema:
          type: string
      - name: page.cursor
        in: query
        description: "Cursor that defines token indicating where to start the next page.\n Empty value indicates to start from beginning of the dataset."
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInstanceBlacklistRulesResponse'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
  /inventory/v1/instance-blacklist-rules/{id}:
    delete:
      tags:
      - InventoryManagementAPI
      summary: Delete an instance blacklist rule
      description: Deletes an instance blacklist rule.
      operationId: InventoryManagementAPI_DeleteInstanceBlacklistRule
      parameters:
      - name: id
        in: path
        description: The ID of the instance blacklist rule to delete.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content: {}
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
  /inventory/v1/instance-blacklist-rules:batchCreate:
    post:
      tags:
      - InventoryManagementAPI
      summary: Batch create instance blacklist rules
      description: Batch creates instance blacklist rules.
      operationId: InventoryManagementAPI_BatchCreateInstanceBlacklistRules
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchCreateInstanceBlacklistRulesRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchCreateInstanceBlacklistRulesResponse'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
components:
  schemas:
    Status:
      type: object
      properties:
        code:
          type: integer
          description: The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
          format: int32
        message:
          type: string
          description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
        details:
          type: array
          items:
            $ref: '#/components/schemas/GoogleProtobufAny'
          description: A list of messages that carry the error details.  There is a common set of message types for APIs to use.
      description: 'The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).'
    CreateInstanceBlacklistRuleRequest:
      required:
      - instanceBlacklistRule
      type: object
      properties:
        instanceBlacklistRule:
          allOf:
          - $ref: '#/components/schemas/InstanceBlacklistRule'
          description: The instance blacklist rule to create.
      description: Request to create a single rule (used as element in batch).
    BatchCreateInstanceBlacklistRulesRequest:
      required:
      - requests
      type: object
      properties:
        requests:
          type: array
          items:
            $ref: '#/components/schemas/CreateInstanceBlacklistRuleRequest'
          description: Individual create requests.
      description: Batch create request per AIP-233.
    BatchCreateInstanceBlacklistRulesResponse:
      type: object
      properties:
        instanceBlacklistRules:
          type: array
          items:
            $ref: '#/components/schemas/InstanceBlacklistRule'
          description: The created instance blacklist rules.
      description: Batch create response.
    ListInstanceBlacklistRulesResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/InstanceBlacklistRule'
          description: The instance blacklist rules.
        nextPageCursor:
          type: string
          description: The pagination cursor to retrieve the next page of items.
      description: List response for instance blacklist rules.
    InstanceBlacklistRule:
      required:
      - reason
      - provider
      type: object
      properties:
        id:
          readOnly: true
          type: string
          description: Server-generated unique identifier.
        createTime:
          readOnly: true
          type: string
          description: Server-generated creation timestamp.
          format: date-time
        updateTime:
          readOnly: true
          type: string
          description: Server-generated last update timestamp.
          format: date-time
        reason:
          type: string
          description: Human-readable reason for the blacklist rule.
        provider:
          type: string
          description: Cloud provider (e.g. "aws", "gcp", "azure").
        region:
          type: string
          description: Cloud region.
        azId:
          type: string
          description: Availability zone ID.
        instanceType:
          type: string
          description: Instance type to blacklist (mutually exclusive with instance_family).
        instanceFamily:
          type: string
          description: Instance family to blacklist (mutually exclusive with instance_type).
        lifecycle:
          enum:
          - LIFECYCLE_UNSPECIFIED
          - LIFECYCLE_ALL
          - LIFECYCLE_SPOT
          - LIFECYCLE_ON_DEMAND
          type: string
          description: Lifecycle type for the blacklist rule.
          format: enum
        expireTime:
          type: string
          description: Optional expiration time for the rule.
          format: date-time
      description: An instance blacklist rule.
    GoogleProtobufAny:
      type: object
      properties:
        '@type':
          type: string
          description: The type of the serialized message.
      additionalProperties: true
      description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
x-provenance:
  method: searched
  source: https://docs.cast.ai/reference
  harvested: '2026-10-20'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.cast.ai/reference/cloudassetapi_getreliabilitydatacommand.md
  - https://docs.cast.ai/reference/cloudassetapi_getreliabilitydatascript.md
  - https://docs.cast.ai/reference/cloudassetapi_listclusters.md
  - https://docs.cast.ai/reference/cloudassetapi_reconcilediscoveredclusters.md
  - https://docs.cast.ai/reference/cloudassetintegrationsapi_createcloudassetintegration.md
  - https://docs.cast.ai/reference/cloudassetintegrationsapi_deletecloudassetintegration.md
  - https://docs.cast.ai/reference/cloudassetintegrationsapi_getcloudassetintegration.md
  - https://docs.cast.ai/reference/cloudassetintegrationsapi_getcloudassetintegrationcleanupcommand.md
  - https://docs.cast.ai/reference/cloudassetintegrationsapi_getcloudassetintegrationcleanupscript.md
  - https://docs.cast.ai/reference/cloudassetintegrationsapi_getcloudassetintegrationonboardingcommand.md
  - https://docs.cast.ai/reference/cloudassetintegrationsapi_getcloudassetintegrationonboardingconfig.md
  - https://docs.cast.ai/reference/cloudassetintegrationsapi_getcloudassetintegrationonboardingscript.md
  - https://docs.cast.ai/reference/cloudassetintegrationsapi_getcloudassetintegrationsyncreport.md
  - https://docs.cast.ai/reference/cloudassetintegrationsapi_listcloudassetintegrations.md
  - https://docs.cast.ai/reference/cloudassetintegrationsapi_updatecloudassetintegration.md
  - https://docs.cast.ai/reference/inventorymanagementapi_batchcreateinstanceblacklistrules.md
  - https://docs.cast.ai/reference/inventorymanagementapi_deleteinstanceblacklistrule.md
  - https://docs.cast.ai/reference/inventorymanagementapi_listinstanceblacklistrules.md
  merge:
    pages: 18
    deduped: 80
    conflicts_kept_first: 0