Oracle Weblogic Management Service Configuration API

openapi: 3.2.0
info:
  description: 'WebLogic Management Service is an OCI service that enables a unified view and management of WebLogic domains

    in Oracle Cloud Infrastructure. Features include on-demand patching of WebLogic domains, rollback of the

    last applied patch, discovery and management of WebLogic instances on a compute host.

    '
  title: WebLogic Management Service Weblogic Management Service Configuration API
  version: '20241101'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/e8fef564dd08c35d57daf974e853a3ca0458970812b456487fa37223ed925cf7.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the WebLogic Management Service 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/e8fef564dd08c35d57daf974e853a3ca0458970812b456487fa37223ed925cf7.yaml
    what: the harvested document for WebLogic Management Service API
servers:
- url: /20241101
tags:
- name: weblogicManagementServiceConfiguration
paths:
  /configuration:
    get:
      description: 'Gets service configuration.

        '
      operationId: GetConfiguration
      parameters:
      - $ref: '#/components/parameters/CompartmentIdRequiredQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The service configuration 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/Configuration'
        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/DefaultError'
      summary: Gets service configuration.
      tags:
      - weblogicManagementServiceConfiguration
      x-related-resource: '#/definitions/Configuration'
    put:
      description: 'Updates service configuration.

        '
      operationId: UpdateConfiguration
      parameters:
      - $ref: '#/components/parameters/CompartmentIdRequiredQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        200:
          description: The service configuration was updated.
          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/Configuration'
        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/DefaultError'
      summary: Update service configuration.
      tags:
      - weblogicManagementServiceConfiguration
      x-obmcs-terraform:
        actionType: UPDATE
      x-related-resource: '#/definitions/Configuration'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConfigurationDetails'
        description: Details for service configuration.
        required: true
components:
  parameters:
    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
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      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
    CompartmentIdRequiredQueryParam:
      description: "The OCID of the compartment that contains the resources to list. This filter returns \nonly resources contained within the specified compartment.\n"
      in: query
      name: compartmentId
      required: true
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
  schemas:
    Configuration:
      description: 'The configuration for service.

        '
      properties:
        discoveryInterval:
          description: Frequency of domain discovery to be run on the service. The unit is in hours.
          type: integer
        domainSearchPaths:
          description: The whitelisted paths which domain discovery are run against.
          items:
            type: string
          minItems: 1
          type: array
          uniqueItems: true
      required:
      - discoveryInterval
      - domainSearchPaths
      type: object
    UpdateConfigurationDetails:
      description: 'The configuration for service.

        '
      properties:
        discoveryInterval:
          description: Frequency of domain discovery to be run on the service. The unit is in hours.
          maximum: 24
          minimum: 6
          type: integer
        domainSearchPaths:
          description: The whitelisted paths which domain discovery are run against.
          items:
            type: string
          maxItems: 20
          minItems: 1
          type: array
          uniqueItems: true
      type: object
    DefaultError:
      description: 'Error information.

        '
      properties:
        code:
          description: A short error code that defines the error and is meant for programmatic parsing.
          maxLength: 255
          minLength: 1
          type: string
        message:
          description: A human-readable error string.
          maxLength: 1024
          minLength: 1
          type: string
      required:
      - code
      - message
  responses:
    DefaultError:
      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/DefaultError'
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.
      type: integer
  x-properties:
    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 and 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](/iaas/Content/General/Concepts/resourcetags.htm).


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

        '
      type: object
    freeformTags:
      additionalProperties:
        type: string
      description: 'Free-form tags for this resource. Each tag is a key-value pair with no predefined name, type, or namespace.

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


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

        '
      type: object
    systemTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only the String type is supported.

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


          Example: `{"free-tier-retained": "true"}`

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


        Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

        '
      type: object
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.wlms.cp