{ "opencollection": "1.0.0", "info": { "name": "Events API", "version": "20181201" }, "items": [ { "info": { "name": "events", "type": "folder" }, "items": [ { "info": { "name": "Lists rules for this compartment.", "type": "http" }, "http": { "method": "GET", "url": "https://events.$region.oraclecloud.com/20181201/rules", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. 1 is the minimum, 50 is the maximum.\nDefault: 10\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only rules that match the lifecycle state in this parameter.\n\nExample: `Creating`\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only rules with descriptions that match the displayName string\nin this parameter.\n\nExample: `\"This rule sends a notification upon completion of DbaaS backup.\"`\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Specifies the attribute with which to sort the rules.\n\nDefault: `timeCreated`\n\n* **TIME_CREATED:** Sorts by timeCreated.\n* **DISPLAY_NAME:** Sorts by displayName.\n* **ID:** Sorts by id.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Specifies sort order.\n\n* **ASC:** Ascending sort order.\n* **DESC:** Descending sort order.\n" } ] }, "docs": "Lists rules for this compartment.\n" }, { "info": { "name": "Creates a new rule", "type": "http" }, "http": { "method": "POST", "url": "https://events.$region.oraclecloud.com/20181201/rules", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new rule.\n" }, { "info": { "name": "Retrieves a rule", "type": "http" }, "http": { "method": "GET", "url": "https://events.$region.oraclecloud.com/20181201/rules/:ruleId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "ruleId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this rule.\n" } ] }, "docs": "Retrieves a rule." }, { "info": { "name": "Updates a rule", "type": "http" }, "http": { "method": "PUT", "url": "https://events.$region.oraclecloud.com/20181201/rules/:ruleId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "ruleId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this rule.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a rule.\n" }, { "info": { "name": "Deletes a rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://events.$region.oraclecloud.com/20181201/rules/:ruleId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "ruleId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this rule.\n" } ] }, "docs": "Deletes a rule." }, { "info": { "name": "Moves a rule into a different compartment. When provided, If-Match is checked against ETag values of the resource.", "type": "http" }, "http": { "method": "POST", "url": "https://events.$region.oraclecloud.com/20181201/rules/:ruleId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "ruleId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this rule.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a rule into a different compartment within the same tenancy. For information about moving \nresources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" } ] } ], "bundled": true }