openapi: 3.2.0
info:
  description: 'Use the Connector Hub API to transfer data between services in Oracle Cloud Infrastructure.

    For more information about Connector Hub, see

    [the Connector Hub documentation](/iaas/Content/connector-hub/home.htm).

    Connector Hub is formerly known as Service Connector Hub.

    '
  title: Connector Hub Service Connector API
  version: '20200909'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/23d281837e4b021adcde2cd8fb72e929da1a886c4122c7403ffaa25526a68b61.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Connector Hub 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/23d281837e4b021adcde2cd8fb72e929da1a886c4122c7403ffaa25526a68b61.yaml
    what: the harvested document for Connector Hub API
servers:
- url: https://127.0.0.1/20200909
tags:
- name: serviceConnector
paths:
  /serviceConnectors:
    get:
      description: 'Lists connectors in the specified compartment.

        For more information, see

        [Listing Connectors](/iaas/Content/connector-hub/list-service-connector.htm).

        '
      operationId: ListServiceConnectors
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'The list of connectors was 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-prev-page:
              description: 'For list pagination.  When this header appears in the response,

                previous pages of results exist. 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/ServiceConnectorCollection'
        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 connectors in the specified compartment.
      tags:
      - serviceConnector
      x-example: 'Sample 1: List all active connectors, sorted by name


        GET /20200909/serviceConnectors?compartmentId=<var>&lt;compartment_OCID&gt;</var>&lifecycleState="ACTIVE"&sortBy="displayName"

        Host: service-connector-hub.us-phoenix-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>


        Sample 2: List connectors that have the name "StreamLogs"


        GET /20200909/serviceConnectors?compartmentId=<var>&lt;compartment_OCID&gt;</var>&displayName="StreamLogs"

        Host: service-connector-hub.us-phoenix-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/ServiceConnector'
    post:
      description: 'Creates a new connector in the specified compartment.

        A connector is a logically defined flow for moving data from

        a source service to a destination service in Oracle Cloud Infrastructure.

        For more information, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        For general information about connectors, see

        [Overview of Connector Hub](/iaas/Content/connector-hub/overview.htm).


        For purposes of access control, you must provide the

        [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where

        you want the connector to reside. Notice that the connector

        doesn''t have to be in the same compartment as the source or target services.

        For information about access control and compartments, see

        [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).


        After you send your request, the new connector''s state is temporarily

        CREATING. When the state changes to ACTIVE, data begins transferring from the

        source service to the target service. For instructions on deactivating and

        activating connectors, see

        [Activating a Connector](/iaas/Content/connector-hub/activate-service-connector.htm).

        '
      operationId: CreateServiceConnector
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: 'The request to create a connector was accepted for processing.

            '
          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 a new connector.
      tags:
      - serviceConnector
      x-example: "Sample 1: Logging to Streaming\n\nPOST /20200909/serviceConnectors\nHost: service-connector-hub.us-phoenix-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"displayName\": \"My Log to Stream Connector\",\n  \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n  \"description\": \"My connector description\",\n  \"source\": {\n    \"kind\": \"logging\",\n    \"logSources\": [\n      {\n        \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n        \"logGroupId\": \"<var>&lt;log_group_OCID&gt;</var>\",\n        \"logId\": \"<var>&lt;log_OCID&gt;</var>\"\n      },\n      {\n        \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n        \"logGroupId\": \"<var>&lt;log_group_OCID&gt;</var>\",\n        \"logId\": \"<var>&lt;log_OCID&gt;</var>\"\n      }\n    ]\n  },\n  \"tasks\": [\n    {\n      \"kind\": \"logRule\",\n      \"condition\": \"data.action='REJECT'\"\n    },\n    {\n      \"kind\": \"logRule\",\n      \"condition\": \"oracle.tenantid!=<var>&lt;tenancy_OCID&gt;</var>\"\n    }\n  ],\n  \"target\": {\n    \"kind\": \"streaming\",\n    \"streamId\": \"<var>&lt;stream_OCID&gt;</var>\"\n  }\n}\n\nSample 2: Queue to Function\n\nPOST /20200909/serviceConnectors\nHost: service-connector-hub.us-phoenix-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"displayName\": \"My Queue to Function Connector\",\n  \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n  \"description\": \"My connector description\",\n  \"source\": {\n    \"kind\": \"plugin\",\n    \"pluginName\": \"QueueSource\",\n    \"configMap\": {\n      \"queueId\": \"<var>&lt;queue_OCID&gt;</var>\"\n    }\n  }\n  \"target\": {\n    \"kind\": \"functions\",\n    \"functionId\": \"<var>&lt;function_OCID&gt;</var>\",\n    \"batchSizeInKbs\": \"5000\",\n    \"batchSizeInNum\": \"10\",\n    \"batchTimeInSec\": \"60\"\n  }\n}\n"
      x-related-resource: '#/definitions/ServiceConnector'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateServiceConnectorDetails'
        description: 'Configuration details for the new connector.

          '
        required: true
  /serviceConnectors/{serviceConnectorId}:
    delete:
      description: 'Deletes the specified connector.

        For more information, see

        [Deleting a Connector](/iaas/Content/connector-hub/delete-service-connector.htm).


        After you send your request, the connector''s state is temporarily

        DELETING and any data transfer stops. The state then changes to DELETED.

        '
      operationId: DeleteServiceConnector
      parameters:
      - $ref: '#/components/parameters/ServiceConnectorIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: 'The request to delete the connector was accepted for processing.

            '
          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: Deletes the specified connector.
      tags:
      - serviceConnector
      x-related-resource: '#/definitions/ServiceConnector'
    get:
      description: 'Gets the specified connector''s configuration information.

        For more information, see

        [Getting a Connector](/iaas/Content/connector-hub/get-service-connector.htm).

        '
      operationId: GetServiceConnector
      parameters:
      - $ref: '#/components/parameters/ServiceConnectorIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'The information 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/ServiceConnector'
        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: Gets the specified connector's configuration information.
      tags:
      - serviceConnector
    put:
      description: 'Updates the configuration information for the specified connector.

        For more information, see

        [Updating a Connector](/iaas/Content/connector-hub/update-service-connector.htm).


        After you send your request, the connector''s state is temporarily

        UPDATING and any data transfer pauses. The state then changes back to its

        original value: if ACTIVE, then data transfer resumes.

        '
      operationId: UpdateServiceConnector
      parameters:
      - $ref: '#/components/parameters/ServiceConnectorIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: 'The request to update the connector was accepted for processing.

            '
          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: Updates the configuration information for the specified connector.
      tags:
      - serviceConnector
      x-related-resource: '#/definitions/ServiceConnector'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateServiceConnectorDetails'
        description: 'The information to be updated.

          '
        required: true
  /serviceConnectors/{serviceConnectorId}/actions/activate:
    post:
      description: 'Activates the specified connector.


        After you send your request, the connector''s state is temporarily

        UPDATING. When the state changes to ACTIVE, data begins transferring from the

        source service to the target service.

        For more information, see

        [Activating a Connector](/iaas/Content/connector-hub/activate-service-connector.htm).

        '
      operationId: ActivateServiceConnector
      parameters:
      - $ref: '#/components/parameters/ServiceConnectorIdentifierPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: 'The request to activate the connector 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: Activate the ServiceConnector identified by the id
      tags:
      - serviceConnector
      x-related-resource: '#/definitions/ServiceConnector'
  /serviceConnectors/{serviceConnectorId}/actions/changeCompartment:
    post:
      description: 'Moves a connector into a different compartment within the same tenancy.

        For more information, see

        [Moving a Connector](/iaas/Content/connector-hub/change-compartment-service-connector.htm).


        When provided, If-Match is checked against ETag values of the resource.

        '
      operationId: ChangeServiceConnectorCompartment
      parameters:
      - $ref: '#/components/parameters/ServiceConnectorIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: 'The request to move the connector to a different compartment was accepted for processing.

            '
          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
        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'
      summary: Moves a connector into a different compartment within the same tenancy.
      tags:
      - serviceConnector
      x-related-resource: '#/definitions/ServiceConnector'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeServiceConnectorCompartmentDetails'
        description: 'The configuration details for moving a connector to a different compartment.

          '
        required: true
  /serviceConnectors/{serviceConnectorId}/actions/deactivate:
    post:
      description: 'Deactivates the specified connector.


        After you send your request, the connector''s state is temporarily

        UPDATING and any data transfer stops. The state then changes to INACTIVE.

        For more information, see

        [Deactivating a Connector](/iaas/Content/connector-hub/deactivate-service-connector.htm).

        '
      operationId: DeactivateServiceConnector
      parameters:
      - $ref: '#/components/parameters/ServiceConnectorIdentifierPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: 'The request to deactivate the connector 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: Deactivates the specified connector.
      tags:
      - serviceConnector
      x-related-resource: '#/definitions/ServiceConnector'
  /workRequests:
    get:
      description: 'Lists the work requests in the specified compartment.

        For more information, see

        [Listing Work Requests](/iaas/Content/connector-hub/list-work-request.htm).

        '
      operationId: ListWorkRequests
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        200:
          description: 'The list of work requests was 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-prev-page:
              description: 'For list pagination.  When this header appears in the response,

                previous pages of results exist. 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/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: Lists the work requests in the specified compartment.
      tags:
      - serviceConnector
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}:
    get:
      description: 'Gets the details of the specified work request.

        For more information, see

        [Getting a Work Request''s Details](/iaas/Content/connector-hub/get-work-request.htm).

        '
      operationId: GetWorkRequest
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'The work request was retrieved.

            '
          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
            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: Gets the details of the specified work request.
      tags:
      - serviceConnector
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}/errors:
    get:
      description: 'Lists work request errors for the specified work request. Results are paginated.

        For more information, see

        [Listing Work Request Errors](/iaas/Content/connector-hub/list-work-request-error.htm).

        '
      operationId: ListWorkRequestErrors
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        200:
          description: 'The list of work request errors was 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-prev-page:
              description: 'For list pagination.  When this header appears in the response,

                previous pages of results exist. 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/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: LLists work request errors for the specified work request. Results are paginated.
      tags:
      - serviceConnector
      x-related-resource: '#/definitions/WorkRequestError'
  /workRequests/{workRequestId}/logs:
    get:
      description: 'Lists logs for the specified work request. Results are paginated.

        For more information, see

        [Listing Work Request Log Entries](/iaas/Content/connector-hub/list-work-request-log-entry.htm).

        '
      operationId: ListWorkRequestLogs
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        200:
          description: 'The list of work request logs was 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-prev-page:
              description: 'For list pagination.  When this header appears in the response,

                previous pages of results exist. 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/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 errors for the specified work request. Results are paginated.
      tags:
      - serviceConnector
      x-related-resource: '#/definitions/WorkRequestLogEntry'
components:
  schemas:
    PrivateEndpointMetadata:
      description: 'The private endpoint metadata for the connector''s source or target.

        '
      properties:
        rceDnsProxyIpAddress:
          description: 'The reverse connection endpoint (RCE) IP address for DNS lookups.

            '
          maxLength: 255
          type: string
        rceTrafficIpAddress:
          description: 'The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet.

            '
          maxLength: 255
          type: string
    ServiceConnectorCollection:
      description: 'Collection of connector property summaries.

        '
      properties:
        items:
          description: 'The list of items.

            '
          items:
            $ref: '#/components/schemas/ServiceConnectorSummary'
          type: array
      required:
      - items
      type: object
    UpdateServiceConnectorDetails:
      description: 'The configuration details for updating a connector.

        '
      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: 'The description of the resource. Avoid entering confidential information.

            '
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly name. It does not have to be unique, and it is changeable.

            Avoid entering confidential information.

            '
          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
        source:
          $ref: '#/components/schemas/SourceDetails'
        target:
          $ref: '#/components/schemas/TargetDetails'
        tasks:
          description: 'The list of the tasks.

            '
          items:
            $ref: '#/components/schemas/TaskDetails'
          maxItems: 1
          type: array
      type: object
    CreateServiceConnectorDetails:
      description: 'The configuration details for creating a connector.

        '
      properties:
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the

            comparment to create the connector in.

            '
          maxLength: 255
          minLength: 1
          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: 'The description of the resource. Avoid entering confidential information.

            '
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly name. It does not have to be unique, and it is changeable.

            Avoid entering confidential information.

            '
          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
        source:
          $ref: '#/components/schemas/SourceDetails'
        target:
          $ref: '#/components/schemas/TargetDetails'
        tasks:
          description: 'The list of tasks.

            '
          items:
            $ref: '#/components/schemas/TaskDetails'
          maxItems: 1
          type: array
      required:
      - displayName
      - compartmentId
      - source
      - target
      type: object
      x-example: "Sample 1: Logging to Streaming\n{\n  \"displayName\": \"My Log to Stream Connector\",\n  \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n  \"description\": \"My connector description\",\n  \"source\": {\n    \"kind\": \"logging\",\n    \"logSources\": [\n      {\n        \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n        \"logGroupId\": \"<var>&lt;log_group_OCID&gt;</var>\",\n        \"logId\": \"<var>&lt;log_OCID&gt;</var>\"\n      },\n      {\n        \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n        \"logGroupId\": \"<var>&lt;log_group_OCID&gt;</var>\",\n        \"logId\": \"<var>&lt;log_OCID&gt;</var>\"\n      }\n    ]\n  },\n  \"tasks\": [\n    {\n      \"kind\": \"logRule\",\n      \"condition\": \"data.action='REJECT'\"\n    },\n    {\n      \"kind\": \"logRule\",\n      \"condition\": \"oracle.tenantid!=<var>&lt;tenancy_OCID&gt;</var>\"\n    }\n  ],\n  \"target\": {\n    \"kind\": \"streaming\",\n    \"streamId\": \"<var>&lt;stream_OCID&gt;</var>\"\n  }\n}\n\nSample 2: Queue to Function\n{\n  \"displayName\": \"My Queue to Function Connector\",\n  \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n  \"description\": \"My connector description\",\n  \"source\": {\n    \"kind\": \"plugin\",\n    \"pluginName\": \"QueueSource\",\n    \"configMap\": {\n      \"queueId\": \"<var>&lt;queue_OCID&gt;</var>\"\n    }\n  }\n  \"target\": {\n    \"kind\": \"functions\",\n    \"functionId\": \"<var>&lt;function_OCID&gt;</var>\",\n    \"batchSizeInKbs\": \"5000\",\n    \"batchSizeInNum\": \"10\",\n    \"batchTimeInSec\": \"60\"\n  }\n}\n"
    SourceDetails:
      description: 'An object that represents the source of the flow defined by the connector.

        An example source is the VCNFlow logs within the NetworkLogs group.

        For more information about flows defined by connectors, see

        [Overview of Connector Hub](/iaas/Content/connector-hub/overview.htm).

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
      discriminator:
        propertyName: kind
      properties:
        kind:
          description: 'The type discriminator.

            '
          enum:
          - logging
          - monitoring
          - streaming
          - plugin
          type: string
      required:
      - kind
    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
    ChangeServiceConnectorCompartmentDetails:
      description: 'The configuration details for moving a connector to a different compartment.

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

            to move the connector to.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
    ServiceConnector:
      description: 'The configuration details of the flow defined by the connector.

        For more information about flows defined by connectors, see

        [Overview of Connector Hub](/iaas/Content/connector-hub/overview.htm).

        '
      properties:
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the connector.

            '
          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: 'The description of the resource. Avoid entering confidential information.

            '
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly name. It does not have to be unique, and it is changeable.

            Avoid entering confidential information.

            '
          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: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the connector.

            '
          type: string
        lifecycleDetails:
          description: 'A message describing the current state in more detail.

            For example, the message might provide actionable

            information for a resource in a `FAILED` state.

            '
          type: string
        lifecycleState:
          description: 'The current state of the connector.

            '
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - INACTIVE
          - NEEDS_ATTENTION
          - DELETING
          - DELETED
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        lifecyleDetails:
          description: '*Please note this property is deprecated and will be removed on March 25, 2026. Use `lifecycleDetails` instead.*

            A message describing the current state in more detail.

            For example, the message might provide actionable

            information for a resource in a `FAILED` state.

            '
          type: string
        source:
          $ref: '#/components/schemas/SourceDetailsResponse'
        systemTags:
          additionalProperties:
            additionalProperties:
              type: object
            type: object
          description: 'The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces.

            For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).

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

            '
          type: object
        target:
          $ref: '#/components/schemas/TargetDetailsResponse'
        tasks:
          description: 'The list of tasks.

            '
          items:
            $ref: '#/components/schemas/TaskDetailsResponse'
          type: array
        timeCreated:
          description: 'The date and time when the connector was created.

            Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2020-01-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time when the connector was updated.

            Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2020-01-25T21:10:29.600Z`

            '
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - displayName
      - lifecycleState
      - timeCreated
      - timeUpdated
      type: object
      x-example: "Sample: Streaming to Streaming (private endpoints)\n\n{\n  \"id\": \"<var>&lt;connector_OCID&gt;</var>\", \n  \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n  \"displayName\": \"My Streaming Connector\",\n  \"lifeCycleState\": \"ACTIVE\",\n  \"timeCreated\": \"2020-01-25T21:10:29.600Z\",\n  \"timeUpdated\": \"2020-01-26T11:10:00.000Z\",\n  \"source\": {\n    \"kind\": \"streaming\",\n    \"streamId\": \"<var>&lt;stream_OCID&gt;</var>\",\n    \"cursor\" : {\n        \"kind\": \"LATEST\"\n    }\n    \"privateEndpointMetadata\": {\n        \"rceTrafficIpAddress\": \"10.0.0.2\",\n        \"rceDnsIpAddress\": \"10.0.0.3\"\n    }\n  },\n  \"task\": null,\n  \"target\": {\n    \"kind\": \"streaming\",\n    \"streamId\": \"<var>&lt;stream_OCID&gt;</var>\"\n    \"privateEndpointMetadata\": {\n        \"rceTrafficIpAddress\": \"10.1.0.2\",\n        \"rceDnsIpAddress\": \"10.1.0.3\"\n    }\n  },\n  freeformTags: {\"foo-namespace\": {\"bar-key\": \"value\"}},\n  definedTags: null,\n  systemTags: null\n}\n"
    WorkRequestCollection:
      description: 'Collection of work requests.

        '
      properties:
        items:
          description: 'The list of items.

            '
          items:
            $ref: '#/components/schemas/WorkRequest'
          type: array
      required:
      - items
      type: object
    TaskDetailsResponse:
      description: 'An object that represents a task within the flow defined by the connector.

        An example task is a filter for error logs.

        For more information about flows defined by connectors, see

        [Overview of Connector Hub](/iaas/Content/connector-hub/overview.htm).

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
      discriminator:
        propertyName: kind
      properties:
        kind:
          description: 'The type discriminator.

            '
          enum:
          - function
          - logRule
          type: string
        privateEndpointMetadata:
          $ref: '#/components/schemas/PrivateEndpointMetadata'
      required:
      - kind
      x-example: "{\n  \"kind\": \"logRule\",\n  \"condition\": \"data.action='REJECT'\"\n  \"privateEndpointMetadata\": {}\n}\n"
    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
          x-obmcs-top-level-enum: '#/definitions/ActionType'
        entityType:
          description: 'The resource type the work request affects.

            '
          type: string
        entityUri:
          description: 'The URI path that you can use for a GET request to access the resource metadata.

            '
          type: string
        identifier:
          description: 'An OCID or other unique identifier for the resource affected by the work request.

            '
          type: string
      required:
      - actionType
      - entityType
      - identifier
    SourceDetailsResponse:
      description: 'An object that represents the source of the flow defined by the connector.

        An example source is the VCNFlow logs within the NetworkLogs group.

        For more information about flows defined by connectors, see

        [Overview of Connector Hub](/iaas/Content/connector-hub/overview.htm).

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
      discriminator:
        propertyName: kind
      properties:
        kind:
          description: 'The type discriminator.

            '
          enum:
          - logging
          - monitoring
          - streaming
          - plugin
          type: string
        privateEndpointMetadata:
          $ref: '#/components/schemas/PrivateEndpointMetadata'
      required:
      - kind
    ServiceConnectorSummary:
      description: 'A summary of properties for the specified connector.

        '
      properties:
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the connector.

            '
          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: 'The description of the resource. Avoid entering confidential information.

            '
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly name. It does not have to be unique, and it is changeable.

            Avoid entering confidential information.

            '
          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: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the connector.

            '
          type: string
        lifecycleDetails:
          description: 'A message describing the current state in more detail.

            For example, the message might provide actionable

            information for a resource in a `FAILED` state.

            '
          type: string
        lifecycleState:
          description: 'The current state of the connector.

            '
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - INACTIVE
          - NEEDS_ATTENTION
          - DELETING
          - DELETED
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        systemTags:
          additionalProperties:
            additionalProperties:
              type: object
            type: object
          description: 'The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces.

            For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).

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

            '
          type: object
        timeCreated:
          description: 'The date and time when the connector was created.

            Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2020-01-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time when the connector was updated.

            Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2020-01-25T21:10:29.600Z`

            '
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - displayName
      - lifecycleState
      - timeCreated
      - timeUpdated
      type: object
    WorkRequestErrorCollection:
      description: 'Collection of work request errors.

        '
      properties:
        items:
          description: 'The list of items.

            '
          items:
            $ref: '#/components/schemas/WorkRequestError'
          type: array
      required:
      - items
      type: object
    TargetDetailsResponse:
      description: 'An object that represents the target of the flow defined by the connector.

        An example target is a stream (Streaming service).

        For more information about flows defined by connectors, see

        [Overview of Connector Hub](/iaas/Content/connector-hub/overview.htm).

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
      discriminator:
        propertyName: kind
      properties:
        kind:
          description: 'The type discriminator.

            '
          enum:
          - functions
          - loggingAnalytics
          - monitoring
          - notifications
          - objectStorage
          - streaming
          type: string
        privateEndpointMetadata:
          $ref: '#/components/schemas/PrivateEndpointMetadata'
      required:
      - kind
    WorkRequestError:
      description: 'An error encountered while executing a work request.

        '
      properties:
        code:
          description: 'A machine-usable code for the error that occured. See

            [API Errors](https://docs.cloud.oracle.com/Content/API/References/apierrors.htm).

            '
          type: string
        message:
          description: 'A human readable description of the issue encountered.

            '
          type: string
        timestamp:
          description: 'The date and time when the error occurred.

            Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2020-01-25T21:10:29.600Z`

            '
          format: date-time
          type: string
      required:
      - code
      - message
      - timestamp
    TaskDetails:
      description: 'An object that represents a task within the flow defined by the connector.

        An example task is a filter for error logs.

        For more information about flows defined by connectors, see

        [Overview of Connector Hub](/iaas/Content/connector-hub/overview.htm).

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
      discriminator:
        propertyName: kind
      properties:
        kind:
          description: 'The type discriminator.

            '
          enum:
          - function
          - logRule
          type: string
      required:
      - kind
      x-example: "{\n  \"kind\": \"logRule\",\n  \"condition\": \"data.action='REJECT'\"\n}\n"
    WorkRequestLogEntry:
      description: 'A log message from the execution of a work request.

        '
      properties:
        message:
          description: 'Human-readable log message.

            '
          type: string
        timestamp:
          description: 'The date and time when the log message was written.

            Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2020-01-25T21:10:29.600Z`

            '
          format: date-time
          type: string
      required:
      - message
      - timestamp
    TargetDetails:
      description: 'An object that represents the target of the flow defined by the connector.

        An example target is a stream (Streaming service).

        For more information about flows defined by connectors, see

        [Overview of Connector Hub](/iaas/Content/connector-hub/overview.htm).

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
      discriminator:
        propertyName: kind
      properties:
        kind:
          description: 'The type discriminator.

            '
          enum:
          - functions
          - loggingAnalytics
          - monitoring
          - notifications
          - objectStorage
          - streaming
          type: string
      required:
      - kind
    WorkRequestLogEntryCollection:
      description: 'Collection of work request logs.

        '
      properties:
        items:
          description: 'The list of items.

            '
          items:
            $ref: '#/components/schemas/WorkRequestLogEntry'
          type: array
      required:
      - items
      type: object
    WorkRequest:
      description: 'An object representing an asynchronous work flow.


        Many of the API requests you use to create and configure

        connectors do not take effect immediately. In these

        cases, the request spawns an asynchronous work flow to fulfill

        the request. WorkRequest objects provide visibility for

        in-progress work flows. For more information about work

        requests, see

        [Viewing the State of a Work Request](/iaas/Content/connector-hub/workrequests.htm).

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

            containing the work request.

            '
          type: string
        id:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.

            '
          type: string
        operationType:
          description: 'The type of action the work request represents.

            '
          enum:
          - CREATE_SERVICE_CONNECTOR
          - UPDATE_SERVICE_CONNECTOR
          - DELETE_SERVICE_CONNECTOR
          - ACTIVATE_SERVICE_CONNECTOR
          - DEACTIVATE_SERVICE_CONNECTOR
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationType'
        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
          x-obmcs-top-level-enum: '#/definitions/OperationStatus'
        timeAccepted:
          description: 'The date and time when the request was created.

            Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2020-01-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeFinished:
          description: 'The date and time when the object finished.

            Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2020-01-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeStarted:
          description: 'The date and time when the request was started.

            Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2020-01-25T21:10:29.600Z`

            '
          format: date-time
          type: string
      required:
      - operationType
      - status
      - id
      - compartmentId
      - resources
      - percentComplete
      - timeAccepted
  parameters:
    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
    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
      schema:
        type: string
        minLength: 1
    CompartmentIdQueryParam:
      description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment for this request.

        '
      in: query
      name: compartmentId
      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
    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/usingapi.htm#nine).

        '
      in: query
      name: limit
      schema:
        type: integer
        default: 100
        maximum: 100
        minimum: 1
    ServiceConnectorIdentifierPathParam:
      description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the connector.

        '
      in: path
      name: serviceConnectorId
      required: true
      schema:
        type: string
    LifecycleStateQueryParam:
      description: 'A filter to return only resources that match the given lifecycle state.


        Example: `ACTIVE`

        '
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/LifecycleState'
      schema:
        type: string
        enum:
        - CREATING
        - UPDATING
        - ACTIVE
        - INACTIVE
        - NEEDS_ATTENTION
        - DELETING
        - DELETED
        - FAILED
    WorkRequestIdPathParam:
      description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work 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
      x-obmcs-top-level-enum: '#/definitions/SortOrder'
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: ASC
    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 filter to return only resources that match the given display name exactly.


        Example: `example_service_connector`

        '
      in: query
      name: displayName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    RequestIdHeader:
      description: 'The unique Oracle-assigned 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
  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-connector-descriptions:
    StreamingSourceDescription:
      description: 'The Streaming source.

        For configuration instructions, see

        [Creating a Connector with a Streaming Source](/iaas/Content/connector-hub/create-service-connector-streaming-source.htm).

        '
      x-example: "{\n  \"kind\": \"streaming\",\n  \"streamId\": \"<var>&lt;stream_OCID&gt;</var>\",\n  \"cursor\" : {\n      \"kind\": \"LATEST\"\n  }\n}\n"
    StreamingSourceResponseDescription:
      description: "The Streaming source response. Private metadata is included when the target is a stream accessed through \na [private endpoint](/iaas/Content/Streaming/Concepts/streamsecurity.htm#private_endpoints).\n"
      x-example: "{\n  \"kind\": \"streaming\",\n  \"streamId\": \"<var>&lt;stream_OCID&gt;</var>\",\n  \"cursor\" : {\n      \"kind\": \"LATEST\"\n  },\n  \"privateEndpointMetadata\": {\n      \"rceTrafficIpAddress\": \"10.0.0.2\",\n      \"rceDnsIpAddress\": \"10.0.0.3\"\n  }\n}\n"
    functionTargetDescription:
      description: 'The destination function for data transferred from the source.

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
      x-example: "Sample 1: Custom batch size of 5,000 kilobytes with maximum batch time of 60 seconds\n{\n  \"kind\": \"functions\",\n  \"functionId\": \"<var>&lt;function_OCID&gt;</var>\",\n  \"batchSizeInKbs\": \"5000\",\n  \"batchTimeInSec\": \"60\"\n}\nSample 2: Custom batch size of 10 messages with maximum batch time of 60 seconds\n{\n  \"kind\": \"functions\",\n  \"functionId\": \"<var>&lt;function_OCID&gt;</var>\",\n  \"batchSizeInNum\": \"10\",\n  \"batchTimeInSec\": \"60\"\n}\n"
    functionTaskDescription:
      description: "The Functions task. \nBatch input for a function can be limited by either size or time. The first limit reached determines the boundary of the batch.\nFor configuration instructions, see\n[Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).\n"
      x-example: "{\n  \"kind\": \"function\",\n  \"functionId\": \"<var>&lt;function_OCID&gt;</var>\",\n  \"batchSizeInKbs\": \"5000\",\n  \"batchTimeInSec\": \"500\"\n}\n"
    logAnalyticsTargetDescription:
      description: 'The destination log group for data transferred from the source.

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
      x-example: "{\n \"kind\": \"loggingAnalytics\",\n \"logSourceIdentifier\": \"<var>&lt;log_source_name&gt;</var>\",\n \"logGroupId\": \"<var>&lt;log_group_OCID&gt;</var>\"\n}\n"
    logRuleTaskDescription:
      description: 'The log filter task.

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
      x-example: "{\n  \"kind\": \"logRule\",\n  \"condition\": \"data.action='REJECT'\"\n}\n"
    loggingSourceDescription:
      description: 'The Logging source.

        For configuration instructions, see

        [Creating a Connector with a Logging Source](/iaas/Content/connector-hub/create-service-connector-logging-source.htm).

        '
      x-example: "{\n  \"kind\": \"logging\",\n  \"logSources\": [\n    {\n      \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n      \"logGroupId\": \"<var>&lt;log_group_OCID&gt;</var>\",\n      \"logId\": \"<var>&lt;log_OCID&gt;</var>\"\n    },\n    {\n      \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n      \"logGroupId\": \"<var>&lt;log_group_OCID&gt;</var>\",\n      \"logId\": \"<var>&lt;log_OCID&gt;</var>\"\n    }\n  ]\n}\n"
    monitoringSourceDescription:
      description: 'The Monitoring source.

        For configuration instructions, see

        [Creating a Connector with a Monitoring Source](/iaas/Content/connector-hub/create-service-connector-monitoring-source.htm).

        '
      x-example: "{\n  \"kind\": \"monitoring\",\n  \"monitoringSources\": [\n    {\n      \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n      \"namespaceDetails\": {\n        \"kind\": \"selected\",\n        \"namespaces\": [\n          {\n            \"namespace\": \"oci_computeagent\",\n            \"metrics\": {\n              \"kind\": \"all\"\n            }\n          },\n          {\n            \"namespace\": \"oci_logging_analytics\",\n            \"metrics\": {\n              \"kind\": \"all\"\n            }\n          }\n        ]\n      }\n    },\n    {\n      \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n      \"namespaceDetails\": {\n        \"kind\": \"selected\",\n        \"namespaces\": [\n          {\n            \"namespace\": \"oci_objectstorage\",\n            \"metrics\": {\n              \"kind\": \"all\"\n            }\n          }\n        ]\n      }\n    }\n  ]\n}\n"
    monitoringTargetDescription:
      description: 'The destination metric for data transferred from the source.

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
      x-example: "{\n  \"kind\": \"monitoring\",\n  \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n  \"metricNamespace\": \"oci_computeagent\",\n  \"metric\": \"CpuUtilization\",\n  \"dimensions\": [\n    {\"name\": \"compartmentId\", \"dimensionValue\": {\"kind\": \"jmesPath\", \"path\": \"logContent.oracle.compartmentId\"}},\n    {\"name\": \"app\", \"dimensionValue\": {\"kind\": \"static\", \"value\": \"DataPlane\"}}\n  ]\n}\n"
    notificationTargetDescription:
      description: 'The destination topic for data transferred from the source.

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
      x-example: "{\n  \"kind\": \"notifications\",\n  \"topicId\": \"<var>&lt;topic_OCID&gt;</var>\"\n}\n"
    objectStorageTargetDescription:
      description: 'The destination bucket for data transferred from the source.

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
      x-example: "{\n  \"kind\": \"objectStorage\",\n  \"bucketName\": \"MyBucket\",\n  \"objectNamePrefix\": \"myprefix\"\n}\n"
    pluginSourceDescription:
      description: 'Details about a connector plugin used to fetch data from a source.

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
      x-example: "{\n  \"kind\": \"plugin\",\n  \"pluginName\": \"QueueSource\",\n  \"configMap\": {\n      \"queueId\": \"<var>&lt;queue_OCID&gt;</var>\"\n  }\n}\n"
    sourceDetailsDescription:
      description: 'An object that represents the source of the flow defined by the connector.

        An example source is the VCNFlow logs within the NetworkLogs group.

        For more information about flows defined by connectors, see

        [Overview of Connector Hub](/iaas/Content/connector-hub/overview.htm).

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
    streamingTargetDescription:
      description: 'The destination stream for data transferred from the source.

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
      x-example: "{\n  \"kind\": \"streaming\",\n  \"streamId\": \"<var>&lt;stream_OCID&gt;</var>\"\n}\n"
    streamingTargetResponseDescription:
      description: "The Streaming target response. Private metadata is included when the target is a stream accessed through \na [private endpoint](/iaas/Content/Streaming/Concepts/streamsecurity.htm#private_endpoints).\n"
      x-example: "{\n  \"kind\": \"streaming\",\n  \"streamId\": \"<var>&lt;stream_OCID&gt;</var>\",\n  \"privateEndpointMetadata\": {\n      \"rceTrafficIpAddress\": \"10.0.0.2\",\n      \"rceDnsIpAddress\": \"10.0.0.3\"\n  }\n}\n"
    targetDetailsDescription:
      description: 'An object that represents the target of the flow defined by the connector.

        An example target is a stream (Streaming service).

        For more information about flows defined by connectors, see

        [Overview of Connector Hub](/iaas/Content/connector-hub/overview.htm).

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
    taskDetailsDescription:
      description: 'An object that represents a task within the flow defined by the connector.

        An example task is a filter for error logs.

        For more information about flows defined by connectors, see

        [Overview of Connector Hub](/iaas/Content/connector-hub/overview.htm).

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
  x-connector-properties:
    functionTargetFields:
      batchSizeInKbs:
        description: 'The batch rollover size in kilobytes.

          Only one size option can be specified: `batchSizeInKbs` or `batchSizeInNum`.

          '
        minimum: 1
        type: integer
      batchSizeInNum:
        description: 'The batch rollover size in number of messages.

          Only one size option can be specified: `batchSizeInKbs` or `batchSizeInNum`.

          '
        minimum: 1
        type: integer
      batchTimeInSec:
        description: 'The batch rollover time in seconds.

          '
        minimum: 60
        type: integer
      functionId:
        description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the function.

          '
        maxLength: 255
        minLength: 1
        type: string
    functionTaskFields:
      batchSizeInKbs:
        description: 'Size limit (kilobytes) for batch sent to invoke the function.

          '
        minimum: 1
        type: integer
      batchTimeInSec:
        description: 'Time limit (seconds) for batch sent to invoke the function.

          '
        minimum: 1
        type: integer
      functionId:
        description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the function to be used as a task.

          '
        maxLength: 255
        type: string
    logAnalyticsTargetFields:
      logGroupId:
        description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Logging Analytics log group.

          '
        maxLength: 255
        minLength: 1
        type: string
      logSourceIdentifier:
        description: 'Identifier of the log source that you want to use for processing data received from the connector source.

          Applies to `StreamingSource` only.

          Equivalent to `name` at [LogAnalyticsSource](#/en/logan-api-spec/latest/LogAnalyticsSource/).

          '
        maxLength: 512
        minLength: 1
        type: string
    logRuleTaskFields:
      condition:
        description: 'A filter or mask to limit the source used in the flow defined by the connector.

          '
        maxLength: 1048576
        minLength: 1
        type: string
    loggingSourceFields:
      logSources:
        description: 'The logs for this Logging source.

          '
        items:
          $ref: '#/components/schemas/LogSource'
        maxItems: 16
        minItems: 1
        type: array
    monitoringSourceFields:
      monitoringSources:
        description: 'One or more compartment-specific lists of metric namespaces to retrieve data from.

          '
        items:
          $ref: '#/components/schemas/MonitoringSource'
        minItems: 1
        type: array
    monitoringTargetFields:
      compartmentId:
        description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric.

          '
        maxLength: 255
        minLength: 1
        type: string
      dimensions:
        description: 'List of dimension names and values.

          '
        items:
          $ref: '#/components/schemas/DimensionDetails'
        maxLength: 15
        minLength: 0
        type: array
      metric:
        description: 'The name of the metric.

          Example: `CpuUtilization`

          '
        maxLength: 1024
        minLength: 1
        type: string
      metricNamespace:
        description: 'The namespace of the metric.

          Example: `oci_computeagent`

          '
        maxLength: 1024
        minLength: 1
        type: string
    notificationTargetFields:
      enableFormattedMessaging:
        description: 'Whether to apply a simplified, user-friendly format to the message. Applies only when friendly formatting is supported by the connector source and the subscription protocol.

          Example: `true`

          '
        type: boolean
      topicId:
        description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the topic.

          '
        maxLength: 255
        minLength: 1
        type: string
    objectStorageTargetFields:
      batchRolloverSizeInMBs:
        description: 'The batch rollover size in megabytes.

          '
        minimum: 1
        type: integer
      batchRolloverTimeInMs:
        description: 'The batch rollover time in milliseconds.

          '
        minimum: 1
        type: integer
      bucketName:
        description: 'The name of the bucket. Valid characters are letters (upper or lower case), numbers, hyphens (-),

          underscores(_), and periods (.). Bucket names must be unique within an Object Storage namespace.

          Avoid entering confidential information. Example: my-new-bucket1

          '
        maxLength: 256
        minLength: 1
        type: string
      namespace:
        description: 'The namespace.

          '
        maxLength: 1024
        minLength: 0
        type: string
      objectNamePrefix:
        description: 'The prefix of the objects. Avoid entering confidential information.

          '
        maxLength: 1024
        type: string
    pluginSourceFields:
      configMap:
        additionalProperties: true
        description: "The configuration map for the connector plugin. This map includes parameters specific to the connector plugin type. \nFor example, for `QueueSource`, the map lists the OCID of the selected queue.\nTo find the parameters for a connector plugin, get the plugin using [GetConnectorPlugin](#/en/serviceconnectors/latest/ConnectorPlugin/GetConnectorPlugin) and review its schema value.\n"
        type: object
      pluginName:
        description: 'The name of the connector plugin. This name indicates the service to be called by the connector plugin. For example, `QueueSource` indicates the Queue service.

          To find names of connector plugins, list the plugin using [ListConnectorPlugin](#/en/serviceconnectors/latest/ConnectorPluginSummary/ListConnectorPlugins).

          '
        type: string
    sourceDetailsDiscriminator:
      kind:
        description: 'The type discriminator.

          '
        enum:
        - logging
        - monitoring
        - streaming
        - plugin
        type: string
    streamingSourceFields:
      cursor:
        $ref: '#/components/schemas/StreamingCursorDetails'
      streamId:
        description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the stream.

          '
        maxLength: 255
        type: string
    streamingTargetFields:
      streamId:
        description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the stream.

          '
        maxLength: 255
        minLength: 1
        type: string
    targetDetailsDiscriminator:
      kind:
        description: 'The type discriminator.

          '
        enum:
        - functions
        - loggingAnalytics
        - monitoring
        - notifications
        - objectStorage
        - streaming
        type: string
    taskDetailsDiscriminator:
      kind:
        description: 'The type discriminator.

          '
        enum:
        - function
        - logRule
        type: string
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    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).

        '
      type: string
    opc-prev-page:
      description: 'For list pagination.  When this header appears in the response,

        previous pages of results exist. For important details about

        how pagination works, see

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

        '
      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
    description:
      description: 'The description of the resource. Avoid entering confidential information.

        '
      maxLength: 400
      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
    systemTags:
      additionalProperties:
        additionalProperties:
          type: object
        type: object
      description: 'The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces.

        For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).

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

        '
      type: object
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.pic.connectors