openapi: 3.2.0
info:
  description: Blockchain Platform Control Plane API
  title: Control Plane Blockchain Platform API
  version: '20191010'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/37c144ccf52c32d759221783a2a5c9327cc3be13ed5730d8079ce8ef11e33add.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Blockchain Platform Control Plane API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/37c144ccf52c32d759221783a2a5c9327cc3be13ed5730d8079ce8ef11e33add.yaml
    what: the harvested document for Blockchain Platform Control Plane API
servers:
- url: http://127.0.0.1/20191010
- url: https://127.0.0.1/20191010
tags:
- name: blockchainPlatform
paths:
  /blockchainPlatforms:
    get:
      description: Returns a list Blockchain Platform Instances in a compartment
      operationId: ListBlockchainPlatforms
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/BlockchainPlatformLifecycleStateQueryParam'
      responses:
        200:
          description: Gets list of blockchain platform instances
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlockchainPlatformCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: List Blockchain Platforms
      tags:
      - blockchainPlatform
      x-related-resource: '#/definitions/BlockchainPlatform'
    post:
      description: 'Creates a new Blockchain Platform.

        '
      operationId: CreateBlockchainPlatform
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: The platform will be created.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a new Blockchain Platform
      tags:
      - blockchainPlatform
      x-related-resource: '#/definitions/BlockchainPlatform'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBlockchainPlatformDetails'
        description: Details for the new service.
        required: true
  /blockchainPlatforms/{blockchainPlatformId}:
    delete:
      description: Delete a particular of a Blockchain Platform
      operationId: DeleteBlockchainPlatform
      parameters:
      - $ref: '#/components/parameters/BlockchainPlatformIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: Accepted the request. The platform will be deleted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Delete a Blockchain Platform
      tags:
      - blockchainPlatform
      x-related-resource: '#/definitions/BlockchainPlatform'
    get:
      description: Gets information about a Blockchain Platform identified by the specific id
      operationId: GetBlockchainPlatform
      parameters:
      - $ref: '#/components/parameters/BlockchainPlatformIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the service with the given id
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlockchainPlatform'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get Blockchain Platform
      tags:
      - blockchainPlatform
    put:
      description: Update a particular of a Blockchain Platform
      operationId: UpdateBlockchainPlatform
      parameters:
      - $ref: '#/components/parameters/BlockchainPlatformIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: 'The update request was accepted.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Update a Blockchain Platform
      tags:
      - blockchainPlatform
      x-related-resource: '#/definitions/BlockchainPlatform'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBlockchainPlatformDetails'
        description: The Blockchain Platform fields to update. Fields that are not provided will not be updated.
        required: true
  /blockchainPlatforms/{blockchainPlatformId}/actions/changeCompartment:
    post:
      description: Change Blockchain Platform Compartment
      operationId: ChangeBlockchainPlatformCompartment
      parameters:
      - $ref: '#/components/parameters/BlockchainPlatformIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'The request to move compartments was accepted.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Change Blockchain Platform Compartment
      tags:
      - blockchainPlatform
      x-related-resource: '#/definitions/BlockchainPlatform'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeBlockchainPlatformCompartmentDetails'
        description: 'Input payload to move the resource to a different compartment.

          '
        required: true
  /blockchainPlatforms/{blockchainPlatformId}/actions/scale:
    post:
      description: Scale Blockchain Platform
      operationId: ScaleBlockchainPlatform
      parameters:
      - $ref: '#/components/parameters/BlockchainPlatformIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'The request to scaleout was accepted.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Scale Blockchain Platform
      tags:
      - blockchainPlatform
      x-related-resource: '#/definitions/BlockchainPlatform'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScaleBlockchainPlatformDetails'
        description: 'Input payload to scaleout blockchain platform. The payload cannot be empty.

          '
        required: true
  /blockchainPlatforms/{blockchainPlatformId}/actions/scale/preview:
    post:
      description: Preview Scale Blockchain Platform
      operationId: PreviewScaleBlockchainPlatform
      parameters:
      - $ref: '#/components/parameters/BlockchainPlatformIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Provides a preview of a scale operation
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScaledBlockchainPlatformPreview'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Preview Scale Blockchain Platform
      tags:
      - blockchainPlatform
      x-related-resource: '#/definitions/BlockchainPlatform'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScaleBlockchainPlatformDetails'
        description: 'Input payload to scaleout blockchain platform. The payload cannot be empty.

          '
        required: true
  /blockchainPlatforms/{blockchainPlatformId}/actions/start:
    post:
      description: Start a Blockchain Platform
      operationId: StartBlockchainPlatform
      parameters:
      - $ref: '#/components/parameters/BlockchainPlatformIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The Blockchain Platform will be started.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Start a Blockchain Platform
      tags:
      - blockchainPlatform
      x-related-resource: '#/definitions/BlockchainPlatform'
  /blockchainPlatforms/{blockchainPlatformId}/actions/stop:
    post:
      description: Stop a Blockchain Platform
      operationId: StopBlockchainPlatform
      parameters:
      - $ref: '#/components/parameters/BlockchainPlatformIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The Blockchain Platform will be stopped.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Stop a Blockchain Platform
      tags:
      - blockchainPlatform
      x-related-resource: '#/definitions/BlockchainPlatform'
  /blockchainPlatforms/{blockchainPlatformId}/osns:
    get:
      description: List Blockchain Platform OSNs
      operationId: ListOsns
      parameters:
      - $ref: '#/components/parameters/BlockchainPlatformIdPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        200:
          description: Gets list of blockchain platform OSNs
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OsnCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: List Blockchain Platform OSNs
      tags:
      - blockchainPlatform
      x-related-resource: '#/definitions/Osn'
    post:
      description: Create Blockchain Platform Osn
      operationId: CreateOsn
      parameters:
      - $ref: '#/components/parameters/BlockchainPlatformIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'The request to create an OSN was accepted.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Create Blockchain Platform OSN
      tags:
      - blockchainPlatform
      x-related-resource: '#/definitions/BlockchainPlatform'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOsnDetails'
        description: 'Input payload to create blockchain platform OSN. The payload cannot be empty.

          '
        required: true
  /blockchainPlatforms/{blockchainPlatformId}/osns/{osnId}:
    delete:
      description: Delete a particular OSN of a Blockchain Platform
      operationId: DeleteOsn
      parameters:
      - $ref: '#/components/parameters/BlockchainPlatformIdPathParam'
      - $ref: '#/components/parameters/OsnIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: Accepted the request. The OSN will be deleted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Delete a Blockchain Platform Osn
      tags:
      - blockchainPlatform
      x-related-resource: '#/definitions/BlockchainPlatform'
    get:
      description: Gets information about an OSN identified by the specific id
      operationId: GetOsn
      parameters:
      - $ref: '#/components/parameters/BlockchainPlatformIdPathParam'
      - $ref: '#/components/parameters/OsnIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the OSN with the given id
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Osn'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get Blockchain Platform OSN
      tags:
      - blockchainPlatform
    put:
      description: Update Blockchain Platform OSN
      operationId: UpdateOsn
      parameters:
      - $ref: '#/components/parameters/BlockchainPlatformIdPathParam'
      - $ref: '#/components/parameters/OsnIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'The request to update an Osn was accepted.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Update Blockchain Platform OSN
      tags:
      - blockchainPlatform
      x-related-resource: '#/definitions/BlockchainPlatform'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOsnDetails'
        description: 'Input payload to update a blockchain platform OSN. The payload cannot be empty.

          '
        required: true
  /blockchainPlatforms/{blockchainPlatformId}/peers:
    get:
      description: List Blockchain Platform Peers
      operationId: ListPeers
      parameters:
      - $ref: '#/components/parameters/BlockchainPlatformIdPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        200:
          description: Gets list of blockchain platform peers
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PeerCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: List Blockchain Platform Peers
      tags:
      - blockchainPlatform
      x-related-resource: '#/definitions/Peer'
    post:
      description: Create Blockchain Platform Peer
      operationId: CreatePeer
      parameters:
      - $ref: '#/components/parameters/BlockchainPlatformIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'The request to create a peer was accepted.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Create Blockchain Platform Peer
      tags:
      - blockchainPlatform
      x-related-resource: '#/definitions/BlockchainPlatform'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePeerDetails'
        description: 'Input payload to create a blockchain platform peer. The payload cannot be empty.

          '
        required: true
  /blockchainPlatforms/{blockchainPlatformId}/peers/{peerId}:
    delete:
      description: Delete a particular peer of a Blockchain Platform
      operationId: DeletePeer
      parameters:
      - $ref: '#/components/parameters/BlockchainPlatformIdPathParam'
      - $ref: '#/components/parameters/PeerIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: Accepted the request. The peer will be deleted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Delete a Blockchain Platform Peer
      tags:
      - blockchainPlatform
      x-related-resource: '#/definitions/BlockchainPlatform'
    get:
      description: Gets information about a peer identified by the specific id
      operationId: GetPeer
      parameters:
      - $ref: '#/components/parameters/BlockchainPlatformIdPathParam'
      - $ref: '#/components/parameters/PeerIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the peer with the given id
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Peer'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get Blockchain Platform peer
      tags:
      - blockchainPlatform
    put:
      description: Update Blockchain Platform Peer
      operationId: UpdatePeer
      parameters:
      - $ref: '#/components/parameters/BlockchainPlatformIdPathParam'
      - $ref: '#/components/parameters/PeerIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: 'The request to update a peer was accepted.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Update a Blockchain Platform Peer
      tags:
      - blockchainPlatform
      x-related-resource: '#/definitions/BlockchainPlatform'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePeerDetails'
        description: 'Input payload to update a blockchain platform peer. The payload cannot be empty.

          '
        required: true
  /workRequests:
    get:
      description: 'Lists the work requests in a compartment.

        '
      operationId: ListWorkRequests
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/BlockchainPlatformIdQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParamWorkRequests'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        200:
          description: The list of work requests.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequestCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: List Work Requests
      tags:
      - blockchainPlatform
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}:
    delete:
      description: Attempts to cancel the work request with the given ID.
      operationId: DeleteWorkRequest
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: 'The request to delete was accepted.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: DELETE Work Request
      tags:
      - blockchainPlatform
      x-related-resource: '#/definitions/WorkRequest'
    get:
      description: Gets the status of the work request with the given ID.
      operationId: GetWorkRequest
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The detail of the work request.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            retry-after:
              description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
              schema:
                type: number
                format: float
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequest'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: GET Work Request Status
      tags:
      - blockchainPlatform
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}/errors:
    get:
      description: 'Return a (paginated) list of errors for a given work request.

        '
      operationId: ListWorkRequestErrors
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        200:
          description: List of work request errors.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequestErrorCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists work request errors
      tags:
      - blockchainPlatform
      x-related-resource: '#/definitions/WorkRequestError'
  /workRequests/{workRequestId}/logs:
    get:
      description: 'Return a (paginated) list of logs for a given work request.

        '
      operationId: ListWorkRequestLogs
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        200:
          description: List of work request logs.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequestLogEntryCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists work request logs
      tags:
      - blockchainPlatform
      x-related-resource: '#/definitions/WorkRequestLogEntry'
components:
  parameters:
    PaginationTokenQueryParam:
      description: The page at which to start retrieving results.
      in: query
      name: page
      x-default-description: Values for the parameter should come from an opc-next-page or opc-prev-page header in a previous response.
      schema:
        type: string
        maxLength: 1024
        minLength: 1
    SortByQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    SortByQueryParamWorkRequests:
      description: 'The field to sort by. Only one sort order may be provided. Default order for TIMESTARTED is descending. Default order for WORKREQUESTID is ascending. If no value is specified TIMESTARTED is default.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeStarted
        - workRequestId
        default: timeStarted
    BlockchainPlatformIdQueryParam:
      description: Unique service identifier.
      in: query
      name: blockchainPlatformId
      required: true
      schema:
        type: string
    IfMatchHeader:
      description: 'For optimistic concurrency control. In the PUT or DELETE call

        for a resource, set the `if-match` parameter to the value of the

        etag from a previous GET or POST response for that resource.

        The resource will be updated or deleted only if the etag you

        provide matches the resource''s current etag value.

        '
      in: header
      name: if-match
      required: false
      schema:
        type: string
    CompartmentIdQueryParam:
      description: The ID of the compartment in which to list resources.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
    BlockchainPlatformIdPathParam:
      description: Unique service identifier.
      in: path
      name: blockchainPlatformId
      required: true
      schema:
        type: string
    PaginationLimitQueryParam:
      description: The maximum number of items to return.
      in: query
      name: limit
      schema:
        type: integer
        default: 10
        maximum: 1000
        minimum: 1
    OsnIdPathParam:
      description: OSN identifier.
      in: path
      name: osnId
      required: true
      schema:
        type: string
    WorkRequestIdPathParam:
      description: The ID of the asynchronous request.
      in: path
      name: workRequestId
      required: true
      schema:
        type: string
    SortOrderQueryParam:
      description: The sort order to use, either 'asc' or 'desc'.
      in: query
      name: sortOrder
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: ASC
    BlockchainPlatformLifecycleStateQueryParam:
      description: 'A filter to only return resources that match the given lifecycle state.

        The state value is case-insensitive.

        '
      in: query
      name: lifecycleState
      required: false
      x-default-description: By default instances in all states are returned
      x-obmcs-enumref: '#/definitions/BlockchainPlatform/lifecycleState'
      schema:
        type: string
    PeerIdPathParam:
      description: Peer identifier.
      in: path
      name: peerId
      required: true
      schema:
        type: string
    RetryTokenHeader:
      description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or

        server error without risk of executing that same action again. Retry tokens expire after 24

        hours, but can be invalidated before then due to conflicting operations. For example, if a resource

        has been deleted and purged from the system, then a retry of the original creation request

        might be rejected.

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
    DisplayNameQueryParam:
      description: 'A user-friendly name. Does not have to be unique, and it''s changeable.

        Example: `My new resource`

        '
      in: query
      name: displayName
      x-default-description: A default name is constructed by default
      schema:
        type: string
        maxLength: 255
        minLength: 1
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
  schemas:
    ReplicaDetails:
      description: Number of replicas of service components like Rest Proxy, CA and Console
      properties:
        caCount:
          description: Number of CA replicas
          maximum: 10
          minimum: 1
          type: integer
        consoleCount:
          description: Number of console replicas
          maximum: 10
          minimum: 1
          type: integer
        proxyCount:
          description: Number of REST proxy replicas
          maximum: 10
          minimum: 1
          type: integer
      type: object
    BlockchainPlatformComponentDetails:
      description: Blockchain Platform component details.
      properties:
        osns:
          description: List of OSNs
          items:
            $ref: '#/components/schemas/Osn'
          type: array
        peers:
          description: List of Peers
          items:
            $ref: '#/components/schemas/Peer'
          type: array
      type: object
    Error:
      description: Error Information.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    CreateBlockchainPlatformDetails:
      description: Blockchain Platform details for creating a new service.
      properties:
        caCertArchiveText:
          description: 'Base64 encoded text in ASCII character set of a Thirdparty CA Certificates archive file.

            The Archive file is a zip file containing third part CA Certificates,

            the ca key and certificate files used when issuing enrollment certificates

            (ECerts) and transaction certificates (TCerts). The chainfile (if it exists)

            contains the certificate chain which should be trusted for this CA, where

            the 1st in the chain is always the root CA certificate.

            File list in zip file [ca-cert.pem,ca-key.pem,ca-chain.pem(optional)].

            '
          maxLength: 10485760
          minLength: 1
          type: string
        compartmentId:
          description: Compartment Identifier
          maxLength: 255
          minLength: 1
          type: string
        computeShape:
          description: Compute shape - STANDARD or ENTERPRISE_SMALL or ENTERPRISE_MEDIUM or ENTERPRISE_LARGE or ENTERPRISE_EXTRA_LARGE
          type: string
          x-obmcs-enumref: '#/definitions/BlockchainPlatform/computeShape'
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        description:
          description: Platform Instance Description
          maxLength: 255
          minLength: 1
          type: string
        displayName:
          description: Platform Instance Display name, can be renamed
          maxLength: 255
          minLength: 1
          type: string
        federatedUserId:
          description: Identifier for a federated user
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        idcsAccessToken:
          description: IDCS access token with Identity Domain Administrator role
          maxLength: 5000
          minLength: 1
          type: string
        isByol:
          default: false
          description: Bring your own license
          type: boolean
        platformRole:
          description: Role of platform - founder or participant
          type: string
          x-obmcs-enumref: '#/definitions/BlockchainPlatform/platformRole'
      required:
      - compartmentId
      - displayName
      - platformRole
      - computeShape
      - idcsAccessToken
      type: object
    PeerCollection:
      description: Result of a peer list or search. Contains PeerSummary
      properties:
        items:
          description: Collection of PeerSummary
          items:
            $ref: '#/components/schemas/PeerSummary'
          type: array
      required:
      - items
      type: object
    BlockchainPlatformSummary:
      description: Blockchain Platform Instance Summary.
      properties:
        compartmentId:
          description: Compartment Identifier
          type: string
        computeShape:
          description: Compute shape - STANDARD or ENTERPRISE_SMALL or ENTERPRISE_MEDIUM or ENTERPRISE_LARGE or ENTERPRISE_EXTRA_LARGE or ENTERPRISE_CUSTOM
          type: string
          x-obmcs-enumref: '#/definitions/BlockchainPlatform/computeShape'
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        description:
          description: Platform Instance Description
          type: string
        displayName:
          description: Platform Instance Display name, can be renamed
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        id:
          description: unique identifier that is immutable on creation
          type: string
        lifecycleDetails:
          description: An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
          type: string
        lifecycleState:
          description: The current state of the Platform Instance.
          type: string
          x-obmcs-enumref: '#/definitions/BlockchainPlatform/lifecycleState'
        platformRole:
          description: Role of platform - founder or participant
          type: string
          x-obmcs-enumref: '#/definitions/BlockchainPlatform/platformRole'
        serviceEndpoint:
          description: Service endpoint URL, valid post-provisioning
          type: string
        timeCreated:
          description: The time the the Platform Instance was created. An RFC3339 formatted datetime string
          format: date-time
          type: string
        timeUpdated:
          description: The time the Platform Instance was updated. An RFC3339 formatted datetime string
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - displayName
      - computeShape
      type: object
    UpdateBlockchainPlatformDetails:
      description: Blockchain Platform details for updating a service.
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        description:
          description: Platform Description
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        isChaincodeClusterEnabled:
          description: Enable multiple Chaincode hosts in the platform cluster
          type: boolean
        replicas:
          $ref: '#/components/schemas/ReplicaDetails'
        storageSizeInTBs:
          description: Storage size in TBs
          format: double
          type: number
        totalOcpuCapacity:
          description: Number of total OCPUs to allocate
          type: integer
      type: object
    WorkRequestCollection:
      description: Result of a platform list or search. Contains WorkRequestSummary
      properties:
        items:
          description: Collection of WorkRequestSummary
          items:
            $ref: '#/components/schemas/WorkRequestSummary'
          type: array
      required:
      - items
      type: object
    OsnCollection:
      description: Result of a OSN list or search. Contains OsnSummary
      properties:
        items:
          description: Collection of OsnSummary
          items:
            $ref: '#/components/schemas/OsnSummary'
          type: array
      required:
      - items
      type: object
    ScaledBlockchainPlatformPreview:
      description: Blockchain Platform Instance Description Preview after Scaling.
      properties:
        compartmentId:
          description: Compartment Identifier
          type: string
        componentDetails:
          $ref: '#/components/schemas/BlockchainPlatformComponentDetails'
        componentDetailsPostScaling:
          $ref: '#/components/schemas/BlockchainPlatformComponentDetails'
        computeShape:
          description: Compute shape - STANDARD or ENTERPRISE_SMALL or ENTERPRISE_MEDIUM or ENTERPRISE_LARGE or ENTERPRISE_EXTRA_LARGE or ENTERPRISE_CUSTOM
          type: string
        description:
          description: Platform Instance Description
          type: string
        displayName:
          description: Platform Instance Display name, can be renamed
          type: string
        hostOcpuUtilizationInfo:
          description: List of OcpuUtilization for all hosts
          items:
            $ref: '#/components/schemas/OcpuUtilizationInfo'
          type: array
        hostOcpuUtilizationInfoPostScaling:
          description: List of OcpuUtilization for all hosts after scaling
          items:
            $ref: '#/components/schemas/OcpuUtilizationInfo'
          type: array
        id:
          description: unique identifier that is immutable on creation
          type: string
        meteringPreview:
          $ref: '#/components/schemas/ScaledPlatformMeteringPreview'
        newVmCount:
          description: Number of new VMs that would be created
          type: integer
        replicas:
          $ref: '#/components/schemas/ReplicaDetails'
        replicasPostScaling:
          $ref: '#/components/schemas/ReplicaDetails'
        scalePayload:
          $ref: '#/components/schemas/ScaleBlockchainPlatformDetails'
        storageSizeInTBs:
          description: Storage size in TBs
          format: double
          type: number
        storageSizeInTBsPostScaling:
          description: Storage size in TBs post scaling
          format: double
          type: number
      required:
      - id
      - compartmentId
      - displayName
      - computeShape
      type: object
    UpdateOsnDetails:
      description: OSN attributes that can be updated.
      properties:
        ocpuAllocationParam:
          $ref: '#/components/schemas/OcpuAllocationNumberParam'
      required:
      - ocpuAllocationParam
      type: object
    UpdatePeerDetails:
      description: peer to modify ocpu allocation
      properties:
        ocpuAllocationParam:
          $ref: '#/components/schemas/OcpuAllocationNumberParam'
      required:
      - ocpuAllocationParam
      type: object
    ScaledPlatformMeteringPreview:
      description: Blockchain Platform Metering Preview after Scaling
      properties:
        extraStorageMeteredUnits:
          description: Extra Storage units required in TBs
          format: double
          type: number
        storageMeteredUnits:
          description: Current Storage metered units in TBs
          format: double
          type: number
        storageMeteredUnitsPostScaling:
          description: Total Post Scaling Storage metered units in TBs
          format: double
          type: number
        totalOcpuAllocation:
          description: Number of total OCPU allocation for the blockchain platform
          format: float
          type: number
        totalOcpuAllocationPostScaling:
          description: Number of total OCPU allocation for the blockchain platform after Scaling
          format: float
          type: number
      type: object
    ScaleBlockchainPlatformDetails:
      description: 'Scale operation details for a blockchain platform. The scale operation payload has multiple options

        - Add one or more Ordering Service Node (addOsns)

        - Add one or more Peers (addPeers)

        - Add more replicas of CA, Console and Rest Proxy (addReplicas)

        - Add more storage to the platform (addStorage)

        - Modify the CPU allocation for Peer Nodes (modifyPeers)

        - Remove one or more replicas of CA, Console and Rest Proxy (removeReplicas)

        - Remove one or more Ordering Service Node (removeOsns)

        - Remove one or more Peers (removePeers).

        The scale operation payload must have at least one of the above options.

        '
      properties:
        addOsns:
          description: new OSNs to add
          items:
            $ref: '#/components/schemas/CreateOsnDetails'
          type: array
        addPeers:
          description: new Peers to add
          items:
            $ref: '#/components/schemas/CreatePeerDetails'
          type: array
        addReplicas:
          $ref: '#/components/schemas/ReplicaDetails'
        addStorage:
          $ref: '#/components/schemas/ScaleStorageDetails'
        modifyPeers:
          description: modify ocpu allocation to existing Peers
          items:
            $ref: '#/components/schemas/ModifyPeerDetails'
          type: array
        removeOsns:
          description: OSN id list to remove
          items:
            type: string
          type: array
        removePeers:
          description: Peer id list to remove
          items:
            type: string
          type: array
        removeReplicas:
          $ref: '#/components/schemas/ReplicaDetails'
      type: object
    WorkRequestResource:
      description: A resource created or operated on by a work request.
      properties:
        actionType:
          description: 'The way in which this resource is affected by the work tracked in the work request.

            A resource being created, updated, or deleted will remain in the IN_PROGRESS state until

            work is complete for that resource at which point it will transition to CREATED, UPDATED,

            or DELETED, respectively.

            '
          enum:
          - CREATED
          - UPDATED
          - DELETED
          - IN_PROGRESS
          - RELATED
          type: string
        entityType:
          description: The resource type the work request is affects.
          type: string
        entityUri:
          description: The URI path that the user can do a GET on to access the resource metadata
          type: string
        identifier:
          description: The identifier of the resource the work request affects.
          type: string
      required:
      - actionType
      - entityType
      - identifier
    ModifyPeerDetails:
      description: peer to modify ocpu allocation
      properties:
        ocpuAllocationParam:
          $ref: '#/components/schemas/OcpuAllocationNumberParam'
        peerName:
          description: peer identifier
          maxLength: 64
          minLength: 1
          type: string
      required:
      - peerName
      - ocpuAllocationParam
      type: object
    CreateOsnDetails:
      description: The Ordering Service Node details to be added
      properties:
        ad:
          description: Availability Domain to place new OSN
          type: string
          x-obmcs-enumref: '#/definitions/AvailabilityDomain/ads'
        ocpuAllocationParam:
          $ref: '#/components/schemas/OcpuAllocationNumberParam'
      required:
      - ad
      type: object
    ScaleStorageDetails:
      description: storage size to increase
      properties:
        storageSizeInTBs:
          description: Storage size in TBs
          maximum: 96
          minimum: 1
          type: integer
      required:
      - storageSizeInTBs
      type: object
    WorkRequestErrorCollection:
      description: Result of a platform list or search. Contains WorkRequestError
      properties:
        items:
          description: Collection of WorkRequestError
          items:
            $ref: '#/components/schemas/WorkRequestError'
          type: array
      required:
      - items
      type: object
    WorkRequestSummary:
      description: A description of workrequest status
      properties:
        compartmentId:
          description: 'The ocid of the compartment that contains the work request. Work requests should be scoped to

            the same compartment as the resource the work request affects. If the work request affects multiple resources,

            and those resources are not in the same compartment, it is up to the service team to pick the primary

            resource whose compartment should be used

            '
          type: string
        id:
          description: The id of the work request.
          type: string
        operationType:
          description: type of the work request
          enum:
          - CREATE_PLATFORM
          - UPDATE_PLATFORM
          - DELETE_PLATFORM
          - SCALE_PLATFORM
          - START_PLATFORM
          - STOP_PLATFORM
          - CUSTOMIZE_PLATFORM
          - SCALE_CHAINCODE_HOSTS
          type: string
        percentComplete:
          description: Percentage of the request completed.
          format: float
          type: number
        resources:
          description: The resources affected by this work request.
          items:
            $ref: '#/components/schemas/WorkRequestResource'
          type: array
        status:
          description: status of current work request.
          type: string
          x-obmcs-enumref: '#/definitions/WorkRequest/status'
        timeAccepted:
          description: 'The date and time the request was created, as described in

            [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

            '
          format: date-time
          type: string
        timeFinished:
          description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

            '
          format: date-time
          type: string
        timeStarted:
          description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339),

            section 14.29.

            '
          format: date-time
          type: string
      required:
      - operationType
      - id
      - compartmentId
      - resources
      - percentComplete
      - timeAccepted
    Osn:
      description: An Ordering Service Node details
      properties:
        ad:
          description: Availability Domain of OSN
          type: string
          x-obmcs-enumref: '#/definitions/AvailabilityDomain/ads'
        lifecycleState:
          description: The current state of the OSN.
          enum:
          - ACTIVE
          - INACTIVE
          - FAILED
          type: string
        ocpuAllocationParam:
          $ref: '#/components/schemas/OcpuAllocationNumberParam'
        osnKey:
          description: OSN identifier
          maxLength: 255
          minLength: 1
          type: string
      required:
      - osnKey
      - ad
      type: object
    WorkRequestError:
      description: An error encountered while executing a work request.
      properties:
        code:
          description: 'A machine-usable code for the error that occured. Error codes are listed on

            (https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)

            '
          type: string
        message:
          description: A human readable description of the issue encountered.
          type: string
        timestamp:
          description: The time the error occured. An RFC3339 formatted datetime string.
          format: date-time
          type: string
      required:
      - code
      - message
      - timestamp
    Peer:
      description: A Peer details
      properties:
        ad:
          description: Availability Domain of peer
          type: string
          x-obmcs-enumref: '#/definitions/AvailabilityDomain/ads'
        alias:
          description: peer alias
          type: string
        host:
          description: Host on which the Peer exists
          type: string
        lifecycleState:
          description: The current state of the peer.
          enum:
          - ACTIVE
          - INACTIVE
          - FAILED
          type: string
        ocpuAllocationParam:
          $ref: '#/components/schemas/OcpuAllocationNumberParam'
        peerKey:
          description: peer identifier
          maxLength: 255
          minLength: 1
          type: string
        role:
          description: Peer role
          type: string
          x-obmcs-enumref: '#/definitions/PeerRole/role'
      required:
      - peerKey
      - role
      - host
      - ad
      type: object
    PeerSummary:
      description: Peer summary information for returning in a list.
      properties:
        lifecycleState:
          description: The current state of the peer.
          type: string
          x-obmcs-enumref: '#/definitions/Peer/lifecycleState'
        peerKey:
          description: Peer identifier
          maxLength: 255
          minLength: 1
          type: string
      type: object
    OcpuAllocationNumberParam:
      description: OCPU allocation parameter
      properties:
        ocpuAllocationNumber:
          description: Number of OCPU allocation
          format: float
          maximum: 64
          minimum: 0
          type: number
      required:
      - ocpuAllocationNumber
      type: object
    OcpuUtilizationInfo:
      description: Ocpu utilization for a VM host
      properties:
        host:
          description: Host name of VM
          type: string
        ocpuCapacityNumber:
          description: Number of total OCPU capacity on the host
          format: float
          type: number
        ocpuUtilizationNumber:
          description: Number of OCPU utilized
          format: float
          type: number
      type: object
    CreatePeerDetails:
      description: The Peer details to be added
      properties:
        ad:
          description: Availability Domain to place new peer
          type: string
          x-obmcs-enumref: '#/definitions/AvailabilityDomain/ads'
        alias:
          description: peer alias
          maxLength: 16
          minLength: 1
          type: string
        ocpuAllocationParam:
          $ref: '#/components/schemas/OcpuAllocationNumberParam'
        role:
          description: Peer role
          type: string
          x-obmcs-enumref: '#/definitions/PeerRole/role'
      required:
      - role
      - ocpuAllocationParam
      - ad
      type: object
    WorkRequestLogEntry:
      description: A log message from the execution of a work request.
      properties:
        message:
          description: Human-readable log message.
          type: string
        timestamp:
          description: The time the log message was written. An RFC3339 formatted datetime string
          format: date-time
          type: string
      required:
      - message
      - timestamp
    OsnSummary:
      description: OSN summary information for returning in a list.
      properties:
        lifecycleState:
          description: The current state of the OSN.
          type: string
          x-obmcs-enumref: '#/definitions/Osn/lifecycleState'
        osnKey:
          description: OSN identifier
          maxLength: 255
          minLength: 1
          type: string
      type: object
    BlockchainPlatform:
      description: Blockchain Platform Instance Description.
      properties:
        compartmentId:
          description: Compartment Identifier
          type: string
        componentDetails:
          $ref: '#/components/schemas/BlockchainPlatformComponentDetails'
        computeShape:
          description: Compute shape - STANDARD or ENTERPRISE_SMALL or ENTERPRISE_MEDIUM or ENTERPRISE_LARGE or ENTERPRISE_EXTRA_LARGE or ENTERPRISE_CUSTOM
          enum:
          - STANDARD
          - ENTERPRISE_SMALL
          - ENTERPRISE_MEDIUM
          - ENTERPRISE_LARGE
          - ENTERPRISE_EXTRA_LARGE
          - ENTERPRISE_CUSTOM
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        description:
          description: Platform Instance Description
          type: string
        displayName:
          description: Platform Instance Display name, can be renamed
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        hostOcpuUtilizationInfo:
          description: List of OcpuUtilization for all hosts
          items:
            $ref: '#/components/schemas/OcpuUtilizationInfo'
          type: array
        id:
          description: unique identifier that is immutable on creation
          type: string
        isByol:
          description: Bring your own license
          type: boolean
        isChaincodeClusterEnabled:
          description: Multiple Chaincode hosts enabled in the platform cluster
          type: boolean
        isMultiAD:
          description: True for multi-AD blockchain plaforms, false for single-AD
          type: boolean
        lifecycleDetails:
          description: An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
          type: string
        lifecycleState:
          description: The current state of the Platform Instance.
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - DELETED
          - SCALING
          - INACTIVE
          - FAILED
          type: string
        platformRole:
          description: Role of platform - FOUNDER or PARTICIPANT
          enum:
          - FOUNDER
          - PARTICIPANT
          type: string
        replicas:
          $ref: '#/components/schemas/ReplicaDetails'
        serviceEndpoint:
          description: Service endpoint URL, valid post-provisioning
          type: string
        serviceVersion:
          description: The version of the Platform Instance.
          type: string
        storageSizeInTBs:
          description: Storage size in TBs
          format: double
          type: number
        storageUsedInTBs:
          description: Storage used in TBs
          format: double
          type: number
        timeCreated:
          description: The time the the Platform Instance was created. An RFC3339 formatted datetime string
          format: date-time
          type: string
        timeUpdated:
          description: The time the Platform Instance was updated. An RFC3339 formatted datetime string
          format: date-time
          type: string
        totalOcpuCapacity:
          description: Number of total OCPUs allocated to the platform cluster
          type: integer
      required:
      - id
      - compartmentId
      - displayName
      - platformRole
      - computeShape
      type: object
    BlockchainPlatformCollection:
      description: Result of a platform list or search. Contains BlockchainPlatformSummary
      properties:
        items:
          description: Collection of BlockchainPlatformSummary
          items:
            $ref: '#/components/schemas/BlockchainPlatformSummary'
          type: array
      required:
      - items
      type: object
    WorkRequestLogEntryCollection:
      description: Result of a platform lpnist or search. Contains WorkRequestLogEntry
      properties:
        items:
          description: Collection of WorkRequestLogEntry
          items:
            $ref: '#/components/schemas/WorkRequestLogEntry'
          type: array
      required:
      - items
      type: object
    ChangeBlockchainPlatformCompartmentDetails:
      description: 'Input payload to change a resource''s compartment.

        '
      properties:
        compartmentId:
          description: 'The OCID of the new compartment.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
    WorkRequest:
      description: A description of workrequest status
      properties:
        compartmentId:
          description: 'The ocid of the compartment that contains the work request. Work requests should be scoped to

            the same compartment as the resource the work request affects. If the work request affects multiple resources,

            and those resources are not in the same compartment, it is up to the service team to pick the primary

            resource whose compartment should be used

            '
          type: string
        id:
          description: The id of the work request.
          type: string
        operationType:
          description: type of the work request
          enum:
          - CREATE_PLATFORM
          - UPDATE_PLATFORM
          - DELETE_PLATFORM
          - SCALE_PLATFORM
          - START_PLATFORM
          - STOP_PLATFORM
          - CUSTOMIZE_PLATFORM
          - SCALE_CHAINCODE_HOSTS
          type: string
        percentComplete:
          description: Percentage of the request completed.
          format: float
          type: number
        resources:
          description: The resources affected by this work request.
          items:
            $ref: '#/components/schemas/WorkRequestResource'
          type: array
        status:
          description: status of current work request.
          enum:
          - ACCEPTED
          - IN_PROGRESS
          - FAILED
          - SUCCEEDED
          - CANCELING
          - CANCELED
          type: string
        timeAccepted:
          description: 'The date and time the request was created, as described in

            [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

            '
          format: date-time
          type: string
        timeFinished:
          description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

            '
          format: date-time
          type: string
        timeStarted:
          description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339),

            section 14.29.

            '
          format: date-time
          type: string
      required:
      - operationType
      - status
      - id
      - compartmentId
      - resources
      - percentComplete
      - timeAccepted
  responses:
    default:
      description: Unknown Error
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

            Oracle about a particular request, please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-anchors:
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    opc-next-page:
      description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

        then a partial list might have been returned. Include this value as the `page` parameter for the

        subsequent GET request to get the next batch of items.

        '
      type: string
    opc-request-id:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

        Oracle about a particular request, please provide the request ID.

        '
      type: string
    opc-work-request-id:
      description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

        '
      type: string
    retry-after:
      description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
      format: float
      type: number
  x-properties:
    definedTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

            '
          type: object
        description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

          Example: `{"bar-key": "value"}`

          '
        type: object
      description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

        Example: `{"foo-namespace": {"bar-key": "value"}}`

        '
      type: object
    freeformTags:
      additionalProperties:
        type: string
      description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

        Example: `{"bar-key": "value"}`

        '
      type: object
x-oracle-package: com.oracle.blockchain