Oracle Platforms

Oracle Platforms Analytics API

The analytics API from Oracle Platforms — 19 operation(s) for analytics.

Documentation GitHub OpenAPI

Business capability

IT Infrastructure Management BC-600.50

Operations 29

GET /analyticsInstances List Analytics instances. #

POST /analyticsInstances Create an Analytics instance. #

DELETE /analyticsInstances/{analyticsInstanceId} Delete an Analytics instance. #

GET /analyticsInstances/{analyticsInstanceId} Retrieve Analytics instance metadata. #

PUT /analyticsInstances/{analyticsInstanceId} Update an Analytics instance. #

POST /analyticsInstances/{analyticsInstanceId}/actions/changeCompartment Change the compartment of an Analytics instance. #

POST /analyticsInstances/{analyticsInstanceId}/actions/changeNetworkEndpoint Change the network endpoint for an Analytics instance. #

POST /analyticsInstances/{analyticsInstanceId}/actions/scale Scale an Analytics instance up or down. #

POST /analyticsInstances/{analyticsInstanceId}/actions/setFeatureBundle Set the feature bundle of an Analytics instance. #

POST /analyticsInstances/{analyticsInstanceId}/actions/setKmsKey Encrypts customer data with an OCI vault key or reverts back to an Oracle-managed key. #

POST /analyticsInstances/{analyticsInstanceId}/actions/start Starts the specified Analytics instance. #

POST /analyticsInstances/{analyticsInstanceId}/actions/stop Stop the specified Analytics instance. #

POST /analyticsInstances/{analyticsInstanceId}/privateAccessChannels Create a private access channel for the Analytics instance. #

DELETE /analyticsInstances/{analyticsInstanceId}/privateAccessChannels/{privateAccessChannelKey} Delete private access channel with given unique identifier key, for an Analytics instance. #

GET /analyticsInstances/{analyticsInstanceId}/privateAccessChannels/{privateAccessChannelKey} Retrieve private access channel for the specified Analytics Instance. #

PUT /analyticsInstances/{analyticsInstanceId}/privateAccessChannels/{privateAccessChannelKey} Update the private access channel. #

GET /analyticsInstances/{analyticsInstanceId}/resourceGroups List resource groups for an instance. #

POST /analyticsInstances/{analyticsInstanceId}/resourceGroups Create a resource group for the Analytics Instance. #

DELETE /analyticsInstances/{analyticsInstanceId}/resourceGroups/{analyticsInstanceResourceGroupId} Delete a resource group for the Analytics Instance. #

GET /analyticsInstances/{analyticsInstanceId}/resourceGroups/{analyticsInstanceResourceGroupId} Gets one of the resource groups for an instance #

PUT /analyticsInstances/{analyticsInstanceId}/resourceGroups/{analyticsInstanceResourceGroupId} Update a resource group for an instance #

POST /analyticsInstances/{analyticsInstanceId}/vanityUrls Create a vanity URL for the Analytics instance. #

DELETE /analyticsInstances/{analyticsInstanceId}/vanityUrls/{vanityUrlKey} Delete a vanity URL for the Analytics instance. #

PUT /analyticsInstances/{analyticsInstanceId}/vanityUrls/{vanityUrlKey} Upload a new certificate for a vanity URL. #

GET /workRequests List all work requests. #

DELETE /workRequests/{workRequestId} Cancel a work request. #

GET /workRequests/{workRequestId} Get work request details. #

GET /workRequests/{workRequestId}/errors Get work request errors. #

GET /workRequests/{workRequestId}/logs Get work request logs. #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/oracle-platforms-analytics-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/721a23ed8ae46334a8f98f8d7fc231acf5dfb7064b9f2dd38e2f0aa5d670e3eb.yaml
    harvested: '2026-08-27'
    note: Published by Oracle as the contract for the Analytics API (analytics) OCI service and stored verbatim; API Evangelist added only this provenance block. Wired to the "Oracle Analytics Cloud API" entry in apis.yml.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own machine-readable index of every OCI service specification (HTTP 200)
  - url: https://docs.oracle.com/en-us/iaas/api/specs/721a23ed8ae46334a8f98f8d7fc231acf5dfb7064b9f2dd38e2f0aa5d670e3eb.yaml
    what: the harvested document for Analytics API (HTTP 200)
  description: 'Analytics API.

    '
  license:
    name: Oracle Corporation
  title: Analytics API
  version: '20190331'
servers:
- url: /20190331
tags:
- name: analytics
paths:
  /analyticsInstances:
    get:
      description: 'List Analytics instances.

        '
      operationId: ListAnalyticsInstances
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/ResourceNameQueryParam'
      - $ref: '#/components/parameters/CapacityTypeQueryParam'
      - $ref: '#/components/parameters/FeatureSetQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: 'List of Analytics instances (paginated, see page and limit query parameters).

            '
          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
                maxLength: 1024
                minLength: 1
            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:
                items:
                  $ref: '#/components/schemas/AnalyticsInstanceSummary'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: List Analytics instances.
      tags:
      - analytics
    post:
      description: 'Create a new Analytics instance in the specified compartment. The operation is long-running

        and creates a new work request.

        '
      operationId: CreateAnalyticsInstance
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        201:
          description: 'The Analytics instance was created. A background task is configuring various dependencies before the instance

            becomes fully operational.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            location:
              description: 'The full URI of the resource.

                '
              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
            opc-work-request-id:
              description: 'The OCID of the work request. Use [GetWorkRequest](#/en/analytics/20190331/WorkRequest/GetWorkRequest) with this ID to track the status

                of the request.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsInstance'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Create an Analytics instance.
      tags:
      - analytics
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAnalyticsInstanceDetails'
        description: 'Analytics instance details.

          '
        required: true
  /analyticsInstances/{analyticsInstanceId}:
    delete:
      description: 'Deletes the specified Analytics instance. The operation is long-running

        and creates a new work request.

        '
      operationId: DeleteAnalyticsInstance
      parameters:
      - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        204:
          description: 'The Analytics instance is being deleted.

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

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

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The OCID of the work request. Use [GetWorkRequest](#/en/analytics/20190331/WorkRequest/GetWorkRequest) with this ID to track the status

                of the request.

                '
              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/DefaultError'
      summary: Delete an Analytics instance.
      tags:
      - analytics
      x-related-resource: '#/definitions/AnalyticsInstance'
    get:
      description: 'Information about a specific Analytics instance.

        '
      operationId: GetAnalyticsInstance
      parameters:
      - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'Expected response for a valid 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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsInstance'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Retrieve Analytics instance metadata.
      tags:
      - analytics
    put:
      description: 'Updates certain fields of an Analytics instance. Fields that are not provided in the

        request will not be updated.

        '
      operationId: UpdateAnalyticsInstance
      parameters:
      - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'The Analytics instance was updated.

            '
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

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

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

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsInstance'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Update an Analytics instance.
      tags:
      - analytics
      x-obmcs-client-retries-enabled: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAnalyticsInstanceDetails'
        description: "Update specified fields for an Analytics instance. Fields that aren't provided\n won't be updated.\n"
        required: true
  /analyticsInstances/{analyticsInstanceId}/actions/changeCompartment:
    post:
      description: 'Change the compartment of an Analytics instance. The operation is long-running

        and creates a new work request.

        '
      operationId: ChangeAnalyticsInstanceCompartment
      parameters:
      - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'The request to move compartments was accepted.

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

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

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The OCID of the work request. Use [GetWorkRequest](#/en/analytics/20190331/WorkRequest/GetWorkRequest) with this ID to track the status

                of the request.

                '
              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/DefaultError'
      summary: Change the compartment of an Analytics instance.
      tags:
      - analytics
      x-related-resource: '#/definitions/AnalyticsInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeCompartmentDetails'
        description: 'Input payload to move the resource to a different compartment.

          '
        required: true
  /analyticsInstances/{analyticsInstanceId}/actions/changeNetworkEndpoint:
    post:
      description: 'Change the network endpoint for an Analytics instance. The operation is long-running

        and creates a new work request.

        '
      operationId: ChangeAnalyticsInstanceNetworkEndpoint
      parameters:
      - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'The request was accepted and the Analytics instance network endpoint will be updated.

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

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

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The OCID of the work request. Use [GetWorkRequest](#/en/analytics/20190331/WorkRequest/GetWorkRequest) with this ID to track the status

                of the request.

                '
              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/DefaultError'
      summary: Change the network endpoint for an Analytics instance.
      tags:
      - analytics
      x-related-resource: '#/definitions/AnalyticsInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeAnalyticsInstanceNetworkEndpointDetails'
        description: 'Input payload for changing a network endpoint for an Analytics instance.

          '
        required: true
  /analyticsInstances/{analyticsInstanceId}/actions/scale:
    post:
      description: 'Scale an Analytics instance up or down. The operation is long-running

        and creates a new work request.

        '
      operationId: ScaleAnalyticsInstance
      parameters:
      - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'The request was accepted and the Analytics instance will be scaled up or down.

            '
          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: 'The OCID of the work request. Use [GetWorkRequest](#/en/analytics/20190331/WorkRequest/GetWorkRequest) with this ID to track the status

                of the request.

                '
              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/DefaultError'
      summary: Scale an Analytics instance up or down.
      tags:
      - analytics
      x-related-resource: '#/definitions/AnalyticsInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScaleAnalyticsInstanceDetails'
        description: 'Input payload for scaling an Analytics instance up or down.

          '
        required: true
  /analyticsInstances/{analyticsInstanceId}/actions/setFeatureBundle:
    post:
      description: 'Set the external service properties of an Analytics instance.

        '
      operationId: SetFeatureBundle
      parameters:
      - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'The request was accepted and the Analytics instance feature bundle will be set.

            '
          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: 'The OCID of the work request. Use [GetWorkRequest](#/en/analytics/20190331/WorkRequest/GetWorkRequest) with this ID to track the status

                of the request.

                '
              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/DefaultError'
      summary: Set the feature bundle of an Analytics instance.
      tags:
      - analytics
      x-related-resource: '#/definitions/AnalyticsInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetFeatureBundleDetails'
        description: 'Input payload for the feature set of an Analytics instance.

          '
        required: true
  /analyticsInstances/{analyticsInstanceId}/actions/setKmsKey:
    post:
      description: 'Encrypts the customer data of this Analytics instance using either a customer OCI vault key or default Oracle-managed key.

        '
      operationId: SetKmsKey
      parameters:
      - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'The request was accepted and re-encryption of the customer data will begin.

            '
          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: 'The OCID of the work request. Use [GetWorkRequest](#/en/analytics/20190331/WorkRequest/GetWorkRequest) with this ID to track the status

                of the request.

                '
              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/DefaultError'
      summary: Encrypts customer data with an OCI vault key or reverts back to an Oracle-managed key.
      tags:
      - analytics
      x-related-resource: '#/definitions/AnalyticsInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetKmsKeyDetails'
        description: 'Input payload to reset the OCI vault encryption key.

          '
        required: true
  /analyticsInstances/{analyticsInstanceId}/actions/start:
    post:
      description: 'Starts the specified Analytics instance. The operation is long-running

        and creates a new work request.

        '
      operationId: StartAnalyticsInstance
      parameters:
      - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'The request was accepted and the Analytics instance will be started.

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

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

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The OCID of the work request. Use [GetWorkRequest](#/en/analytics/20190331/WorkRequest/GetWorkRequest) with this ID to track the status

                of the request.

                '
              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/DefaultError'
      summary: Starts the specified Analytics instance.
      tags:
      - analytics
      x-related-resource: '#/definitions/AnalyticsInstance'
  /analyticsInstances/{analyticsInstanceId}/actions/stop:
    post:
      description: 'Stop the specified Analytics instance. The operation is long-running

        and creates a new work request.

        '
      operationId: StopAnalyticsInstance
      parameters:
      - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'The request was accepted and the Analytics instance will be stopped.

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

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

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The OCID of the work request. Use [GetWorkRequest](#/en/analytics/20190331/WorkRequest/GetWorkRequest) with this ID to track the status

                of the request.

                '
              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/DefaultError'
      summary: Stop the specified Analytics instance.
      tags:
      - analytics
      x-related-resource: '#/definitions/AnalyticsInstance'
  /analyticsInstances/{analyticsInstanceId}/privateAccessChannels:
    post:
      description: 'Create an private access channel for the Analytics instance. The operation is long-running

        and creates a new work request.

        '
      operationId: CreatePrivateAccessChannel
      parameters:
      - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'The request was accepted and the private access channel for the Analytics instance will be created.

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

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

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The OCID of the work request. Use [GetWorkRequest](#/en/analytics/20190331/WorkRequest/GetWorkRequest) with this ID to track the status

                of the request.

                '
              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/DefaultError'
      summary: Create a private access channel for the Analytics instance.
      tags:
      - analytics
      x-example: "POST /20190331/analyticsInstances/<var>&lt;analytics_instance_OCID&gt;</var>/privateAccessChannels\nHost: analytics.<var>&lt;region&gt;</var>.ocp.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"displayName\": \"example_private_access_channel\",\n  \"vcnId\": \"ocid1.vcn.<var>&lt;unique_part_vcn_id&gt;</var>\",\n  \"subnetId\": \"ocid1.subnet.<var>&lt;unique_part_subnet_id&gt;</var>\",\n  \"privateSourceDnsZones\" : [\n    { \"dnsZone\" : \"example-vcn.oraclevcn.com\", \"description\" : \"Example OCI VCN DNS label\" },\n    { \"dnsZone\" : \"example.com\", \"description\" : \"Example DNS Zone / Domain for On-Premise\" }\n  ]\n}\n"
      x-related-resource: '#/definitions/AnalyticsInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePrivateAccessChannelDetails'
        description: 'Input payload for creating a private access channel for an Analytics instance.

          '
        required: true
  /analyticsInstances/{analyticsInstanceId}/privateAccessChannels/{privateAccessChannelKey}:
    delete:
      description: 'Delete a private access channel with a given unique identifier key, for an Analytics instance.

        '
      operationId: DeletePrivateAccessChannel
      parameters:
      - $ref: '#/components/parameters/PrivateAccessChannelKeyPathParam'
      - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        204:
          description: 'The private access channel for the Analytics instance is being deleted.

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

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

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The OCID of the work request. Use [GetWorkRequest](#/en/analytics/20190331/WorkRequest/GetWorkRequest) with this ID to track the status

                of the request.

                '
              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/DefaultError'
      summary: Delete private access channel with given unique identifier key, for an Analytics instance.
      tags:
      - analytics
      x-example: 'DELETE /20190331/analyticsInstances/<var>&lt;analytics_instance_OCID&gt;</var>/privateAccessChannels/<var>&lt;private_access_channel_Key&gt;</var>

        Host: analytics.<var>&lt;region&gt;</var>.ocp.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/AnalyticsInstance'
    get:
      description: 'Retrieve private access channel for the specified Analytics Instance.

        '
      operationId: GetPrivateAccessChannel
      parameters:
      - $ref: '#/components/parameters/PrivateAccessChannelKeyPathParam'
      - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'Returns the name of the private access channel.

            '
          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/PrivateAccessChannel'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Retrieve private access channel for the specified Analytics Instance.
      tags:
      - analytics
      x-related-resource: '#/definitions/AnalyticsInstance'
    put:
      description: 'Update the private access channel with the given unique identifier key in the specified Analytics instance.

        '
      operationId: UpdatePrivateAccessChannel
      parameters:
      - $ref: '#/components/parameters/PrivateAccessChannelKeyPathParam'
      - $ref: '#/components/parameters/AnalyticsInstanceIdPathPara

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