Oracle Vn Monitoring API

openapi: 3.2.0
info:
  description: 'Use the Network Monitoring API to troubleshoot routing and security issues for resources such as virtual cloud networks (VCNs) and compute instances. For more information, see the console

    documentation for the [Network Path Analyzer](/iaas/Content/Network/Concepts/path_analyzer.htm) tool.

    '
  title: Network Monitoring Vn Monitoring API
  version: '20160918'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/8af785f2fcabba899f4f05867f7d2cb38cc822b3b1658fecd6e9a5db669bc30c.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Network Monitoring 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/8af785f2fcabba899f4f05867f7d2cb38cc822b3b1658fecd6e9a5db669bc30c.yaml
    what: the harvested document for Network Monitoring API
servers:
- url: /20160918
tags:
- name: vnMonitoring
paths:
  /pathAnalysis:
    post:
      description: "Use this method to initiate a [Network Path Analyzer](/iaas/Content/Network/Concepts/path_analyzer.htm) analysis. This method returns\nan opc-work-request-id, and you can poll the status of the work request until it either fails or succeeds.\n\nIf the work request status is successful, use [ListWorkRequestResults](#/en/VnConfigAdvisor/latest/WorkRequestResult/ListWorkRequestResults)\nwith the work request ID to ask for the successful analysis results. If the work request status is failed, use\n[ListWorkRequestErrors](#/en/VnConfigAdvisor/latest/WorkRequestError/ListWorkRequestErrors)\nwith the work request ID to ask for the analysis failure information. The information \nreturned from either of these methods can be used to build a final report. \n"
      operationId: GetPathAnalysis
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/CacheControlHeader'
      responses:
        202:
          description: The path analysis request was successfully received.
          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'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: A path analysis query.
      tags:
      - vnMonitoring
      x-example: "Example 1: Path analysis with an Adhoc query\nPOST /20160918/pathAnalysis\nHost: vnca-api.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"type\" : \"ADHOC_QUERY\",\n  \"compartmentId\" : \"ocid1.compartment.oc1..<var>&lt;unique_ID&gt;</var>\",\n  \"protocol\" : 6,\n  \"sourceEndpoint\" : {\n    \"type\" : \"COMPUTE_INSTANCE\",\n    \"address\" : \"172.16.1.50\",\n    \"instanceId\" : \"ocid1.instance.oc1..<var>&lt;unique_ID&gt;</var>\"\n    \"vnicId\" : \"ocid1.vnic.oc1..<var>&lt;unique_ID&gt;</var>\"\n  },\n  \"destinationEndpoint\" : {\n    \"type\" : \"COMPUTE_INSTANCE\",\n    \"address\" : \"172.16.2.100\",\n    \"instanceId\" : \"ocid1.instance.oc1..<var>&lt;unique_ID_two&gt;</var>\"\n    \"vnicId\" : \"ocid1.vnic.oc1..<var>&lt;unique_ID_two&gt;</var>\"\n  },\n  \"protocolParameters\" : {\n    \"type\" : \"TCP\",\n    \"destinationPort\" : 80\n  }\n}\n\nExample 1: Path analysis with persisted query\nPOST /20160918/pathAnalysis\nHost: vnca-api.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"type\" : \"PERSISTED_QUERY\",\n  \"pathAnalyzerTestId\" : \"ocid1.pathanalyzertest.oc1..<var>&lt;unique_ID&gt;</var>\"\n}\n"
      x-related-resource: '#/definitions/PathAnalysisWorkRequestResult'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetPathAnalysisDetails'
        description: Details for the path analysis query.
        required: true
  /pathAnalyzerTests:
    get:
      description: 'Returns a list of all `PathAnalyzerTests` in a compartment.

        '
      operationId: ListPathAnalyzerTests
      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: A list of `PathAnalyzerTest` resources is successfully returned.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

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

                subsequent GET request to get the next batch of items.

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

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

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PathAnalyzerTestCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Gets a list of all PathAnalyzerTests in a compartment
      tags:
      - vnMonitoring
      x-example: 'GET /20160918/pathAnalyzerTests?compartmentId=<var>&lt;compartment_OCID&gt;</var>&limit=10

        Host: vnca-api.us-ashburn-1.oci.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/PathAnalyzerTestCollection'
    post:
      description: Creates a new `PathAnalyzerTest` resource.
      operationId: CreatePathAnalyzerTest
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A new `PathAnalyzerTest` resource was successfully created.
          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/PathAnalyzerTest'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Creates a new PathAnalyzerTest
      tags:
      - vnMonitoring
      x-example: "POST /20160918/pathAnalyzerTests\nHost: vnca-api.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"displayName\" : \"Path Analyzer Test\",\n  \"compartmentId\" : \"ocid1.compartment.oc1..<var>&lt;unique_ID&gt;</var>\",\n  \"protocol\" : 6,\n  \"sourceEndpoint\" : {\n    \"type\" : \"COMPUTE_INSTANCE\",\n    \"address\" : \"172.16.1.50\",\n    \"instanceId\" : \"ocid1.instance.oc1..<var>&lt;unique_ID&gt;</var>\"\n    \"vnicId\" : \"ocid1.vnic.oc1..<var>&lt;unique_ID&gt;</var>\"\n  },\n  \"destinationEndpoint\" : {\n    \"type\" : \"COMPUTE_INSTANCE\",\n    \"address\" : \"172.16.2.100\",\n    \"instanceId\" : \"ocid1.instance.oc1..<var>&lt;unique_ID_two&gt;</var>\"\n    \"vnicId\" : \"ocid1.vnic.oc1..<var>&lt;unique_ID_two&gt;</var>\"\n  },\n  \"protocolParameters\" : {\n    \"type\" : \"TCP\",\n    \"destinationPort\" : 80\n  }\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePathAnalyzerTestDetails'
        description: Details for creating a new PathAnalyzerTest.
        required: true
  /pathAnalyzerTests/{pathAnalyzerTestId}:
    delete:
      description: Deletes a `PathAnalyzerTest` resource using its identifier.
      operationId: DeletePathAnalyzerTest
      parameters:
      - $ref: '#/components/parameters/PathAnalyzerTestIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The `PathAnalyzerTest` resource was deleted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

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

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Deletes PathAnalyzerTest
      tags:
      - vnMonitoring
      x-example: 'DELETE /20160918/pathAnalyzerTests/<var>&lt;pathanalyzertest_OCID&gt;</var>

        Host: vnca-api.us-ashburn-1.oci.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/PathAnalyzerTest'
    get:
      description: Gets a `PathAnalyzerTest` using its identifier.
      operationId: GetPathAnalyzerTest
      parameters:
      - $ref: '#/components/parameters/PathAnalyzerTestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The `PathAnalyzerTest` resource was successfully returned.
          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/PathAnalyzerTest'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Gets PathAnalyzerTest
      tags:
      - vnMonitoring
      x-example: 'GET /20160918/pathAnalyzerTests/<var>&lt;pathanalyzertest_OCID&gt;</var>

        Host: vnca-api.us-ashburn-1.oci.oraclecloud.com

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

        '
    put:
      description: Updates a `PathAnalyzerTest` using its identifier.
      operationId: UpdatePathAnalyzerTest
      parameters:
      - $ref: '#/components/parameters/PathAnalyzerTestIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The `PathAnalyzerTest` resource was successfully 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/PathAnalyzerTest'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Updates PathAnalyzerTest
      tags:
      - vnMonitoring
      x-example: "PUT /20160918/pathAnalyzerTests/<var>&lt;pathanalyzertest_OCID&gt;</var>\nHost: vnca-api.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"displayName\" : \"Updated Path Analyzer Test\",\n  \"protocol\" : 17,\n  \"protocolParameters\" : {\n    \"type\" : \"UDP\",\n    \"destinationPort\" : 100\n  }\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePathAnalyzerTestDetails'
        description: The information to update.
        required: true
  /pathAnalyzerTests/{pathAnalyzerTestId}/actions/changeCompartment:
    post:
      description: 'Moves a `PathAnalyzerTest` resource from one compartment to another based on the identifier.

        '
      operationId: ChangePathAnalyzerTestCompartment
      parameters:
      - $ref: '#/components/parameters/PathAnalyzerTestIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The `PathAnalyzerTest` resource was moved to the specified compartment.
          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
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Moves PathAnalyzerTest resource into a different compartment.
      tags:
      - vnMonitoring
      x-example: "POST /20160918/pathAnalyzerTests/<var>&lt;pathanalyzertest_OCID&gt;</var>/actions/changeCompartment\nHost: vnca-api.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..<var>&lt;unique_ID&gt;</var>\"\n}\n"
      x-related-resource: '#/definitions/PathAnalyzerTest'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangePathAnalyzerTestCompartmentDetails'
        description: The information to update.
        required: true
  /workRequests:
    get:
      description: Lists the work requests in a compartment.
      operationId: ListWorkRequests
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/WorkRequestIdQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/WorkRequestSortByQueryParam'
      - $ref: '#/components/parameters/WorkRequestStatusQueryParam'
      - $ref: '#/components/parameters/ResourceIdentifierQueryParam'
      responses:
        200:
          description: A list of work request summaries.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

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

                subsequent GET request to get the next batch of items.

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

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

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequestSummaryCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Lists work requests in a compartment.
      tags:
      - vnMonitoring
      x-example: 'GET /20160918/workRequests?compartmentId=<var>&lt;compartment_OCID&gt;</var>&limit=10

        Host: vnca-api.us-ashburn-1.oci.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}:
    get:
      description: Gets the details of a work request.
      operationId: GetWorkRequest
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The details of the work request.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

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

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

                '
              schema:
                type: string
            retry-after:
              description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequest'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Gets the details of a work request.
      tags:
      - vnMonitoring
      x-example: 'GET /20160918/workRequests/<var>&lt;workrequest_OCID&gt;</var>

        Host: iaas.us-phoenix-1.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}/errors:
    get:
      description: 'Returns a (paginated) list of errors for the work request with the given ID. This information is used to build the final report output.

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

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

                subsequent GET request to get the next batch of items.

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

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

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequestErrorCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Lists work request errors.
      tags:
      - vnMonitoring
      x-example: 'GET /20160918/workRequests/<var>&lt;workrequest_OCID&gt;</var>/errors?limit=10

        Host: vnca-api.us-ashburn-1.oci.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/WorkRequestError'
  /workRequests/{workRequestId}/logs:
    get:
      description: 'Returns a (paginated) list of logs for the work request with the given ID.

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

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

                subsequent GET request to get the next batch of items.

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

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

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequestLogEntryCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Lists work request logs.
      tags:
      - vnMonitoring
      x-example: 'GET /20160918/workRequests/<var>&lt;workrequest_OCID&gt;</var>/logs?limit=10

        Host: vnca-api.us-ashburn-1.oci.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/WorkRequestLogEntry'
  /workRequests/{workRequestId}/results:
    get:
      description: 'Returns a (paginated) list of results for a successful work request. This information is used to

        build the final report output.

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

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

                subsequent GET request to get the next batch of items.

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

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

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequestResultCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Lists work request results.
      tags:
      - vnMonitoring
      x-example: 'GET /20160918/workRequests/<var>&lt;workrequest_OCID&gt;</var>/results?limit=10

        Host: vnca-api.us-ashburn-1.oci.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/WorkRequestResult'
components:
  schemas:
    UpdatePathAnalyzerTestDetails:
      description: Details to update a `PathAnalyzerTest` resource.
      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
        destinationEndpoint:
          $ref: '#/components/schemas/Endpoint'
        displayName:
          description: 'A user-friendly name. Does not have to be unique, and it''s 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
        protocol:
          description: The IP protocol to use in the `PathAnalyzerTest` resource.
          maximum: 255
          minimum: 0
          type: integer
        protocolParameters:
          $ref: '#/components/schemas/ProtocolParameters'
        queryOptions:
          $ref: '#/components/schemas/QueryOptions'
        sourceEndpoint:
          $ref: '#/components/schemas/Endpoint'
      type: object
    ChangePathAnalyzerTestCompartmentDetails:
      description: Details of the new `compartmentId` for the `PathAnalyzerTest` resource.
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment

            into which the `PathAnalyzerTest` resource should be moved.

            '
          maxLength: 100
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
    Error:
      properties:
        code:
          description: 'A short error code that defines the error, meant for programmatic parsing. See

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

            '
          type: string
        message:
          description: A human-readable error message.
          type: string
      required:
      - code
      - message
    PathAnalyzerTestSummary:
      description: 'Defines the summary of a `PathAnalyzerTest` resource.

        '
      properties:
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `PathAnalyzerTest` resource's compartment.
          maxLength: 100
          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
        destinationEndpoint:
          $ref: '#/components/schemas/Endpoint'
        displayName:
          description: 'A user-friendly name. Does not have to be unique, and it''s 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
        id:
          description: A unique identifier established when the resource is created. The identifier can't be changed later.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The current state of the `PathAnalyzerTest` resource.
          type: string
          x-obmcs-enumref: '#/definitions/PathAnalyzerTest/lifecycleState'
        protocol:
          description: The IP protocol to use for the `PathAnalyzerT

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