openapi: 3.2.0
info:
  description: 'Use the Notifications API to broadcast messages to distributed components by topic, using a publish-subscribe pattern.

    For information about managing topics, subscriptions, and messages, see [the Notifications documentation](/iaas/Content/Notification/home.htm).

    '
  title: Notifications Notification Data Plane API
  version: '20181201'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/14e5a8c24001383732b20453d9b177ede7ed076f9ad3fb4854c8a85494ba67da.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Notifications 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/14e5a8c24001383732b20453d9b177ede7ed076f9ad3fb4854c8a85494ba67da.yaml
    what: the harvested document for Notifications API
servers:
- url: https://notification.{region}.oraclecloud.com/20181201
tags:
- name: notificationDataPlane
paths:
  /smsNumbers:
    get:
      description: 'List the SMS numbers.

        '
      operationId: ListSmsNumbers
      parameters:
      - $ref: '#/components/parameters/FilterByStateQueryParam'
      - $ref: '#/components/parameters/FilterBySmsProviderIdQueryParam'
      - $ref: '#/components/parameters/FilterByUpdatedStartTimeQueryParam'
      - $ref: '#/components/parameters/FilterByUpdatedEndTimeQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: Success
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain.

                For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

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

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

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/SmsNumberSummary'
                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'
      tags:
      - notificationDataPlane
  /subscriptions:
    get:
      description: 'Lists the subscriptions in the specified compartment or topic.


        The topic API endpoint is required for this operation.

        To get the topic API endpoint, use [GetTopic](#/en/notification/20181201/NotificationTopic/GetTopic)

        and review the `apiEndpoint` value in the response ([NotificationTopic](#/en/notification/20181201/NotificationTopic)).


        Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.


        For instructions, see

        [Listing Subscriptions](/iaas/Content/Notification/Tasks/list-subscription.htm).

        '
      operationId: ListSubscriptions
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/FilterByTopicIdQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/OciNapCorpNetworkHeaderParam'
      responses:
        200:
          description: The list of subscriptions.
          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-previous-page:
              description: 'For list pagination. When this header appears in the response, previous pages of results remain.

                For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

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

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

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/SubscriptionSummary'
                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'
      tags:
      - notificationDataPlane
      x-example: 'Sample 1: List all subscriptions in a compartment


        GET /20181201/subscriptions?compartmentId=<var>&lt;compartment_OCID&gt;</var>

        Host: <var>&lt;topic API endpoint&gt;</var>

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


        Sample 2: List all subscriptions for a topic


        GET /20181201/subscriptions?topicId=<var>&lt;topic_OCID&gt;</var>

        Host: <var>&lt;topic API endpoint&gt;</var>

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

        '
      x-related-resource: '#/definitions/Subscription'
    post:
      description: 'Creates a subscription for the specified topic and sends a subscription confirmation URL to the endpoint.


        For instructions, see

        [Creating a Subscription](/iaas/Content/Notification/Tasks/create-subscription.htm).


        The subscription remains in "Pending" status until it has been confirmed.

        For information about confirming subscriptions, see

        [Confirming a Subscription](/iaas/Content/Notification/Tasks/confirm-subscription.htm).


        The topic API endpoint is required for this operation.

        To get the topic API endpoint, use [GetTopic](#/en/notification/20181201/NotificationTopic/GetTopic)

        and review the `apiEndpoint` value in the response ([NotificationTopic](#/en/notification/20181201/NotificationTopic)).


        Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

        '
      operationId: CreateSubscription
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/OciNapCorpNetworkHeaderParam'
      responses:
        200:
          description: 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/Subscription'
        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/DefaultError'
      tags:
      - notificationDataPlane
      x-example: "POST /20181201/subscriptions\nHost: <var>&lt;topic API endpoint&gt;</var>\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"topicId\": \"<var>&lt;topic_OCID&gt;</var>\",\n  \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n  \"protocol\": \"EMAIL\",\n  \"endpoint\": \"john.smith@example.com\"\n}\n"
      x-related-resource: '#/definitions/Subscription'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSubscriptionDetails'
        description: The subscription to create.
        required: true
  /subscriptions/{id}/confirmation:
    get:
      description: 'Gets the confirmation details for the specified subscription.


        The topic API endpoint is required for this operation.

        To get the topic API endpoint, use [GetTopic](#/en/notification/20181201/NotificationTopic/GetTopic)

        and review the `apiEndpoint` value in the response ([NotificationTopic](#/en/notification/20181201/NotificationTopic)).


        Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.


        For instructions, see

        [Getting Confirmation Results for a Subscription](/iaas/Content/Notification/Tasks/get-confirm-subscription.htm).

        '
      operationId: GetConfirmSubscription
      parameters:
      - description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subscription to get the confirmation details for.

          '
        in: path
        name: id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/TokenQueryParam'
      - $ref: '#/components/parameters/ProtocolQueryParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: Success
          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/ConfirmationResult'
        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'
      tags:
      - notificationDataPlane
      x-example: 'GET /20181201/subscriptions/<var>&lt;subscription_OCID&gt;</var>/confirmation?token=<var>&lt;subscription_confirmation_token&gt;</var>&protocol=EMAIL

        Host: <var>&lt;topic API endpoint&gt;</var>

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

        '
      x-related-resource: '#/definitions/Subscription'
  /subscriptions/{id}/resendConfirmation:
    post:
      description: 'Resends the confirmation details for the specified subscription.


        The topic API endpoint is required for this operation.

        To get the topic API endpoint, use [GetTopic](#/en/notification/20181201/NotificationTopic/GetTopic)

        and review the `apiEndpoint` value in the response ([NotificationTopic](#/en/notification/20181201/NotificationTopic)).


        Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.


        For instructions, see

        [Resending the Confirmation URL for a Subscription](/iaas/Content/Notification/Tasks/resend-confirmation-subscription.htm).

        '
      operationId: ResendSubscriptionConfirmation
      parameters:
      - description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subscription to resend the confirmation for.

          '
        in: path
        name: id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/OciNapCorpNetworkHeaderParam'
      responses:
        200:
          description: Success
          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/Subscription'
        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'
      tags:
      - notificationDataPlane
      x-example: 'POST /20181201/subscriptions/<var>&lt;subscription_OCID&gt;</var>/resendConfirmation

        Host: <var>&lt;topic API endpoint&gt;</var>

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

        '
      x-related-resource: '#/definitions/Subscription'
  /subscriptions/{id}/unsubscription:
    get:
      description: 'Unsubscribes the subscription from the topic.


        The topic API endpoint is required for this operation.

        To get the topic API endpoint, use [GetTopic](#/en/notification/20181201/NotificationTopic/GetTopic)

        and review the `apiEndpoint` value in the response ([NotificationTopic](#/en/notification/20181201/NotificationTopic)).


        Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.


        For instructions, see

        [Unsubscribing a Subscription from a Topic](/iaas/Content/Notification/Tasks/unsubscribe-subscription.htm).

        '
      operationId: GetUnsubscription
      parameters:
      - description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subscription to unsubscribe from.

          '
        in: path
        name: id
        required: true
        schema:
          type: string
      - description: 'The endpoint i.e. email address, phone number of the subscription to unsubscribe from.

          '
        in: query
        name: endpoint
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/TokenQueryParam'
      - $ref: '#/components/parameters/ProtocolQueryParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: Success
          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:
                type: string
        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'
      tags:
      - notificationDataPlane
      x-example: 'GET /20181201/subscriptions/<var>&lt;subscription_OCID&gt;</var>/unsubscription?token=<var>&lt;subscription_confirmation_token&gt;</var>&protocol=EMAIL

        Host: <var>&lt;topic API endpoint&gt;</var>

        '
      x-related-resource: '#/definitions/Subscription'
  /subscriptions/{subscriptionId}:
    delete:
      description: 'Deletes the specified subscription.


        The topic API endpoint is required for this operation.

        To get the topic API endpoint, use [GetTopic](#/en/notification/20181201/NotificationTopic/GetTopic)

        and review the `apiEndpoint` value in the response ([NotificationTopic](#/en/notification/20181201/NotificationTopic)).


        Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.


        For instructions, see

        [Deleting a Subscription](/iaas/Content/Notification/Tasks/delete-subscription.htm).

        '
      operationId: DeleteSubscription
      parameters:
      - description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subscription to delete.

          '
        in: path
        name: subscriptionId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/OciNapCorpNetworkHeaderParam'
      responses:
        204:
          description: 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
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      tags:
      - notificationDataPlane
      x-example: 'DELETE /20181201/subscriptions/<var>&lt;subscription_OCID&gt;</var>

        Host: <var>&lt;topic API endpoint&gt;</var>

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

        '
      x-related-resource: '#/definitions/Subscription'
    get:
      description: 'Gets the specified subscription''s configuration information.


        The topic API endpoint is required for this operation.

        To get the topic API endpoint, use [GetTopic](#/en/notification/20181201/NotificationTopic/GetTopic)

        and review the `apiEndpoint` value in the response ([NotificationTopic](#/en/notification/20181201/NotificationTopic)).


        Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.


        For instructions, see

        [Getting a Subscription''s Details](/iaas/Content/Notification/Tasks/get-subscription.htm).

        '
      operationId: GetSubscription
      parameters:
      - description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subscription to retrieve.

          '
        in: path
        name: subscriptionId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/OciNapCorpNetworkHeaderParam'
      responses:
        200:
          description: Success
          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/Subscription'
        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'
      tags:
      - notificationDataPlane
      x-example: 'GET /20181201/subscriptions/<var>&lt;subscription_OCID&gt;</var>

        Host: <var>&lt;topic API endpoint&gt;</var>

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

        '
      x-related-resource: '#/definitions/Subscription'
    put:
      description: 'Updates the specified subscription''s configuration.


        The topic API endpoint is required for this operation.

        To get the topic API endpoint, use [GetTopic](#/en/notification/20181201/NotificationTopic/GetTopic)

        and review the `apiEndpoint` value in the response ([NotificationTopic](#/en/notification/20181201/NotificationTopic)).


        Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.


        For instructions, see

        [Updating a Subscription](/iaas/Content/Notification/Tasks/update-subscription.htm).

        '
      operationId: UpdateSubscription
      parameters:
      - description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subscription to update.

          '
        in: path
        name: subscriptionId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/OciNapCorpNetworkHeaderParam'
      responses:
        200:
          description: OK
          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/UpdateSubscriptionDetails'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      tags:
      - notificationDataPlane
      x-example: "PUT /20181201/subscriptions/<var>&lt;subscription_OCID&gt;</var>\nHost: <var>&lt;topic API endpoint&gt;</var>\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"freeformTags\":\n    {\n      \"Department\": \"Finance\"\n    }\n}\n"
      x-related-resource: '#/definitions/Subscription'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSubscriptionDetails'
        description: 'The configuration details for updating the subscription.

          '
        required: true
  /subscriptions/{subscriptionId}/actions/changeCompartment:
    post:
      description: 'Moves a subscription into a different compartment within the same tenancy.

        For instructions, see

        [Moving a Subscription](/iaas/Content/Notification/Tasks/change-compartment-subscription.htm).


        The topic API endpoint is required for this operation.

        To get the topic API endpoint, use [GetTopic](#/en/notification/20181201/NotificationTopic/GetTopic)

        and review the `apiEndpoint` value in the response ([NotificationTopic](#/en/notification/20181201/NotificationTopic)).


        Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

        '
      operationId: ChangeSubscriptionCompartment
      parameters:
      - description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subscription to move.

          '
        in: path
        name: subscriptionId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/OciNapCorpNetworkHeaderParam'
      responses:
        204:
          description: Success
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

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

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      tags:
      - notificationDataPlane
      x-example: "POST /20181201/subscriptions/<var>&lt;subscription_OCID&gt;</var>/actions/changeCompartment\nHost: <var>&lt;topic API endpoint&gt;</var>\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\"\n}\n"
      x-related-resource: '#/definitions/Subscription'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeCompartmentDetails'
        description: The configuration details for the move operation.
        required: true
  /subscriptionsPriorConfirmation:
    post:
      description: "Creates a subscription where prior confirmation has already been given.\nCreates a subscription for the specified topic in \"Active\" status, without sending a subscription confirmation URL to the endpoint.\nThis is an internal feature only only for whitelisted internal teams. It requires prior approval from Security & Legal.   \nThe subscriptions recipients must all have already provided consent to receive notifications from Oracle.\n\nFor instructions, see\n[Creating a Subscription](/iaas/Content/Notification/Tasks/create-subscription.htm).\n\nThe subscription is created in \"Active\" status.\n\nThe topic API endpoint is required for this operation.\nTo get the topic API endpoint, use [GetTopic](#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n"
      operationId: CreateSubscriptionPriorConfirmation
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: 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/Subscription'
        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/DefaultError'
      tags:
      - notificationDataPlane
      x-example: "POST /20181201/subscriptionsPriorConfirmation\nHost: <var>&lt;topic API endpoint&gt;</var>\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"topicId\": \"<var>&lt;topic_OCID&gt;</var>\",\n  \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n  \"protocol\": \"EMAIL\",\n  \"endpoint\": \"john.smith@example.com\"\n}\n"
      x-related-resource: '#/definitions/Subscription'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSubscriptionDetails'
        description: The subscription to create.
        required: true
  /topics/{topicId}/messages:
    post:
      description: 'Publishes a message to the specified topic.


        The topic API endpoint is required for this operation.

        To get the topic API endpoint, use [GetTopic](#/en/notification/20181201/NotificationTopic/GetTopic)

        and review the `apiEndpoint` value in the response ([NotificationTopic](#/en/notification/20181201/NotificationTopic)).


        All limits are per tenancy.


        Message size limit per request: 64KB.


        Transactions Per Minute (TPM) per-tenancy limit for this operation: 60 per topic. (This TPM limit represents messages per minute.)


        For other limits information, including message delivery limits by subscription, see

        [Limits for Publishing Messages](/iaas/Content/Notification/Concepts/notificationoverview.htm#limits-pub-msg).

        For more information about publishing messages, see

        [Publishing a Message to a Topic](/iaas/Content/Notification/Tasks/publishingmessages.htm).

        For steps to request a limit increase, see

        [Requesting a Service Limit Increase](/iaas/Content/General/Concepts/servicelimits.htm#three).

        '
      operationId: PublishMessage
      parameters:
      - description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the topic.

          '
        in: path
        name: topicId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/MessageTypeHeaderParam'
      - $ref: '#/components/parameters/OciNapCorpNetworkHeaderParam'
      responses:
        200:
          description: Published
          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/PublishResult'
        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'
      tags:
      - notificationDataPlane
      x-example: "POST /20181201/topics/<var>&lt;topic_OCID&gt;</var>/messages\nHost: <var>&lt;topic API endpoint&gt;</var>\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"title\": \"Alarm notification\",\n  \"body\": \"High CPU usage\"\n}\n"
      x-related-resource: '#/definitions/NotificationTopic'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MessageDetails'
        description: The message to publish.
        required: true
components:
  parameters:
    PaginationTokenQueryParam:
      description: 

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