{ "opencollection": "1.0.0", "info": { "name": "Notifications Notification Data Plane API", "version": "20181201" }, "items": [ { "info": { "name": "notificationDataPlane", "type": "folder" }, "items": [ { "info": { "name": "ListSmsNumbers", "type": "http" }, "http": { "method": "GET", "url": "https://notification.{region}.oraclecloud.com/20181201/smsNumbers", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "state", "value": "", "type": "query", "description": "A filter to only return resources that match the given state exactly.\n" }, { "name": "smsProviderId", "value": "", "type": "query", "description": "A filter to only return resources that match the given smsProviderId exactly.\n" }, { "name": "startTime", "value": "", "type": "query", "description": "A filter to only return resources that have been updated since the given time.\n" }, { "name": "endTime", "value": "", "type": "query", "description": "A filter to only return resources that have been updated before the given time.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "List the SMS numbers.\n" }, { "info": { "name": "ListSubscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://notification.{region}.oraclecloud.com/20181201/subscriptions", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "x-oci-nap-corpnetwork", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, { "name": "topicId", "value": "", "type": "query", "description": "Return all subscriptions that are subscribed to the given topic OCID. Either this query parameter or the compartmentId query parameter must be set.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the subscriptions in the specified compartment or topic.\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\nFor instructions, see\n[Listing Subscriptions](/iaas/Content/Notification/Tasks/list-su" }, { "info": { "name": "CreateSubscription", "type": "http" }, "http": { "method": "POST", "url": "https://notification.{region}.oraclecloud.com/20181201/subscriptions", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "x-oci-nap-corpnetwork", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a subscription for the specified topic and sends a subscription confirmation URL to the endpoint.\n\nFor instructions, see\n[Creating a Subscription](/iaas/Content/Notification/Tasks/create-subscription.htm).\n\nThe subscription remains in \"Pending\" status until it has been confirmed.\nFor information about confirming subscriptions, see\n[Confirming a Subscription](/iaas/Content/Notification/Tasks/confirm-subscription.htm).\n\nThe topic API endpoint is required for this operation.\nTo get the topi" }, { "info": { "name": "GetConfirmSubscription", "type": "http" }, "http": { "method": "GET", "url": "https://notification.{region}.oraclecloud.com/20181201/subscriptions/:id/confirmation", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subscription to get the confirmation details for.\n" }, { "name": "token", "value": "", "type": "query", "description": "The subscription confirmation token." }, { "name": "protocol", "value": "", "type": "query", "description": "The protocol used for the subscription.\n\nAllowed values:\n * `CUSTOM_HTTPS`\n * `EMAIL`\n * `HTTPS` (deprecated; for PagerDuty endpoints, use `PAGERDUTY`)\n * `ORACLE_FUNCTIONS`\n * `PAGERDUTY`\n * `SLACK`\n * `SMS`\n\nFor information about subscription protocols, see\n[Supported subscription protocols (on the overview page)](/iaas/Content/Notification/Concepts/notificationoverview.htm#concepts__subscriptionprotocols).\n" } ] }, "docs": "Gets the confirmation details for the specified subscription.\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\nFor instructions, see\n[Getting Confirmation Results for a Subscription](/iaas/Content/N" }, { "info": { "name": "ResendSubscriptionConfirmation", "type": "http" }, "http": { "method": "POST", "url": "https://notification.{region}.oraclecloud.com/20181201/subscriptions/:id/resendConfirmation", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "x-oci-nap-corpnetwork", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subscription to resend the confirmation for.\n" } ] }, "docs": "Resends the confirmation details for the specified subscription.\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\nFor instructions, see\n[Resending the Confirmation URL for a Subscription](/iaas/Cont" }, { "info": { "name": "GetUnsubscription", "type": "http" }, "http": { "method": "GET", "url": "https://notification.{region}.oraclecloud.com/20181201/subscriptions/:id/unsubscription", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subscription to unsubscribe from.\n" }, { "name": "endpoint", "value": "", "type": "query", "description": "The endpoint i.e. email address, phone number of the subscription to unsubscribe from.\n" }, { "name": "token", "value": "", "type": "query", "description": "The subscription confirmation token." }, { "name": "protocol", "value": "", "type": "query", "description": "The protocol used for the subscription.\n\nAllowed values:\n * `CUSTOM_HTTPS`\n * `EMAIL`\n * `HTTPS` (deprecated; for PagerDuty endpoints, use `PAGERDUTY`)\n * `ORACLE_FUNCTIONS`\n * `PAGERDUTY`\n * `SLACK`\n * `SMS`\n\nFor information about subscription protocols, see\n[Supported subscription protocols (on the overview page)](/iaas/Content/Notification/Concepts/notificationoverview.htm#concepts__subscriptionprotocols).\n" } ] }, "docs": "Unsubscribes the subscription from the topic.\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\nFor instructions, see\n[Unsubscribing a Subscription from a Topic](/iaas/Content/Notification/Tasks/unsu" }, { "info": { "name": "GetSubscription", "type": "http" }, "http": { "method": "GET", "url": "https://notification.{region}.oraclecloud.com/20181201/subscriptions/:subscriptionId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "x-oci-nap-corpnetwork", "value": "" } ], "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subscription to retrieve.\n" } ] }, "docs": "Gets the specified subscription's configuration information.\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\nFor instructions, see\n[Getting a Subscription's Details](/iaas/Content/Notification/Task" }, { "info": { "name": "UpdateSubscription", "type": "http" }, "http": { "method": "PUT", "url": "https://notification.{region}.oraclecloud.com/20181201/subscriptions/:subscriptionId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "x-oci-nap-corpnetwork", "value": "" } ], "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subscription to update.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified subscription's configuration.\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\nFor instructions, see\n[Updating a Subscription](/iaas/Content/Notification/Tasks/update-subscript" }, { "info": { "name": "DeleteSubscription", "type": "http" }, "http": { "method": "DELETE", "url": "https://notification.{region}.oraclecloud.com/20181201/subscriptions/:subscriptionId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "x-oci-nap-corpnetwork", "value": "" } ], "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subscription to delete.\n" } ] }, "docs": "Deletes the specified subscription.\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\nFor instructions, see\n[Deleting a Subscription](/iaas/Content/Notification/Tasks/delete-subscription.htm).\n" }, { "info": { "name": "ChangeSubscriptionCompartment", "type": "http" }, "http": { "method": "POST", "url": "https://notification.{region}.oraclecloud.com/20181201/subscriptions/:subscriptionId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "x-oci-nap-corpnetwork", "value": "" } ], "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subscription to move.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a subscription into a different compartment within the same tenancy.\nFor instructions, see\n[Moving a Subscription](/iaas/Content/Notification/Tasks/change-compartment-subscription.htm).\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) " }, { "info": { "name": "CreateSubscriptionPriorConfirmation", "type": "http" }, "http": { "method": "POST", "url": "https://notification.{region}.oraclecloud.com/20181201/subscriptionsPriorConfirmation", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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/Noti" }, { "info": { "name": "PublishMessage", "type": "http" }, "http": { "method": "POST", "url": "https://notification.{region}.oraclecloud.com/20181201/topics/:topicId/messages", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "messageType", "value": "" }, { "name": "x-oci-nap-corpnetwork", "value": "" } ], "params": [ { "name": "topicId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the topic.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Publishes a message to the specified topic.\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\nAll limits are per tenancy.\n\nMessage size limit per request: 64KB.\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60 per topic. (This TPM limit represents m" } ] } ], "bundled": true }