Oracle Byol Allocation API

openapi: 3.2.0
info:
  description: "Use the Oracle Cloud VMware API to create SDDCs and manage ESXi hosts and software. \nFor more information, see [Oracle Cloud VMware Solution](/iaas/Content/VMware/Concepts/ocvsoverview.htm).\n"
  title: Oracle Cloud VMware Solution Byol Allocation API
  version: '20230701'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/0ad4a7e38b48f3a2cbc0d7ed0bde083759a3aaafa2b2bd5a8e5ced4dbe7541d0.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Oracle Cloud VMware Solution 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/0ad4a7e38b48f3a2cbc0d7ed0bde083759a3aaafa2b2bd5a8e5ced4dbe7541d0.yaml
    what: the harvested document for Oracle Cloud VMware Solution API
servers:
- url: http://127.0.0.1/20230701
- url: https://127.0.0.1/20230701
tags:
- name: byolAllocation
paths:
  /byolAllocations:
    get:
      description: 'Lists the BYOL Allocations in the specified compartment. The list can be

        filtered by display name or availability domain.

        '
      operationId: ListByolAllocations
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/ByolAllocationIdentifierQueryParam'
      - $ref: '#/components/parameters/ByolAllocationLifecycleStateQueryParam'
      - $ref: '#/components/parameters/ByolAllocationSoftwareTypeQueryParam'
      - $ref: '#/components/parameters/ByolAllocationAvailableUnitsGreaterThanOrEqualToQueryParam'
      - $ref: '#/components/parameters/ByolIdentifierQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/ByolAllocationSortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of BYOL Allocations is retrieved..
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages

                of results remain. For important details about how pagination works, see

                [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              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/ByolAllocationCollection'
        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 the BYOL Allocations in the specified compartment
      tags:
      - byolAllocation
      x-related-resource: '#/definitions/ByolAllocationSummary'
    post:
      description: 'Creates an Allocation on an specific Bring-You-Own-License (BYOL).


        Use the [WorkRequest](#/en/vmware/20230701/WorkRequest/) operations to track the

        creation of the BYOL.

        '
      operationId: CreateByolAllocation
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: The request was accepted and the BYOL Allocation 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'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates an BYOL Allocation
      tags:
      - byolAllocation
      x-related-resource: '#/definitions/ByolAllocation'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateByolAllocationDetails'
        description: Details for the BYOL Allocation.
        required: true
  /byolAllocations/{byolAllocationId}:
    delete:
      description: 'Deletes the specified BYOL Allocation.

        '
      operationId: DeleteByolAllocation
      parameters:
      - $ref: '#/components/parameters/ByolAllocationIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: The request was accepted and the BYOL Allocation 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'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Deletes the specified BYOL Allocation
      tags:
      - byolAllocation
      x-related-resource: '#/definitions/ByolAllocation'
    get:
      description: Gets the specified BYOL Allocation's information.
      operationId: GetByolAllocation
      parameters:
      - $ref: '#/components/parameters/ByolAllocationIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The BYOL Allocation was retrieved.
          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/ByolAllocation'
        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 BYOL Allocation
      tags:
      - byolAllocation
      x-related-resource: '#/definitions/ByolAllocation'
    put:
      description: 'Updates the specified BYOL Allocation.

        '
      operationId: UpdateByolAllocation
      parameters:
      - $ref: '#/components/parameters/ByolAllocationIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: The BYOL Allocation was updated.
          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'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Updates the specified BYOL Allocation
      tags:
      - byolAllocation
      x-related-resource: '#/definitions/ByolAllocation'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateByolAllocationDetails'
        description: The information to be updated.
        required: true
  /byolAllocations/{byolAllocationId}/actions/changeCompartment:
    post:
      description: 'Moves an BYOL Allocation into a different compartment within the same tenancy. For information

        about moving resources between compartments, see

        [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

        '
      operationId: ChangeByolAllocationCompartment
      parameters:
      - $ref: '#/components/parameters/ByolAllocationIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The BYOL Allocation has been moved to the specified compartment.
          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
        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: Moves an BYOL Allocation into a different compartment within the same tenancy
      tags:
      - byolAllocation
      x-related-resource: '#/definitions/ByolAllocation'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeByolAllocationCompartmentDetails'
        description: Request to change the compartment of the specified BYOL Allocation
        required: true
components:
  schemas:
    ByolAllocation:
      description: "An allocation of [Oracle Cloud VMware Solution](/iaas/Content/VMware/Concepts/ocvsoverview.htm) \nBring-Your-Own-License (BYOL).\n"
      properties:
        allocatedUnits:
          description: 'The quantity of licensed units that allocated to this region.

            '
          type: integer
        availableUnits:
          description: 'The quantity of licensed units that not yet consumed by resources.

            '
          type: integer
        byolId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the BYOL resource from which this BYOL Allocation is derived.

            '
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that

            contains the BYOL Allocation.

            '
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

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

            namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: 'A descriptive name for the BYOL Allocation.

            '
          type: string
        entitlementKey:
          description: 'The Broadcom-supplied identifier of a BYOL license.

            '
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no

            predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the BYOL Allocation.

            '
          type: string
        lifecycleState:
          description: The current state of the BYOL Allocation.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          type: string
        siteId:
          description: 'The hyperscaler identifier in Broadcom systems.

            '
          maxLength: 64
          minLength: 1
          type: string
        softwareType:
          description: "The type of VMware software the BYOL applies to. \nSupported values:\n- VCF (VMware Cloud Foundation)\n- VSAN (VMware vSAN)\n- VDEFEND (VMware vDefend Firewall)\n- AVI_LOAD_BALANCER (VMware Avi Load Balancer)\n"
          enum:
          - VCF
          - VSAN
          - VDEFEND
          - AVI_LOAD_BALANCER
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

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

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

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

            Example: `{orcl-cloud: {free-tier-retain: true}}`

            '
          type: object
        timeCreated:
          description: 'The date and time the BYOL Allocation was created, in the format defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeTermEnd:
          description: 'The date and time when the BYOL Allocation expires and becomes inactive.

            In the format defined by[RFC3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
        timeTermStart:
          description: 'The date and time when the BYOL Allocation becomes active. VMware software functionality cannot begin before this time.

            In the format defined by[RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the BYOL Allocation was updated, in the format defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - displayName
      - lifecycleState
      - softwareType
      - allocatedUnits
      - availableUnits
      - timeTermStart
      - timeTermEnd
      - byolId
      - entitlementKey
      - timeCreated
      - timeUpdated
      - freeformTags
      - definedTags
      - systemTags
      type: object
    CreateByolAllocationDetails:
      description: The details to create a BYOL.
      properties:
        allocatedUnits:
          description: 'The quantity of licensed units that allocated to this region.

            '
          type: integer
        byolId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the BYOL resource from which this BYOL Allocation is derived.

            '
          maxLength: 255
          minLength: 1
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that

            contains the BYOL Allocation.

            '
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

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

            namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: 'A descriptive name for the BYOL Allocation.

            '
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no

            predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
      required:
      - byolId
      - allocatedUnits
      - compartmentId
      - displayName
      type: object
    UpdateByolAllocationDetails:
      description: The details to update BYOL.
      properties:
        allocatedUnits:
          description: 'The quantity of licensed units that allocated to this region.

            '
          type: integer
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

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

            namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: 'A descriptive name for the BYOL Allocation.

            '
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no

            predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
      type: object
    ChangeByolAllocationCompartmentDetails:
      description: The configuration details for the move operation.
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to move

            the BYOL Allocation to.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
    ByolAllocationSummary:
      description: "An allocation of [Oracle Cloud VMware Solution](/iaas/Content/VMware/Concepts/ocvsoverview.htm) \nBring-Your-Own-License (BYOL).\n"
      properties:
        allocatedUnits:
          description: 'The quantity of licensed units that allocated to this region.

            '
          type: integer
        availableUnits:
          description: 'The quantity of licensed units that not yet consumed by resources.

            '
          type: integer
        byolId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the BYOL resource from which this BYOL Allocation is derived.

            '
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that

            contains the BYOL Allocation.

            '
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

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

            namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: 'A descriptive name for the BYOL Allocation.

            '
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no

            predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the BYOL Allocation.

            '
          type: string
        lifecycleState:
          description: "The current state of the BYOL Allocation. \nAccepted values are:\n- CREATING\n- ACTIVE\n- INACTIVE\n- UPDATING\n- DELETING\n- DELETED\n- FAILED\n"
          type: string
          x-obmcs-enumref: '#/definitions/ByolAllocation/lifecycleState'
        softwareType:
          description: "The type of VMware software the BYOL Allocation applies to. \nSupported values:\n- VCF (VMware Cloud Foundation)\n- VSAN (VMware vSAN)\n- VDEFEND (VMware vDefend Firewall)\n- AVI_LOAD_BALANCER (VMware Avi Load Balancer)\n"
          type: string
          x-obmcs-enumref: '#/definitions/ByolAllocation/softwareType'
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

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

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

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

            Example: `{orcl-cloud: {free-tier-retain: true}}`

            '
          type: object
        timeCreated:
          description: 'The date and time the BYOL Allocation was created, in the format defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeTermEnd:
          description: 'The date and time when the BYOL Allocation expires and becomes inactive.

            In the format defined by[RFC3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
        timeTermStart:
          description: 'The date and time when the BYOL Allocation becomes active. VMware software functionality cannot begin before this time.

            In the format defined by[RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the BYOL Allocation was updated, in the format defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - displayName
      - lifecycleState
      - softwareType
      - allocatedUnits
      - availableUnits
      - timeTermStart
      - timeTermEnd
      - byolId
      - timeCreated
      - timeUpdated
      - freeformTags
      - definedTags
      - systemTags
      type: object
    Error:
      description: Error Information.
      properties:
        code:
          description: 'A short error code that defines the error, meant for programmatic parsing. See

            [API Errors](/Content/API/References/apierrors.htm).

            '
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    ByolAllocationCollection:
      description: A list of BYOL Allocations.
      properties:
        items:
          description: A list of BYOL Allocations.
          items:
            $ref: '#/components/schemas/ByolAllocationSummary'
          type: array
      required:
      - items
      type: object
  parameters:
    ByolAllocationAvailableUnitsGreaterThanOrEqualToQueryParam:
      description: A filter to return only resources whose availableUnits greater than or equal to the given value.
      in: query
      name: availableUnitsGreaterThanOrEqualTo
      x-default-description: 'null'
      schema:
        type: number
        format: float
    ByolIdentifierQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the BYOL.
      in: query
      name: byolId
      x-default-description: 'null'
      schema:
        type: string
    ByolAllocationLifecycleStateQueryParam:
      description: A filter to return only resources whose lifecycle state matches the given value.
      in: query
      name: lifecycleState
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/ByolAllocation/lifecycleState'
      schema:
        type: string
    SortOrderQueryParam:
      description: 'The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order

        is case sensitive.

        '
      in: query
      name: sortOrder
      x-obmcs-top-level-enum: '#/definitions/SortOrders'
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: ASC
    ByolAllocationIdentifierPathParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the BYOL Allocation.
      in: path
      name: byolAllocationId
      required: true
      schema:
        type: string
    ByolAllocationIdentifierQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the BYOL Allocation.
      in: query
      name: byolAllocationId
      x-default-description: 'null'
      schema:
        type: string
    RequestIdHeader:
      description: 'Unique identifier for the request. If you need to contact Oracle about a particular

        request, please provide the request ID.

        '
      in: header
      name: opc-request-id
      schema:
        type: string
    PaginationTokenQueryParam:
      description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List"

        call. For important details about how pagination works, see

        [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      in: query
      name: page
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 1024
        minLength: 1
    DisplayNameQueryParam:
      description: A filter to return only resources that match the given display name exactly.
      in: query
      name: displayName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    ByolAllocationSoftwareTypeQueryParam:
      description: A filter to return only resources whose softwareType matches the given value.
      in: query
      name: softwareType
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/ByolAllocation/softwareType'
      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

        may be rejected).

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
    ByolAllocationSortByQueryParam:
      description: "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\n`timeTermStart` is descending. Default order for `timeCreated` is descending. \nDefault order for `displayName` is ascending. The `displayName`\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n"
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - displayName
        - timeCreated
        - timeTermStart
        default: timeTermStart
    CompartmentIdQueryParam:
      description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
    PaginationLimitQueryParam:
      description: 'For list pagination. The maximum number of results per page, or items to return in a paginated

        "List" call. For important details about how pagination works, see

        [List Pagination](/iaas/Content/API/Concepts/

# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-byolallocation-api-openapi.yml