{ "opencollection": "1.0.0", "info": { "name": "Web Application Firewall () Waf API", "version": "20210930" }, "items": [ { "info": { "name": "waf", "type": "folder" }, "items": [ { "info": { "name": "Returns a list of NetworkAddressLists.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210930/networkAddressLists", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycleState." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "id", "value": "", "type": "query", "description": "A filter to return only the NetworkAddressList with the given [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results.\nThis must come from the `opc-next-page` header field of a previous response.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided.\nDefault order for timeCreated is descending.\nDefault order for displayName is ascending.\nIf no value is specified timeCreated is default.\n" } ] }, "docs": "Gets a list of all NetworkAddressLists in a compartment.\n" }, { "info": { "name": "Creates a new NetworkAddressList.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210930/networkAddressLists", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new NetworkAddressList.\n" }, { "info": { "name": "Get NetworkAddressList.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210930/networkAddressLists/:networkAddressListId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "networkAddressListId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the NetworkAddressList." } ] }, "docs": "Gets a NetworkAddressList by OCID." }, { "info": { "name": "Updates the NetworkAddressList.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210930/networkAddressLists/:networkAddressListId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "networkAddressListId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the NetworkAddressList." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the NetworkAddressList identified by the OCID." }, { "info": { "name": "Delete a provisioned NetworkAddressList.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210930/networkAddressLists/:networkAddressListId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "networkAddressListId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the NetworkAddressList." } ] }, "docs": "Deletes a NetworkAddressList resource identified by the OCID." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210930/networkAddressLists/:networkAddressListId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "networkAddressListId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the NetworkAddressList." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a NetworkAddressList resource from one compartment to another.\nWhen provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "List all protection capabilities.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210930/protectionCapabilities", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results.\nThis must come from the `opc-next-page` header field of a previous response.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "key", "value": "", "type": "query", "description": "The unique key of protection capability to filter by." }, { "name": "isLatestVersion", "value": "", "type": "query", "description": "A filter to return only resources that matches given isLatestVersion." }, { "name": "type", "value": "", "type": "query", "description": "A filter to return only resources that matches given type." }, { "name": "groupTag", "value": "", "type": "query", "description": "A filter to return only resources that are accociated given group tag." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided.\nDefault order for key is descending.\nDefault order for type is descending.\nDefault order for displayName is ascending.\nIf no value is specified key is default.\n" } ] }, "docs": "Lists of protection capabilities filtered by query parameters.\n" }, { "info": { "name": "List all protection capabilities group tags.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210930/protectionCapabilities/groupTags", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results.\nThis must come from the `opc-next-page` header field of a previous response.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "type", "value": "", "type": "query", "description": "A filter to return only resources that matches given type." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided.\nDefault order for name is ascending.\nIf no value is specified name is default.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name given." } ] }, "docs": "Lists of available group tags filtered by query parameters.\n" }, { "info": { "name": "Returns a list of WebAppFirewallPolicies.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210930/webAppFirewallPolicies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycleState." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "id", "value": "", "type": "query", "description": "A filter to return only the WebAppFirewallPolicy with the given [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results.\nThis must come from the `opc-next-page` header field of a previous response.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided.\nDefault order for timeCreated is descending.\nDefault order for displayName is ascending.\nIf no value is specified timeCreated is default.\n" } ] }, "docs": "Gets a list of all WebAppFirewallPolicies in a compartment.\n" }, { "info": { "name": "Creates a new WebAppFirewallPolicy.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210930/webAppFirewallPolicies", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new WebAppFirewallPolicy.\n" }, { "info": { "name": "Get WebAppFirewallPolicy.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210930/webAppFirewallPolicies/:webAppFirewallPolicyId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "webAppFirewallPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WebAppFirewallPolicy." } ] }, "docs": "Gets a WebAppFirewallPolicy with the given OCID." }, { "info": { "name": "Updates the WebAppFirewallPolicy.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210930/webAppFirewallPolicies/:webAppFirewallPolicyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "webAppFirewallPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WebAppFirewallPolicy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the WebAppFirewallPolicy identified by the OCID." }, { "info": { "name": "Delete a provisioned WebAppFirewallPolicy.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210930/webAppFirewallPolicies/:webAppFirewallPolicyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "webAppFirewallPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WebAppFirewallPolicy." } ] }, "docs": "Deletes a WebAppFirewallPolicy resource identified by the OCID." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210930/webAppFirewallPolicies/:webAppFirewallPolicyId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "webAppFirewallPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WebAppFirewallPolicy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a WebAppFirewallfPolicy resource from one compartment to another.\nWhen provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Returns a list of WebAppFirewalls.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210930/webAppFirewalls", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "id", "value": "", "type": "query", "description": "A filter to return only the WebAppFirewall with the given [OCID](/Content/General/Concepts/identifiers.htm)." }, { "name": "webAppFirewallPolicyId", "value": "", "type": "query", "description": "A filter to return only the WebAppFirewall with the given [OCID](/Content/General/Concepts/identifiers.htm) of related WebAppFirewallPolicy.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycleState." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results.\nThis must come from the `opc-next-page` header field of a previous response.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided.\nDefault order for timeCreated is descending.\nDefault order for displayName is ascending.\nIf no value is specified timeCreated is default.\n" } ] }, "docs": "Gets a list of all WebAppFirewalls in a compartment.\n" }, { "info": { "name": "Creates a new WebAppFirewall.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210930/webAppFirewalls", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new WebAppFirewall.\n" }, { "info": { "name": "Get WebAppFirewall.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210930/webAppFirewalls/:webAppFirewallId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "webAppFirewallId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WebAppFirewall." } ] }, "docs": "Gets a WebAppFirewall by OCID." }, { "info": { "name": "Update the WebAppFirewall.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210930/webAppFirewalls/:webAppFirewallId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "webAppFirewallId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WebAppFirewall." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the WebAppFirewall identified by the OCID." }, { "info": { "name": "Delete a provisioned WebAppFirewall.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210930/webAppFirewalls/:webAppFirewallId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "webAppFirewallId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WebAppFirewall." } ] }, "docs": "Deletes a WebAppFirewall resource identified by the OCID." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210930/webAppFirewalls/:webAppFirewallId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "webAppFirewallId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WebAppFirewall." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a Web App Firewall resource from one compartment to another.\nWhen provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "List Work Requests.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210930/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "workRequestId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results.\nThis must come from the `opc-next-page` header field of a previous response.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "Lists the WorkRequests in a compartment.\n" }, { "info": { "name": "GET WorkRequest Status.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210930/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous request." } ] }, "docs": "Gets the status of the WorkRequest with the given OCID." }, { "info": { "name": "Lists WorkRequestErrors.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210930/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous request." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results.\nThis must come from the `opc-next-page` header field of a previous response.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "Return a (paginated) list of errors for a given WorkRequest.\n" }, { "info": { "name": "Lists WorkRequestLogs.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210930/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous request." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results.\nThis must come from the `opc-next-page` header field of a previous response.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "Return a (paginated) list of logs for a given WorkRequest.\n" } ] } ], "bundled": true }