International Business Machines Environments API

Manage assistant environments.

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

international-business-machines-environments-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: International Business Machines IBM Cloud Object Storage Analyze Environments API
  description: The IBM Cloud Object Storage API provides a RESTful interface compatible with S3 for storing and retrieving objects in buckets. It supports features such as multipart uploads, versioning, lifecycle policies, and server-side encryption.
  version: 1.0.0
  contact:
    name: IBM Cloud
    url: https://cloud.ibm.com/docs/cloud-object-storage
  license:
    name: IBM Cloud Terms
    url: https://www.ibm.com/terms
servers:
- url: https://s3.us-south.cloud-object-storage.appdomain.cloud
  description: US South
- url: https://s3.eu-de.cloud-object-storage.appdomain.cloud
  description: EU Germany
- url: https://s3.eu-gb.cloud-object-storage.appdomain.cloud
  description: EU Great Britain
security:
- bearerAuth: []
tags:
- name: Environments
  description: Manage assistant environments.
paths:
  /v2/assistants/{assistant_id}/environments:
    get:
      operationId: listEnvironments
      summary: International Business Machines List environments
      description: List the environments associated with an assistant.
      tags:
      - Environments
      parameters:
      - name: assistant_id
        in: path
        required: true
        schema:
          type: string
      - name: version
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentCollection'
components:
  schemas:
    EnvironmentCollection:
      type: object
      properties:
        environments:
          type: array
          items:
            type: object
            properties:
              environment_id:
                type: string
              name:
                type: string
              description:
                type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: IAM Token