{ "openapi": "3.0.0", "info": { "description": "## Introduction\n\nIBM Cloud® Internet Services (CIS), powered by Cloudflare, provides a fast, highly performant, reliable, and secure internet service for customers running their business on IBM Cloud.\n\nCIS gets you going quickly by establishing defaults for you, which you can change by using the API or UI. Here are some commonly changed parameters:\n\n* **DNS settings**: you can use CIS to host your DNS or you can create CNAME records.\n* **Crypto settings (TLS)**: the default is flexible mode, which encrypts the connection between your host and the CIS edge server, but does not encrypt the communication between the CIS edge server and origin server.\n\nFor complete information about establishing and managing an IBM Cloud Internet Services instance, refer to [our customer documentation](https://cloud.ibm.com/docs/cis?topic=cis-getting-started#getting-started).\n\nThe code examples on this tab use the CIS Python SDK.\n\nInstallation\n\n```bash\npip install --upgrade \"ibm-networking-services\"\n```\n\nGitHub\n\nhttps://github.com/IBM/networking-python-sdk\n\nThe code examples on this tab use the CIS Go SDK.\n\nInstallation\n\n```bash\ngo get -u github.com/IBM/networking-go-sdk\n```\n\nGitHub\n\nhttps://github.com/IBM/networking-go-sdk\n\nThe code examples on this tab use the CIS Node SDK.\n\nInstallation\n```bash\nnpm install ibm-networking-services\n```\n\nGitHub\n\nhttps://github.com/IBM/networking-node-sdk\n\nThe code examples on this tab use the client library that is provided for Java.\n\nMaven\n\n```xml\n \n ${project.groupId}\n firewall-access-rules\n ${project.version}\n \n \n ${project.groupId}\n caching-api\n ${project.version}\n \n \n ${project.groupId}\n custom-pages\n ${project.version}\n \n \n ${project.groupId}\n dns-records\n ${project.version}\n \n \n ${project.groupId}\n dns-records-bulk\n ${project.version}\n \n \n ${project.groupId}\n firewall-api\n ${project.version}\n \n \n ${project.groupId}\n global-load-balancer\n ${project.version}\n \n \n ${project.groupId}\n global-load-balancer-pool\n ${project.version}\n \n \n ${project.groupId}\n global-load-balancer-monitor\n ${project.version}\n \n \n ${project.groupId}\n global-load-balancer-events\n ${project.version}\n \n \n ${project.groupId}\n cis-ip-api\n ${project.version}\n \n \n ${project.groupId}\n zone-rate-limits\n ${project.version}\n \n \n ${project.groupId}\n routing\n ${project.version}\n \n \n ${project.groupId}\n ssl-certificate-api\n ${project.version}\n \n \n ${project.groupId}\n security-events-api\n ${project.version}\n \n \n ${project.groupId}\n user-agent-blocking-rules\n ${project.version}\n \n \n ${project.groupId}\n waf-api\n ${project.version}\n \n \n ${project.groupId}\n waf-rule-groups-api\n ${project.version}\n \n \n ${project.groupId}\n waf-rule-packages-api\n ${project.version}\n \n \n ${project.groupId}\n waf-rules-api\n ${project.version}\n \n \n ${project.groupId}\n zones\n ${project.version}\n \n \n ${project.groupId}\n zone-lockdown\n ${project.version}\n \n \n ${project.groupId}\n zone-firewall-access-rules\n ${project.version}\n \n \n ${project.groupId}\n zones-settings\n ${project.version}\n \n \n ${project.groupId}\n cis-range-applications\n ${project.version}\n \n```\n\nGradle:\n\n```sh\ncompile 'com.ibm.cloud:firewall-access-rules:X.X.X'\ncompile 'com.ibm.cloud:caching-api:X.X.X'\ncompile 'com.ibm.cloud:custom-pages:X.X.X'\ncompile 'com.ibm.cloud:dns-records:X.X.X'\ncompile 'com.ibm.cloud:dns-records-bulk:X.X.X'\ncompile 'com.ibm.cloud:firewall-api:X.X.X'\ncompile 'com.ibm.cloud:global-load-balancer:X.X.X'\ncompile 'com.ibm.cloud:global-load-balancer-pool:X.X.X'\ncompile 'com.ibm.cloud:global-load-balancer-monitor:X.X.X'\ncompile 'com.ibm.cloud:global-load-balancer-events:X.X.X'\ncompile 'com.ibm.cloud:cis-ip-api:X.X.X'\ncompile 'com.ibm.cloud:zone-rate-limits:X.X.X'\ncompile 'com.ibm.cloud:routing:X.X.X'\ncompile 'com.ibm.cloud:ssl-certificate-api:X.X.X'\ncompile 'com.ibm.cloud:security-events-api:X.X.X'\ncompile 'com.ibm.cloud:user-agent-blocking-rules:X.X.X'\ncompile 'com.ibm.cloud:waf-api:X.X.X'\ncompile 'com.ibm.cloud:waf-rule-groups-api:X.X.X'\ncompile 'com.ibm.cloud:waf-rule-packages-api:X.X.X'\ncompile 'com.ibm.cloud:waf-rules-api:X.X.X'\ncompile 'com.ibm.cloud:zones:X.X.X'\ncompile 'com.ibm.cloud:zone-lockdown:X.X.X'\ncompile 'com.ibm.cloud:zone-firewall-access-rules:X.X.X'\ncompile 'com.ibm.cloud:zones-settings:X.X.X'\ncompile 'com.ibm.cloud:cis-range-applications:X.X.X'\n```\n\nGitHub\n\n[https://github.com/IBM/networking-java-sdk](https://github.com/IBM/networking-java-sdk)\n\n## Endpoint URL\n\nThe CIS API uses the following global endpoint URL for all regions. When you call the API, add the path for each method to form the complete API endpoint for your requests.\n\nThe public endpoint is protected by Cloudflare; TLS termination occurs for all incoming traffic at the edge.\n\n```python\nhttps://api.cis.cloud.ibm.com\n```\n\n```sh\nhttps://api.cis.cloud.ibm.com\n```\n\n```go\nhttps://api.cis.cloud.ibm.com\n```\n\n```java\nhttps://api.cis.cloud.ibm.com\n```\n## API rate limiting\n\nBy default, the CIS API is rate limited at 100 requests in under a minute. There are some exceptions to this limit, including the Logpush ownership challenge which is rate limited at 5 requests in under a minute.\n\n## Error handling\n\nThis API uses standard HTTP response codes to indicate whether a method completed successfully. A `200` response always indicates success. A `400` type response is some sort of failure, and a `500` type response usually indicates an internal system error.\n\n| HTTP error code | Description | Recovery |\n|-----------------|-------------|----------|\n| `200` | Success | The request was successful. |\n| `400` | Bad Request | The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request. |\n| `401` | Unauthorized | You are not authorized to make this request. Log in to IBM Cloud and try again. If this error persists, contact the account owner to check your permissions.|\n| `403` | Forbidden | The supplied authentication is not authorized to access '{namespace}'. |\n| `404` | Not Found | The requested resource could not be found. |\n| `408` | Request Timeout | The connection to the server timed out. Wait a few minutes, then try again. |\n| `409` | Conflict | The entity is already in the requested state. |\n| `500` | Internal Server Error | IBM Cloud Internet Services is currently unavailable. Your request could not be processed. Wait a few minutes and try again. |\n\nHere are some model code examples for error handling in the IBM Cloud Internet Services API:\n\n```sh\n200 The API was completed successfully\n\n{\n \"success\": true,\n \"errors\": [\n {}\n ],\n \"messages\": [\n {}\n ],\n \"result\": {\n \"zones\": [\n {\n \"zone\": {\n \"status\": null,\n \"name\": null,\n \"security\": null,\n \"paused\": false\n },\n \"dns_record\": {\n \"count\": 0\n },\n \"load_balancer\": {\n \"monitor_count\": 0,\n \"pool_count\": 0,\n \"load_balancer_active_count\": 0\n },\n \"caching\": {\n \"edge_cache_ttl\": 0,\n \"cache_browser_ttl\": 0,\n \"development_mode\": \"off\",\n \"cache_level\": \"basic\"\n },\n \"pagerule\": {\n \"active_count\": 0,\n \"inactive_count\": 0\n },\n \"waf\": {\n \"status\": null\n },\n \"ssl\": {\n \"mode\": null,\n \"universal_ssl_certificate\": \"off\",\n \"dedicate_certificate_count\": 0,\n \"custom_upload_certificate_count\": 0,\n \"tls_1_2_only\": \"on\"\n },\n \"plan_details\": {\n \"plan_name\": \"Standard\",\n \"days_remaining\": null\n },\n \"firewall\": {\n \"security_level\": \"low\"\n }\n }\n ],\n \"service_maintenance\": {\n \"start_time\": null,\n \"end_time\": null,\n \"message\": null\n }\n }\n}\n```\n\n```sh\n401 Action unauthorized\n\n{\n \"trace\": \"be45687c-57f2-46e8-8717-32b3153a5886\",\n \"errors\": [\n {\n \"code\": 401,\n \"message\": \"Action is not authorized.\"\n }\n ]\n}\n```\n\n```sh\n404 API not found\n{\n \"trace\": \"c3c9f6af-a20f-4b73-8e3d-800a9284a07f\",\n \"errors\": [\n {\n \"code\": null,\n \"message\": \"404 Not Found\"\n }\n ]\n}\n```\n\n## Authentication\n\nThe CIS API uses Identity and Access Management (IAM) to authenticate requests. Pass a bearer token in an Authorization header. Tokens support authenticated requests without embedding service credentials in every call. Learn more about [IAM](https://cloud.ibm.com/docs/account?topic=account-iamoverview).\n\nTo call each method, you'll need to be assigned a role that includes the required IAM actions. Each method lists the associated action. For more information about IAM actions and how they map to roles, see [Managing access for CIS](https://cloud.ibm.com/docs/cis?topic=cis-iam-and-cis#iam-and-cis).\n\n## Event tracking\n\nYou can monitor API activity within your account by using the IBM Cloud Activity Tracker service. Whenever an API method is called, an event is generated that you can then track and audit from within Activity Tracker. The specific event type is listed for each individual method. \n\nFor more information about how to track CIS activity, see [Auditing events for CIS](https://cloud.ibm.com/docs/cis?topic=cis-at_events#at_events).\n\nFor more information about IAM actions and Activity Tracker actions by API method, see [IAM and Activity Tracker actions by API](https://cloud.ibm.com/docs/cis?topic=cis-at_iam_CIS#at_iam_CIS).", "version": "1.0.0", "title": "Cloud Internet Services API", "contact": { "name": "CIS Developers", "email": "CIS-Support-Squad@wwpdl.vnet.ibm.com" }, "x-github": "https://github.ibm.com/cloud-api-docs/cloud-internet-services", "x-github-issues": "https://github.ibm.com/cloud-api-docs/cloud-internet-services/issues/new", "x-last-updated": "2026-06-02" }, "servers": [ { "url": "https://api.cis.cloud.ibm.com" } ], "security": [ { "iamToken": [] } ], "tags": [ { "name": "Advanced Certificate Pack", "description": "Advanced Certificate Pack for a given zone." }, { "name": "Alert Policies", "description": "View and Adjust Alert Policies for your CIS Instance." }, { "name": "Alert Webhooks", "description": "View and Adjust Alert Webhooks for your CIS Instance." }, { "name": "Zone-Level Authenticated Origin Pull", "description": "Setup authenticated origin pull for a given zone." }, { "name": "Per-hostname Authenticated Origin Pull", "description": "Setup a client certificate per hostname to be sent in a request to Origin." }, { "name": "Bot Analytics", "description": "Bot Analytics for a given zone." }, { "name": "Bot Management Settings", "description": "Bot Management for a given zone." }, { "name": "Cache Settings", "description": "Cache settings and Purging caches." }, { "name": "Custom Pages", "description": "Custom pages for a given instance." }, { "name": "DNS Records", "description": "DNS records for a service instance." }, { "name": "Edge Functions Actions", "description": "Edge functions actions for a given instance." }, { "name": "Edge Functions Triggers", "description": "Edge functions triggers for a given zone." }, { "name": "Filters", "description": "Filters for a zone" }, { "name": "Firewall Event Analytics", "description": "Firewall event analytics data." }, { "name": "Firewall rules", "description": "Firewall rules for a zone" }, { "name": "Global Load Balancer", "description": "Global load balancers for a given zone." }, { "name": "Global Load Balancer Events", "description": "Get load balancer events for all origins." }, { "name": "Global Load Balancer Monitor", "description": "Global load balancer monitor for a user." }, { "name": "Global Load Balancer Pool", "description": "Global load balancer pools." }, { "name": "Instance Level Firewall Access Rules", "description": "Instance level firewall access rules." }, { "name": "Instance Rulesets", "description": "Instance level Rulesets." }, { "name": "Instant Logs", "description": "Instant logs jobs for a zone." }, { "name": "IP Allowlist", "description": "List of all IP addresses used by the CIS proxy." }, { "name": "Lists", "description": "View and Manage Lists for your domain." }, { "name": "Logpush Jobs", "description": "View and Manage Logpush Jobs for your domain." }, { "name": "Logs RayID", "description": "View events from a given RayID." }, { "name": "Mutual TLS", "description": "Mutual TLS for a zone." }, { "name": "Origin Certificate", "description": "Origin certificate for a given zone." }, { "name": "Page Rules", "description": "A rule describing target patterns for requests and actions to perform on matching requests." }, { "name": "Range Analytics", "description": "Range Analytics inside a zone." }, { "name": "Range Applications", "description": "Range Applications inside a zone." }, { "name": "Routing", "description": "Get smart route setting for a given zone." }, { "name": "Security Level Setting (DEPRECATED)", "description": "Security-level setting for a given zone." }, { "name": "Edge Certificate", "description": "SSL certificate for a given zone." }, { "name": "Total TLS", "description": "Configuring Total TLS for a given zone." }, { "name": "User-Agent Blocking Rules", "description": "User agent blocking rules." }, { "name": "Zone Firewall Access Rules", "description": "Firewall access rules for a zone." }, { "name": "Zone Hold", "description": "Zone Hold for a given zone." }, { "name": "Zone Lockdown Rules", "description": "Lockdown rules for a zone." }, { "name": "Zone Rate Limits", "description": "Rate limits for a zone." }, { "name": "Zone Rulesets", "description": "Zone level Rulesets." }, { "name": "Zones", "description": "Zones for a service instance (currently only one zone creation allowed per instance)" }, { "name": "Zones Settings", "description": "Zone setting for a given zone." }, { "name": "Security Events (DEPRECATED)", "description": "Logs of the mitigation performed by Firewall features." }, { "name": "WAF settings (previous)", "description": "A Web Application Firewall (WAF) blocks requests that contain malicious content." }, { "name": "WAF Rule Groups (DEPRECATED)", "description": "WAF rule groups contained within a package." }, { "name": "WAF Rule Packages (DEPRECATED)", "description": "Web Application Firewall (WAF) rule packages are collections of rule groups." }, { "name": "WAF Rules (DEPRECATED)", "description": "Web Application Firewall (WAF) rules." } ], "paths": { "/v1/{crn}/rulesets": { "get": { "tags": [ "Instance Rulesets" ], "summary": "List Instance rulesets", "operationId": "get_instance_rulesets", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.rulesets.read" } ] }, "description": "List all rulesets at the instance level.", "parameters": [ { "$ref": "#/components/parameters/crn" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_rulesets_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rulesets \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v1/{crn}/rulesets/{ruleset_id}": { "get": { "tags": [ "Instance Rulesets" ], "summary": "Get an instance ruleset", "operationId": "get_instance_ruleset", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.rulesets.read" } ] }, "description": "View a specific instance ruleset.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/ruleset_id" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rulesets/$RULESET_ID \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "put": { "tags": [ "Instance Rulesets" ], "summary": "Update an instance ruleset", "operationId": "update_instance_ruleset", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.rules.update" } ] }, "description": "Update a specific instance ruleset.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/ruleset_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_update" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rulesets/$RULESET_ID \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\\\n", " -d '{\"description\":\"My ruleset to execute managed rulesets\",\"kind\":\"root\",\"name\":\"My ruleset\",\"phase\":\"http_request_firewall_custom\",\"rules\":[{\"action\":\"block\",\"action_parameters\":{\"response\":{\"content\":\"{\\n \\\"success\\\": false,\\n \\\"error\\\": \\\"you have been blocked\\\"\\n}\",\"content_type\":\"application/json\",\"status_code\":400}},\"description\":\"Block when the IP address is not 1.1.1.1\",\"enabled\":true,\"expression\":\"ip.src ne 1.1.1.1\",\"id\":\"3a03d665bac047339bb530ecb439a90d\",\"logging\":{\"enabled\":true},\"ref\":\"my_ref\"}]}'\n" ] } ] } ] } } }, "delete": { "tags": [ "Instance Rulesets" ], "summary": "Delete an instance ruleset", "operationId": "delete_instance_ruleset", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.rulesets.delete" } ] }, "description": "Delete a specific instance ruleset.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/ruleset_id" } ], "responses": { "204": { "description": "Success" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rulesets/$RULESET_ID \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v1/{crn}/rulesets/{ruleset_id}/versions": { "get": { "tags": [ "Instance Rulesets" ], "summary": "List version of an instance ruleset", "operationId": "get_instance_ruleset_versions", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.rulesets-versions.read" } ] }, "description": "List all versions of a specific instance ruleset.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/ruleset_id" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_rulesets_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rulesets/$RULESET_ID/versions \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v1/{crn}/rulesets/{ruleset_id}/versions/{ruleset_version}": { "get": { "tags": [ "Instance Rulesets" ], "summary": "Get a specific version of an instance ruleset", "operationId": "get_instance_ruleset_version", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.rulesets-versions.read" } ] }, "description": "View a specific version of a specific instance ruleset.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/ruleset_id" }, { "$ref": "#/components/parameters/ruleset_version" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rulesets/$RULESET_ID/versions/$RULESET_VERSION \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "delete": { "tags": [ "Instance Rulesets" ], "summary": "Delete a specific version of an instance ruleset", "operationId": "delete_instance_ruleset_version", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.rulesets-versions.delete" } ] }, "description": "Delete a specific version of a specific instance ruleset.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/ruleset_id" }, { "$ref": "#/components/parameters/ruleset_version" } ], "responses": { "204": { "description": "Success" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rulesets/$RULESET_ID/versions/$RULESET_VERSION \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v1/{crn}/rulesets/phases/{ruleset_phase}/entrypoint": { "get": { "tags": [ "Instance Rulesets" ], "summary": "Get an instance entrypoint ruleset", "operationId": "get_instance_entrypoint_ruleset", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.rulesets-phases-entrypoint.read" } ] }, "description": "Get the instance ruleset for the given phase's entrypoint.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/ruleset_phase" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rulesets/phases/$RULESET_PHASE/entrypoint \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "put": { "tags": [ "Instance Rulesets" ], "summary": "Update an instance entrypoint ruleset", "operationId": "update_instance_entrypoint_ruleset", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.rulesets-phases-entrypoint.update" } ] }, "description": "Updates the instance ruleset for the given phase's entry point.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/ruleset_phase" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_update" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rulesets/phases/$RULESET_PHASE/entrypoint \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\\\n", " -d '{\"description\":\"My ruleset to execute managed rulesets\",\"kind\":\"root\",\"name\":\"My ruleset\",\"phase\":\"http_request_firewall_custom\",\"rules\":[{\"action\":\"block\",\"action_parameters\":{\"response\":{\"content\":\"{\\n \\\"success\\\": false,\\n \\\"error\\\": \\\"you have been blocked\\\"\\n}\",\"content_type\":\"application/json\",\"status_code\":400}},\"description\":\"Block when the IP address is not 1.1.1.1\",\"enabled\":true,\"expression\":\"ip.src ne 1.1.1.1\",\"id\":\"3a03d665bac047339bb530ecb439a90d\",\"logging\":{\"enabled\":true},\"ref\":\"my_ref\"}]}'\n" ] } ] } ] } } } }, "/v1/{crn}/rulesets/phases/{ruleset_phase}/entrypoint/versions": { "get": { "tags": [ "Instance Rulesets" ], "summary": "List an instance entry point ruleset's versions", "operationId": "get_instance_entry_point_ruleset_versions", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.read" } ] }, "x-ibm-events": { "actions": [ { "name": "internet-svcs.rulesets-phases-entrypoint-versions.read" } ] }, "description": "Lists the instance ruleset versions for the given phase's entry point.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/ruleset_phase" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_rulesets_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rulesets/phases/$RULESET_PHASE/entrypoint/versions \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v1/{crn}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}": { "get": { "tags": [ "Instance Rulesets" ], "summary": "Get an instance entry point ruleset version", "operationId": "get_instance_entry_point_ruleset_version", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.rulesets-phases-entrypoint-versions.read" } ] }, "description": "Fetches a specific version of an instance entry point ruleset.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/ruleset_phase" }, { "$ref": "#/components/parameters/ruleset_version" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rulesets/phases/$RULESET_PHASE/entrypoint/versions/$RULESET_VERSION \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v1/{crn}/rulesets/{ruleset_id}/rules": { "post": { "tags": [ "Instance Rulesets" ], "summary": "Create an instance ruleset rule", "operationId": "create_instance_ruleset_rule", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.rulesets-rules.create" } ] }, "description": "Create an instance ruleset rule.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/ruleset_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_create" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rulesets/$RULESET_ID/rules \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\\\n", " -d '{\"action\":\"block\",\"action_parameters\":{\"response\":{\"content\":\"{\\n \\\"success\\\": false,\\n \\\"error\\\": \\\"you have been blocked\\\"\\n}\",\"content_type\":\"application/json\",\"status_code\":400}},\"description\":\"Block when the IP address is not 1.1.1.1\",\"enabled\":true,\"expression\":\"ip.src ne 1.1.1.1\",\"id\":\"3a03d665bac047339bb530ecb439a90d\",\"logging\":{\"enabled\":true},\"ref\":\"my_ref\",\"position\":{\"before\":\"da5e8e506c8e7877fe06cdf4c41add54\"}}'\n" ] } ] } ] } } } }, "/v1/{crn}/rulesets/{ruleset_id}/rules/{rule_id}": { "patch": { "tags": [ "Instance Rulesets" ], "summary": "Update an instance ruleset rule", "operationId": "update_instance_ruleset_rule", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.rulesets-rules.update" } ] }, "description": "Update an instance ruleset rule.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/ruleset_id" }, { "$ref": "#/components/parameters/rule_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_update" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rulesets/$RULESET_ID/rules/$RULE_ID \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\\\n", " -d '{\"action\":\"block\",\"action_parameters\":{\"response\":{\"content\":\"{\\n \\\"success\\\": false,\\n \\\"error\\\": \\\"you have been blocked\\\"\\n}\",\"content_type\":\"application/json\",\"status_code\":400}},\"description\":\"Block when the IP address is not 1.1.1.1\",\"enabled\":true,\"expression\":\"ip.src ne 1.1.1.1\",\"id\":\"3a03d665bac047339bb530ecb439a90d\",\"logging\":{\"enabled\":true},\"ref\":\"my_ref\",\"position\":{\"before\":\"da5e8e506c8e7877fe06cdf4c41add54\"}}'\n" ] } ] } ] } } }, "delete": { "tags": [ "Instance Rulesets" ], "summary": "Delete an instance ruleset rule", "operationId": "delete_instance_ruleset_rule", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.rulesets-rules.read" } ] }, "description": "Delete an instance ruleset rule.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/ruleset_id" }, { "$ref": "#/components/parameters/rule_id" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rulesets/$RULESET_ID/rules/$RULE_ID \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v1/{crn}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag}": { "get": { "tags": [ "Instance Rulesets" ], "summary": "List an instance ruleset verion's rules by tag", "operationId": "get_instance_ruleset_version_by_tag", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.rulesets-versions-by-tag.read" } ] }, "description": "Lists rules by tag for a specific version of an instance ruleset.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/ruleset_id" }, { "$ref": "#/components/parameters/ruleset_version" }, { "$ref": "#/components/parameters/rule_tag" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rulesets/$RULESET_ID/versions/$RULESET_VERSION/by_tag/$RULE_TAG \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/rulesets": { "get": { "tags": [ "Zone Rulesets" ], "summary": "List zone rulesets", "operationId": "get_zone_rulesets", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.zone-rulesets.read" } ] }, "description": "List all rulesets at the zone level.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_rulesets_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": [ { "description": "Created by the CIS security team, this ruleset provides normalization on the URL path", "id": "70339d97bdb34195bbf054b1ebe81f76", "kind": "managed", "last_updated": "2024-08-01T17:37:11.538019Z", "name": "CIS Normalization Ruleset", "phase": "http_request_sanitize", "version": "6" }, { "description": "Exposed credentials check rules", "id": "c2e184081120413c86c3ab7e14069605", "kind": "managed", "last_updated": "2024-08-01T17:37:12.291474Z", "name": "CIS Exposed Credentials Check Ruleset", "phase": "http_request_firewall_managed", "version": "89" }, { "description": "CIS's implementation of the Open Web Application Security Project (OWASP) ModSecurity Core Rule Set. We routinely monitor for updates from OWASP based on the latest version available from the official code repository", "id": "4814384a9e5d4991b9815dcfc25d2f1f", "kind": "managed", "last_updated": "2024-08-19T17:26:58.593021Z", "name": "CIS OWASP Core Ruleset", "phase": "http_request_firewall_managed", "version": "87" } ] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/zones/$ZONE_ID/rulesets \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"encoding/json\"\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/v5/core\"\n", " \"github.com/IBM/networking-go-sdk/rulesetsv1\"\n", ")\n", "\n", "func main() {\n", " authenticator := &core.IamAuthenticator{\n", " ApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", " URL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", " }\n", "\n", " serviceURL := os.Getenv(\"API_ENDPOINT\")\n", " crn := os.Getenv(\"CRN\")\n", " zoneID := os.Getenv(\"ZONE_ID\")\n", " options := &rulesetsv1.RulesetsV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: serviceURL,\n", " Authenticator: authenticator,\n", " Crn: &crn,\n", " ZoneIdentifier: &zoneID,\n", " }\n", "\n", " service, serviceErr := rulesetsv1.NewRulesetsV1(options)\n", " if serviceErr != nil {\n", " fmt.Printf(\"Error creating RulesetsV1 service: %v\\n\", serviceErr)\n", " return\n", " }\n", " getRulesetsOptions := service.NewGetZoneRulesetsOptions()\n", " _, response, err := service.GetZoneRulesets(getRulesetsOptions)\n", " if err != nil {\n", " fmt.Printf(\"Error retrieving rulesets: %v\\n\", err)\n", " return\n", " }\n", " fmt.Printf(\"Rulesets: %+v\\n\", response.Result)\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "require('dotenv').config();\n", "\n", "const RulesetsV1 = require('ibm-networking-services/cis/rulesets/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: process.env.CIS_SERVICES_APIKEY,\n", " }),\n", " crn: process.env.CRN,\n", " zoneIdentifier: process.env.ZONE_ID,\n", " serviceUrl: process.env.API_ENDPOINT,\n", " version: '1',\n", "};\n", "\n", "const rulesetsV1 = new RulesetsV1(options);\n", "\n", "rulesetsV1.getZoneRulesets()\n", " .then(response => {\n", " const { result } = response || {};\n", " console.log('Zone rulesets:\n', JSON.stringify(result, null, 2));\n", " })\n", " .catch(err => {\n", " console.error('Error fetching zone rulesets:\n', err);\n", " });\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "try {\n", " GetZoneRulesetsOptions getZoneRulesetsOptions = new GetZoneRulesetsOptions.Builder().build();\n", "\n", " Response response = service.getZoneRulesets(getZoneRulesetsOptions).execute();\n", " ListRulesetsResp result = response.getResult();\n", "\n", " for (Ruleset ruleset : result.getResult()) {\n", " System.out.println(\"Ruleset ID: \" + ruleset.getId());\n", " System.out.println(\"Name: \" + ruleset.getName());\n", " System.out.println(\"Phase: \" + ruleset.getPhase());\n", " System.out.println(\"Version: \" + ruleset.getVersion());\n", " System.out.println(\"------\");\n", " }\n", "\n", "} catch (ServiceResponseException e) {\n", " System.err.printf(\"Service returned status code %d: %s\\nError details: %s\\n\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo());\n", "}\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/rulesets/{ruleset_id}": { "get": { "tags": [ "Zone Rulesets" ], "summary": "Get a zone ruleset", "operationId": "get_zone_ruleset", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.zone-rulesets.read" } ] }, "description": "View a specific zone ruleset.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "$ref": "#/components/parameters/ruleset_id" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_resp" }, "examples": { "response": { "value": { "result": { "description": "updated description", "id": "1b7f639a68c84184a76deb59ce4c618e", "kind": "zone", "last_updated": "2025-10-05T18:29:54.397532Z", "name": "my-custom-ruleset", "phase": "http_request_firewall_custom", "rules": [ { "action": "block", "description": "Block traffic from IP 192.0.2.1", "enabled": true, "expression": "ip.src == 192.0.2.1", "id": "73f8b4b296a34285b4d638ac110291c9", "last_updated": "2025-10-05T18:12:46.865395Z", "ref": "73f8b4b296a34285b4d638ac110291c9", "version": "1" }, { "action": "block", "description": "Block specific IP", "enabled": true, "expression": "ip.src == 192.0.2.1", "id": "be24069f34904fe28ae1dd734f982f43", "last_updated": "2025-10-05T18:19:48.156251Z", "ref": "be24069f34904fe28ae1dd734f982f43", "version": "1" } ], "source": "firewall_custom", "version": "12" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/zones/$ZONE_ID/rulesets/$RULESET_ID \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"encoding/json\"\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/v5/core\"\n", " \"github.com/IBM/networking-go-sdk/rulesetsv1\"\n", ")\n", "\n", "func main() {\n", " authenticator := &core.IamAuthenticator{\n", " ApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", " URL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", " }\n", " serviceURL := os.Getenv(\"API_ENDPOINT\")\n", " crn := os.Getenv(\"CRN\")\n", " zoneID := os.Getenv(\"ZONE_ID\")\n", " rulesetID := os.Getenv(\"RULESET_ID\")\n", " options := &rulesetsv1.RulesetsV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: serviceURL,\n", " Authenticator: authenticator,\n", " Crn: &crn,\n", " ZoneIdentifier: &zoneID,\n", " }\n", " service, serviceErr := rulesetsv1.NewRulesetsV1(options)\n", " if serviceErr != nil {\n", " fmt.Printf(\"Error creating RulesetsV1 service: %v\\n\", serviceErr)\n", " return\n", " }\n", " getRulesetOptions := &rulesetsv1.GetZoneRulesetOptions{\n", " RulesetID: core.StringPtr(rulesetID),\n", " }\n", " _, response, err := service.GetZoneRuleset(getRulesetOptions)\n", " if err != nil {\n", " fmt.Printf(\"Error retrieving ruleset: %v\\n\", err)\n", " return\n", " }\n", "\n", " // fmt.Printf(\"Rulesets: %+v\\n\", result.Result)\n", " jsonBytes, err := json.MarshalIndent(response.Result, \"\", \" \")\n", " if err != nil {\n", " fmt.Printf(\"Error marshaling ruleset: %v\\n\", err)\n", " return\n", " }\n", " fmt.Println(string(jsonBytes))\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "require('dotenv').config();\n", "\n", "const RulesetsV1 = require('ibm-networking-services/cis/rulesets/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: process.env.CIS_SERVICES_APIKEY,\n", " }),\n", " crn: process.env.CRN,\n", " zoneIdentifier: process.env.ZONE_ID,\n", " serviceUrl: process.env.API_ENDPOINT,\n", " version: '1',\n", "};\n", "\n", "const rulesetsV1 = new RulesetsV1(options);\n", "\n", "const params = {\n", " rulesetId: process.env.RULESET_ID,\n", "};\n", "\n", "rulesetsV1.getZoneRuleset(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " console.log('Zone ruleset:\\n', JSON.stringify(result, null, 2));\n", " })\n", " .catch(err => {\n", " console.error('Error retrieving zone ruleset:\\n', err);\n", " });\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "try {\n", " GetZoneRulesetOptions getZoneRulesetOptions = new GetZoneRulesetOptions.Builder()\n", " .rulesetId(\"55f63c45eb124c38b9a86c401d5f22d3\")\n", " .build();\n", "\n", " Response response = service.getZoneRuleset(getZoneRulesetOptions).execute();\n", " RulesetResp result = response.getResult();\n", "\n", " System.out.println(\"Ruleset ID: \" + result.getResult().getId());\n", " System.out.println(\"Name: \" + result.getResult().getName());\n", " System.out.println(\"Phase: \" + result.getResult().getPhase());\n", " System.out.println(\"Version: \" + result.getResult().getVersion());\n", "\n", "} catch (ServiceResponseException e) {\n", " System.err.printf(\"Service returned status code %d: %s\\nError details: %s\\n\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo());\n", "}\n" ] } ] } ] } } }, "put": { "tags": [ "Zone Rulesets" ], "summary": "Update a zone ruleset", "operationId": "update_zone_ruleset", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.zone-rulesets.update" } ] }, "description": "Update a specific zone ruleset.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "$ref": "#/components/parameters/ruleset_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_update" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "description": "Updated via Go SDK", "id": "42bc007e051c4766a0793d52a45f6900", "kind": "zone", "last_updated": "2025-09-24T17:35:57.635515Z", "name": "my-request-sanitizer", "phase": "http_request_sanitize", "version": "2", "rules": null } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/zones/$ZONE_ID/rulesets/$RULESET_ID \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\\\n", " -d '{\"description\":\"My ruleset to execute managed rulesets\",\"kind\":\"root\",\"name\":\"My ruleset\",\"phase\":\"http_request_firewall_custom\",\"rules\":[{\"action\":\"block\",\"action_parameters\":{\"response\":{\"content\":\"{\\n \\\"success\\\": false,\\n \\\"error\\\": \\\"you have been blocked\\\"\\n}\",\"content_type\":\"application/json\",\"status_code\":400}},\"description\":\"Block when the IP address is not 1.1.1.1\",\"enabled\":true,\"expression\":\"ip.src ne 1.1.1.1\",\"id\":\"3a03d665bac047339bb530ecb439a90d\",\"logging\":{\"enabled\":true},\"ref\":\"my_ref\"}]}'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"encoding/json\"\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/v5/core\"\n", " \"github.com/IBM/networking-go-sdk/rulesetsv1\"\n", ")\n", "\n", "func main() {\n", " authenticator := &core.IamAuthenticator{\n", " ApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", " URL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", " }\n", " serviceURL := os.Getenv(\"API_ENDPOINT\")\n", " crn := os.Getenv(\"CRN\")\n", " zoneID := os.Getenv(\"ZONE_ID\")\n", " rulesetID := os.Getenv(\"RULESET_ID\")\n", " options := &rulesetsv1.RulesetsV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: serviceURL,\n", " Authenticator: authenticator,\n", " Crn: &crn,\n", " ZoneIdentifier: &zoneID,\n", " }\n", " service, serviceErr := rulesetsv1.NewRulesetsV1(options)\n", " if serviceErr != nil {\n", " fmt.Fprintf(os.Stderr, \"Error creating RulesetsV1 service: %v\\n\", serviceErr)\n", " return\n", " }\n", " updateOptions := &rulesetsv1.UpdateZoneRulesetOptions{\n", " RulesetID: core.StringPtr(rulesetID),\n", " Description: core.StringPtr(\"Updated via Go SDK\"),\n", " }\n", " _, response, err := service.UpdateZoneRuleset(updateOptions)\n", " if err != nil {\n", " fmt.Fprintf(os.Stderr, \"Error updating ruleset: %v\\n\", err)\n", " return\n", " }\n", "\n", " fmt.Printf(\"UpdateZoneRuleset() response : %v\\n\", response.Result)\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "require('dotenv').config();\n", "\n", "const RulesetsV1 = require('ibm-networking-services/cis/rulesets/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: process.env.CIS_SERVICES_APIKEY,\n", " }),\n", " crn: process.env.CRN,\n", " zoneIdentifier: process.env.ZONE_ID,\n", " serviceUrl: process.env.API_ENDPOINT,\n", " version: '1',\n", "};\n", "\n", "const rulesetsV1 = new RulesetsV1(options);\n", "\n", "const params = {\n", " rulesetId: process.env.RULESET_ID,\n", " description: 'Updated description for the ruleset',\n", " kind: 'zone',\n", " phase: 'http_request_firewall_custom',\n", " rules: [\n", " {\n", " action: 'block',\n", " expression: 'ip.src == 192.0.2.100',\n", " description: 'Block traffic from a test IP',\n", " enabled: true,\n", " }\n", " ],\n", "};\n", "\n", "rulesetsV1.updateZoneRuleset(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " console.log('Ruleset updated successfully:\\n', JSON.stringify(result, null, 2));\n", " })\n", " .catch(err => {\n", " console.error('Error updating ruleset:\\n', err);\n", " });\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "try {\n", " List rules = new ArrayList<>();\n", " rules.add(new Rule.Builder()\n", " .id(\"df8f96e8baea4e14a03e1b04d7d5df22\")\n", " .action(\"block\")\n", " .expression(\"(http.request.uri.path contains \\\"/admin\\\")\")\n", " .enabled(true)\n", " .description(\"Block admin access\")\n", " .build());\n", "\n", " UpdateZoneRulesetOptions updateZoneRulesetOptions = new UpdateZoneRulesetOptions.Builder()\n", " .rulesetId(\"55f63c45eb124c38b9a86c401d5f22d3\")\n", " .name(\"Updated ruleset name\")\n", " .description(\"Updated description for ruleset\")\n", " .phase(\"http_request_firewall_custom\")\n", " .kind(\"zone\")\n", " .rules(rules)\n", " .build();\n", "\n", " Response response = service.updateZoneRuleset(updateZoneRulesetOptions).execute();\n", " RulesetResp result = response.getResult();\n", "\n", " System.out.println(\"Updated ruleset ID: \" + result.getResult().getId());\n", " System.out.println(\"Updated ruleset name: \" + result.getResult().getName());\n", "\n", "} catch (ServiceResponseException e) {\n", " System.err.printf(\"Service returned status code %d: %s\\nError details: %s\\n\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo());\n", "}\n" ] } ] } ] } } }, "delete": { "tags": [ "Zone Rulesets" ], "summary": "Delete a zone ruleset", "operationId": "delete_zone_ruleset", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.zone-rulesets.delete" } ] }, "description": "Delete a specific zone ruleset.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "$ref": "#/components/parameters/ruleset_id" } ], "responses": { "204": { "description": "Success" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/zones/$ZONE_ID/rulesets/$RULESET_ID \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"encoding/json\"\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/v5/core\"\n", " \"github.com/IBM/networking-go-sdk/rulesetsv1\"\n", ")\n", "\n", "func main() {\n", " authenticator := &core.IamAuthenticator{\n", " ApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", " URL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", " }\n", " serviceURL := os.Getenv(\"API_ENDPOINT\")\n", " crn := os.Getenv(\"CRN\")\n", " zoneID := os.Getenv(\"ZONE_ID\")\n", " rulesetID := os.Getenv(\"RULESET_ID\")\n", "\n", " options := &rulesetsv1.RulesetsV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: serviceURL,\n", " Authenticator: authenticator,\n", " Crn: &crn,\n", " ZoneIdentifier: &zoneID,\n", " }\n", " service, err := rulesetsv1.NewRulesetsV1(options)\n", " if err != nil {\n", " fmt.Printf(\"Error creating RulesetsV1 service: %v\\n\", err)\n", " return\n", " }\n", "\n", " deleteOptions := service.NewDeleteZoneRulesetOptions(rulesetID)\n", " response, err := service.DeleteZoneRuleset(deleteOptions)\n", " if err != nil {\n", " fmt.Printf(\"Error deleting ruleset: %v\\n\", err)\n", " return\n", " }\n", "\n", " fmt.Println(response)\n", " jsonBytes, err := json.MarshalIndent(response, \"\", \" \")\n", " if err != nil {\n", " fmt.Fprintf(os.Stderr, \"Error marshaling response: %v\\n\", err)\n", " return\n", " }\n", " fmt.Println(string(jsonBytes))\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "require('dotenv').config();\n", "\n", "const RulesetsV1 = require('ibm-networking-services/cis/rulesets/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "const rulesetsV1 = new RulesetsV1({\n", " authenticator: new IamAuthenticator({ apikey: process.env.CIS_SERVICES_APIKEY }),\n", " crn: process.env.CRN,\n", " zoneIdentifier: process.env.ZONE_ID,\n", " serviceUrl: process.env.API_ENDPOINT,\n", " version: '1',\n", "});\n", "\n", "const params = {\n", " rulesetId: process.env.RULESET_ID,\n", "};\n", "\n", "rulesetsV1.deleteZoneRuleset(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " console.log('Ruleset deleted successfully:\\n', JSON.stringify(result, null, 2));\n", " })\n", " .catch(err => {\n", " console.error('Error deleting ruleset:\\n', err);\n", " });\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "try {\n", " DeleteZoneRulesetOptions options = new DeleteZoneRulesetOptions.Builder()\n", " .rulesetId(\"example-ruleset-id\")\n", " .build();\n", "\n", " Response response = service.deleteZoneRuleset(options).execute();\n", " if (response.getStatusCode() == 204) {\n", " System.out.println(\"Zone ruleset deleted successfully.\");\n", " } else {\n", " System.out.println(\"Unexpected status code: \" + response.getStatusCode());\n", " }\n", "} catch (ServiceResponseException e) {\n", " System.err.printf(\"Service returned status code %d: %s\\nError details: %s\\n\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo());\n", "}\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/rulesets/{ruleset_id}/versions": { "get": { "tags": [ "Zone Rulesets" ], "summary": "List version of a zone ruleset", "operationId": "get_zone_ruleset_versions", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.zone-rulesets-versions.read" } ] }, "description": "List all versions of a specific zone ruleset.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "$ref": "#/components/parameters/ruleset_id" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_rulesets_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": [ { "description": "Created via Go SDK", "id": "1b7f639a68c84184a76deb59ce4c618e", "kind": "zone", "last_updated": "2025-09-24T17:24:34.765Z", "name": "my-custom-ruleset", "phase": "http_request_firewall_custom", "version": "1" } ] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/zones/$ZONE_ID/rulesets/$RULESET_ID/versions \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"encoding/json\"\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/v5/core\"\n", " \"github.com/IBM/networking-go-sdk/rulesetsv1\"\n", ")\n", "\n", "func main() {\n", " authenticator := &core.IamAuthenticator{\n", " ApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", " URL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", " }\n", " serviceURL := os.Getenv(\"API_ENDPOINT\")\n", " crn := os.Getenv(\"CRN\")\n", " zoneID := os.Getenv(\"ZONE_ID\")\n", " rulesetID := os.Getenv(\"RULESET_ID\")\n", "\n", " options := &rulesetsv1.RulesetsV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: serviceURL,\n", " Authenticator: authenticator,\n", " Crn: &crn,\n", " ZoneIdentifier: &zoneID,\n", " }\n", " service, err := rulesetsv1.NewRulesetsV1(options)\n", " if err != nil {\n", " fmt.Fprintf(os.Stderr, \"Error creating RulesetsV1 service: %v\\n\", err)\n", " return\n", " }\n", " getVersionsOptions := service.NewGetZoneRulesetVersionsOptions(rulesetID)\n", " _, response, err := service.GetZoneRulesetVersions(getVersionsOptions)\n", " if err != nil {\n", " fmt.Fprintf(os.Stderr, \"Error getting ruleset versions: %v\\n\", err)\n", " return\n", " }\n", " fmt.Printf(\"%+v\\n\", response.Result)\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "require('dotenv').config();\n", "\n", "const RulesetsV1 = require('ibm-networking-services/cis/rulesets/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: process.env.CIS_SERVICES_APIKEY,\n", " }),\n", " crn: process.env.CRN,\n", " zoneIdentifier: process.env.ZONE_ID,\n", " serviceUrl: process.env.API_ENDPOINT,\n", " version: '1',\n", "};\n", "\n", "const rulesetsV1 = new RulesetsV1(options);\n", "\n", "const params = {\n", " rulesetId: process.env.RULESET_ID,\n", "};\n", "\n", "rulesetsV1.getZoneRulesetVersions(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " console.log('Ruleset versions:\\n', JSON.stringify(result, null, 2));\n", " })\n", " .catch(err => {\n", " console.error('Error listing ruleset versions:\\n', err);\n", " });\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "try {\n", " GetZoneRulesetVersionsOptions getZoneRulesetVersionsOptions = new GetZoneRulesetVersionsOptions.Builder()\n", " .rulesetId(\"your-ruleset-id\")\n", " .build();\n", "\n", " Response response = service.getZoneRulesetVersions(getZoneRulesetVersionsOptions).execute();\n", " ListRulesetsResp listRulesetsRespResult = response.getResult();\n", "\n", " if (listRulesetsRespResult.getResult() != null) {\n", " listRulesetsRespResult.getResult().forEach(version -> {\n", " System.out.println(\"Ruleset Version ID: \" + version.getId());\n", " });\n", " }\n", "\n", "} catch (ServiceResponseException e) {\n", " System.err.printf(\"Service returned status code %d: %s\\nError details: %s\\n\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo());\n", "}\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/rulesets/{ruleset_id}/versions/{ruleset_version}": { "get": { "tags": [ "Zone Rulesets" ], "summary": "Get a specific version of a zone ruleset", "operationId": "get_zone_ruleset_version", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.zone-rulesets-versions.read" } ] }, "description": "View a specific version of a specific zone ruleset.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "$ref": "#/components/parameters/ruleset_id" }, { "$ref": "#/components/parameters/ruleset_version" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "description": "Created via Go SDK", "id": "1b7f639a68c84184a76deb59ce4c618e", "kind": "zone", "last_updated": "2025-09-24T17:24:34.765667Z", "name": "my-custom-ruleset", "phase": "http_request_firewall_custom", "version": "1", "rules": null } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/zones/$ZONE_ID/rulesets/$RULESET_ID/versions/$RULESET_VERSION \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"encoding/json\"\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/v5/core\"\n", " \"github.com/IBM/networking-go-sdk/rulesetsv1\"\n", ")\n", "\n", "func main() {\n", " authenticator := &core.IamAuthenticator{\n", " ApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", " URL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", " }\n", "\n", " serviceURL := os.Getenv(\"API_ENDPOINT\")\n", " crn := os.Getenv(\"CRN\")\n", " zoneID := os.Getenv(\"ZONE_ID\")\n", " rulesetID := os.Getenv(\"RULESET_ID\")\n", " rulesetVersion := os.Getenv(\"RULESET_VERSION\")\n", "\n", " options := &rulesetsv1.RulesetsV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: serviceURL,\n", " Authenticator: authenticator,\n", " Crn: &crn,\n", " ZoneIdentifier: &zoneID,\n", " }\n", "\n", " service, err := rulesetsv1.NewRulesetsV1(options)\n", " if err != nil {\n", " fmt.Fprintf(os.Stderr, \"Error creating RulesetsV1 service: %v\\n\", err)\n", " return\n", " }\n", "\n", " getVersionOptions := service.NewGetZoneRulesetVersionOptions(rulesetID, rulesetVersion)\n", " _, response, err := service.GetZoneRulesetVersion(getVersionOptions)\n", " if err != nil {\n", " fmt.Fprintf(os.Stderr, \"Error getting ruleset version: %v\\n\", err)\n", " return\n", " }\n", "\n", " jsonBytes, err := json.MarshalIndent(response.Result, \"\", \" \")\n", " if err != nil {\n", " fmt.Fprintf(os.Stderr, \"Error marshaling response: %v\\n\", err)\n", " return\n", " }\n", "\n", " fmt.Println(string(jsonBytes))\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "require('dotenv').config();\n", "\n", "const RulesetsV1 = require('ibm-networking-services/cis/rulesets/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: process.env.CIS_SERVICES_APIKEY,\n", " }),\n", " crn: process.env.CRN,\n", " zoneIdentifier: process.env.ZONE_ID,\n", " serviceUrl: process.env.API_ENDPOINT,\n", " version: process.env.RULESET_VERSION,\n", "};\n", "\n", "const rulesetsV1 = new RulesetsV1(options);\n", "\n", "const params = {\n", " rulesetId: process.env.RULESET_ID,\n", " rulesetVersion: process.env.RULESET_VERSION,\n", "};\n", "\n", "rulesetsV1.getZoneRulesetVersion(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " console.log('Specific Ruleset Version:\\n', JSON.stringify(result, null, 2));\n", " })\n", " .catch(err => {\n", " console.error('Error fetching ruleset version:\\n', err);\n", " });\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "try {\n", " GetZoneRulesetVersionOptions options = new GetZoneRulesetVersionOptions.Builder()\n", " .rulesetId(\"example-ruleset-id\")\n", " .rulesetVersion(\"v1\")\n", " .build();\n", "\n", " Response response = service.getZoneRulesetVersion(options).execute();\n", " RulesetResp rulesetRespResult = response.getResult();\n", "\n", " Ruleset ruleset = rulesetRespResult.getResult();\n", " System.out.println(\"Ruleset ID: \" + ruleset.getId());\n", " System.out.println(\"Version: \" + ruleset.getVersion());\n", " System.out.println(\"Name: \" + ruleset.getName());\n", "\n", "} catch (ServiceResponseException e) {\n", " System.err.printf(\"Service returned status code %d: %s\\nError details: %s\\n\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo());\n", "}\n" ] } ] } ] } } }, "delete": { "tags": [ "Zone Rulesets" ], "summary": "Delete a specific version of a zone ruleset", "operationId": "delete_zone_ruleset_version", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.zone-rulesets-versions.delete" } ] }, "description": "Delete a specific version of a specific zone ruleset.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "$ref": "#/components/parameters/ruleset_id" }, { "$ref": "#/components/parameters/ruleset_version" } ], "responses": { "204": { "description": "Success" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/zones/$ZONE_ID/rulesets/$RULESET_ID/versions/$RULESET_VERSION \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"encoding/json\"\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/v5/core\"\n", " \"github.com/IBM/networking-go-sdk/rulesetsv1\"\n", ")\n", "\n", "func main() {\n", " authenticator := &core.IamAuthenticator{\n", " ApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", " URL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", " }\n", "\n", " options := &rulesetsv1.RulesetsV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: os.Getenv(\"API_ENDPOINT\"),\n", " Authenticator: authenticator,\n", " Crn: core.StringPtr(os.Getenv(\"CRN\")),\n", " ZoneIdentifier: core.StringPtr(os.Getenv(\"ZONE_ID\")),\n", " }\n", "\n", " service, err := rulesetsv1.NewRulesetsV1(options)\n", " if err != nil {\n", " panic(err)\n", " }\n", "\n", " rulesetID := os.Getenv(\"RULESET_ID\")\n", "\n", " deletezoneentrypointruleset := &rulesetsv1.DeleteZoneRulesetVersionOptions{\n", " RulesetID: core.StringPtr(rulesetID),\n", " RulesetVersion: core.StringPtr(\"1\"),\n", " // RuleID: core.StringPtr(\"0565946a112748bc8c0425fdb16dc0bc\"),\n", " // RulesetPhase: core.StringPtr(os.Getenv(\"RULESET_PHASE\")),\n", " // Description: core.StringPtr(\"updated description\"),\n", " }\n", "\n", " // _, response, err := service.DeleteZoneRulesetVersion(updatezoneentrypointruleset)\n", " response, err := service.DeleteZoneRulesetVersion(deletezoneentrypointruleset)\n", " if err != nil {\n", " fmt.Printf(\"Error updating zone entrypoint ruleset: %v\\n\", err)\n", " return\n", " }\n", "\n", " jsonBytes, err := json.MarshalIndent(response.Result, \"\", \" \")\n", " if err != nil {\n", " fmt.Printf(\"Error marshaling response: %v\\n\", err)\n", " return\n", " }\n", " fmt.Println(string(jsonBytes))\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "require('dotenv').config();\n", "\n", "const RulesetsV1 = require('ibm-networking-services/cis/rulesets/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: process.env.CIS_SERVICES_APIKEY,\n", " }),\n", " crn: process.env.CRN,\n", " zoneIdentifier: process.env.ZONE_ID,\n", " serviceUrl: process.env.API_ENDPOINT,\n", " version: '1',\n", "};\n", "\n", "const rulesetsV1 = new RulesetsV1(options);\n", "\n", "const params = {\n", " rulesetId: process.env.RULESET_ID,\n", " rulesetVersion: process.env.RULESET_VERSION,\n", "};\n", "\n", "rulesetsV1.deleteZoneRulesetVersion(params)\n", " .then(response => {\n", " console.log('Ruleset version deleted successfully.');\n", " })\n", " .catch(err => {\n", " console.error('Error deleting ruleset version:', err);\n", " });\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "try {\n", " DeleteZoneRulesetVersionOptions options = new DeleteZoneRulesetVersionOptions.Builder()\n", " .rulesetId(\"example-ruleset-id\")\n", " .rulesetVersion(\"3\")\n", " .build();\n", "\n", " Response response = service.deleteZoneRulesetVersion(options).execute();\n", " if (response.getStatusCode() == 204) {\n", " System.out.println(\"Ruleset version deleted successfully.\");\n", " } else {\n", " System.out.println(\"Unexpected status code: \" + response.getStatusCode());\n", " }\n", "} catch (ServiceResponseException e) {\n", " System.err.printf(\"Service returned status code %d: %s\\nError details: %s\\n\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo());\n", "}\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/rulesets/phases/{ruleset_phase}/entrypoint": { "get": { "tags": [ "Zone Rulesets" ], "summary": "Get a zone entrypoint ruleset", "operationId": "get_zone_entrypoint_ruleset", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.zone-rulesets-phases-entrypoint.read" } ] }, "description": "Get the zone ruleset for the given phase's entrypoint.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "$ref": "#/components/parameters/ruleset_phase" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "description": "Created via Go SDK", "id": "1b7f639a68c84184a76deb59ce4c618e", "kind": "zone", "last_updated": "2025-09-24T17:24:34.765667Z", "name": "my-custom-ruleset", "phase": "http_request_firewall_custom", "version": "1", "rules": null } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/zones/$ZONE_ID/rulesets/phases/$RULESET_PHASE/entrypoint \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/v5/core\"\n", " \"github.com/IBM/networking-go-sdk/rulesetsv1\"\n", ")\n", "\n", "func main() {\n", " apiKey := os.Getenv(\"CIS_SERVICES_APIKEY\")\n", " authURL := os.Getenv(\"CIS_SERVICES_AUTH_URL\")\n", " serviceURL := os.Getenv(\"API_ENDPOINT\")\n", " crn := os.Getenv(\"CRN\")\n", " zoneID := os.Getenv(\"ZONE_ID\")\n", " phase := os.Getenv(\"RULESET_PHASE\")\n", " authenticator := &core.IamAuthenticator{\n", " ApiKey: apiKey,\n", " URL: authURL,\n", " }\n", "\n", " options := &rulesetsv1.RulesetsV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: serviceURL,\n", " Authenticator: authenticator,\n", " Crn: &crn,\n", " ZoneIdentifier: &zoneID,\n", " }\n", "\n", " service, err := rulesetsv1.NewRulesetsV1(options)\n", " if err != nil {\n", " fmt.Fprintf(os.Stderr, \"Error creating RulesetsV1 service: %v\\n\", err)\n", " return\n", " }\n", "\n", " getEntrypointOptions := service.NewGetZoneEntrypointRulesetOptions(phase)\n", " _, response, err := service.GetZoneEntrypointRuleset(getEntrypointOptions)\n", " if err != nil {\n", " fmt.Fprintf(os.Stderr, \"Error getting entrypoint ruleset: %v\\n\", err)\n", " return\n", " }\n", " fmt.Println(\"Headers:\", response.Result)\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "require('dotenv').config();\n", "\n", "const RulesetsV1 = require('ibm-networking-services/cis/rulesets/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: process.env.CIS_SERVICES_APIKEY,\n", " }),\n", " crn: process.env.CRN,\n", " zoneIdentifier: process.env.ZONE_ID,\n", " serviceUrl: process.env.API_ENDPOINT,\n", " version: '1',\n", "};\n", "\n", "const rulesetsV1 = new RulesetsV1(options);\n", "\n", "const params = {\n", " rulesetPhase: process.env.RULESET_PHASE,\n", "};\n", "\n", "rulesetsV1.getZoneEntrypointRuleset(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " console.log('Entrypoint Ruleset:\\n', JSON.stringify(result, null, 2));\n", " })\n", " .catch(err => {\n", " console.error('Error retrieving entrypoint ruleset:\\n', err);\n", " });\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "try {\n", " GetZoneEntrypointRulesetOptions options = new GetZoneEntrypointRulesetOptions.Builder()\n", " .rulesetPhase(\"http_request_firewall_custom\")\n", " .build();\n", "\n", " Response response = service.getZoneEntrypointRuleset(options).execute();\n", " RulesetResp rulesetResp = response.getResult();\n", "\n", " System.out.println(\"Ruleset ID: \" + rulesetResp.getResult().getId());\n", " System.out.println(\"Ruleset Name: \" + rulesetResp.getResult().getName());\n", "\n", "} catch (ServiceResponseException e) {\n", " System.err.printf(\"Service returned status code %d: %s\\nError details: %s\\n\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo());\n", "}\n" ] } ] } ] } } }, "put": { "tags": [ "Zone Rulesets" ], "summary": "Update a zone entrypoint ruleset", "operationId": "update_zone_entrypoint_ruleset", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.zone-rulesets-phases-entrypoint.update" } ] }, "description": "Updates the instance ruleset for the given phase's entry point.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "$ref": "#/components/parameters/ruleset_phase" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_update" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "description": "updated description", "id": "1b7f639a68c84184a76deb59ce4c618e", "kind": "zone", "last_updated": "2025-09-25T08:48:03.727462Z", "name": "my-custom-ruleset", "phase": "http_request_firewall_custom", "version": "7", "rules": null } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/zones/$ZONE_ID/rulesets/phases/$RULESET_PHASE/entrypoint \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\\\n", " -d '{\"description\":\"My ruleset to execute managed rulesets\",\"kind\":\"root\",\"name\":\"My ruleset\",\"phase\":\"http_request_firewall_custom\",\"rules\":[{\"action\":\"block\",\"action_parameters\":{\"response\":{\"content\":\"{\\n \\\"success\\\": false,\\n \\\"error\\\": \\\"you have been blocked\\\"\\n}\",\"content_type\":\"application/json\",\"status_code\":400}},\"description\":\"Block when the IP address is not 1.1.1.1\",\"enabled\":true,\"expression\":\"ip.src ne 1.1.1.1\",\"id\":\"3a03d665bac047339bb530ecb439a90d\",\"logging\":{\"enabled\":true},\"ref\":\"my_ref\"}]}'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"encoding/json\"\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/v5/core\"\n", " \"github.com/IBM/networking-go-sdk/rulesetsv1\"\n", ")\n", "\n", "func main() {\n", " authenticator := &core.IamAuthenticator{\n", " ApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", " URL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", " }\n", "\n", " options := &rulesetsv1.RulesetsV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: os.Getenv(\"API_ENDPOINT\"),\n", " Authenticator: authenticator,\n", " Crn: core.StringPtr(os.Getenv(\"CRN\")),\n", " ZoneIdentifier: core.StringPtr(os.Getenv(\"ZONE_ID\")),\n", " }\n", "\n", " service, err := rulesetsv1.NewRulesetsV1(options)\n", " if err != nil {\n", " panic(err)\n", " }\n", " updatezoneentrypointruleset := &rulesetsv1.UpdateZoneEntrypointRulesetOptions{\n", " RulesetPhase: core.StringPtr(os.Getenv(\"RULESET_PHASE\")),\n", " Description: core.StringPtr(\"updated description\"),\n", " }\n", "\n", " _, response, err := service.UpdateZoneEntrypointRuleset(updatezoneentrypointruleset)\n", " if err != nil {\n", " fmt.Printf(\"Error updating zone entrypoint ruleset: %v\\n\", err)\n", " return\n", " }\n", "\n", " jsonBytes, err := json.MarshalIndent(response.Result, \"\", \" \")\n", " if err != nil {\n", " fmt.Printf(\"Error marshaling response: %v\\n\", err)\n", " return\n", " }\n", " fmt.Println(string(jsonBytes))\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "require('dotenv').config();\n", "\n", "const RulesetsV1 = require('ibm-networking-services/cis/rulesets/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: process.env.CIS_SERVICES_APIKEY,\n", " }),\n", " crn: process.env.CRN,\n", " zoneIdentifier: process.env.ZONE_ID,\n", " serviceUrl: process.env.API_ENDPOINT,\n", " version: '1',\n", "};\n", "\n", "const rulesetsV1 = new RulesetsV1(options);\n", "\n", "const params = {\n", " rulesetPhase: process.env.RULESET_PHASE,\n", " description: 'Updated description',\n", " name: 'Updated Ruleset Name',\n", " rules: [\n", " {\n", " expression: 'ip.src eq 192.0.2.1',\n", " action: 'block',\n", " description: 'Block IP 192.0.2.1',\n", " },\n", " ],\n", "};\n", "\n", "rulesetsV1.updateZoneEntrypointRuleset(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " console.log(JSON.stringify(result, null, 2));\n", " })\n", " .catch(err => {\n", " console.error(err);\n", " });\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "try {\n", " // Example rules for the ruleset update\n", " List rules = new ArrayList<>();\n", " rules.add(new Rule.Builder()\n", " .id(\"rule-123\")\n", " .action(\"block\")\n", " .expression(\"(ip.src eq 203.0.113.5)\")\n", " .description(\"Block traffic from specific IP\")\n", " .enabled(true)\n", " .build());\n", "\n", " UpdateZoneEntrypointRulesetOptions options = new UpdateZoneEntrypointRulesetOptions.Builder()\n", " .rulesetPhase(\"http_request_firewall_custom\")\n", " .name(\"Updated Entrypoint Ruleset\")\n", " .description(\"Updated ruleset to block specific IP\")\n", " .phase(\"http_request_firewall_custom\")\n", " .kind(\"zone_lockdown\")\n", " .rules(rules)\n", " .build();\n", "\n", " Response response = service.updateZoneEntrypointRuleset(options).execute();\n", " RulesetResp updatedRuleset = response.getResult();\n", "\n", " System.out.println(\"Updated ruleset ID: \" + updatedRuleset.getResult().getId());\n", " System.out.println(\"Ruleset name: \" + updatedRuleset.getResult().getName());\n", "\n", "} catch (ServiceResponseException e) {\n", " System.err.printf(\"Service returned status code %d: %s\\nError details: %s\\n\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo());\n", "}\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/rulesets/phases/{ruleset_phase}/entrypoint/versions": { "get": { "tags": [ "Zone Rulesets" ], "summary": "List a zone entry point ruleset's versions", "operationId": "get_zone_entry_point_ruleset_versions", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.zone-rulesets-phases-entrypoint-versions.read" } ] }, "description": "Lists the zone ruleset versions for the given phase's entry point.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "$ref": "#/components/parameters/ruleset_phase" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_rulesets_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": [ { "description": "Updated description for the ruleset", "id": "1b7f639a68c84184a76deb59ce4c618e", "kind": "zone", "last_updated": "2025-10-05T19:12:56.604477Z", "name": "my-custom-ruleset", "phase": "http_request_firewall_custom", "source": "firewall_custom", "version": "13" }, { "description": "Created via Go SDK", "id": "1b7f639a68c84184a76deb59ce4c618e", "kind": "zone", "last_updated": "2025-09-25T06:58:58.932724Z", "name": "my-custom-ruleset", "phase": "http_request_firewall_custom", "source": "firewall_custom", "version": "4" }, { "description": "Created via Go SDK", "id": "1b7f639a68c84184a76deb59ce4c618e", "kind": "zone", "last_updated": "2025-09-25T06:51:51.14351Z", "name": "my-custom-ruleset", "phase": "http_request_firewall_custom", "source": "firewall_custom", "version": "3" }, { "description": "Created via Go SDK", "id": "1b7f639a68c84184a76deb59ce4c618e", "kind": "zone", "last_updated": "2025-09-25T06:51:26.40789Z", "name": "my-custom-ruleset", "phase": "http_request_firewall_custom", "source": "firewall_custom", "version": "2" } ] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/zones/$ZONE_ID/rulesets/phases/$RULESET_PHASE/entrypoint/versions \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"encoding/json\"\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/v5/core\"\n", " \"github.com/IBM/networking-go-sdk/rulesetsv1\"\n", ")\n", "\n", "func main() {\n", " authenticator := &core.IamAuthenticator{\n", " ApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", " URL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", " }\n", "\n", " options := &rulesetsv1.RulesetsV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: os.Getenv(\"API_ENDPOINT\"),\n", " Authenticator: authenticator,\n", " Crn: core.StringPtr(os.Getenv(\"CRN\")),\n", " ZoneIdentifier: core.StringPtr(os.Getenv(\"ZONE_ID\")),\n", " }\n", "\n", " service, err := rulesetsv1.NewRulesetsV1(options)\n", " if err != nil {\n", " panic(err)\n", " }\n", " getzonerulesetversions := &rulesetsv1.GetZoneEntryPointRulesetVersionsOptions{\n", " RulesetPhase: core.StringPtr(os.Getenv(\"RULESET_PHASE\")),\n", " }\n", "\n", " _, response, err := service.GetZoneEntryPointRulesetVersions(getzonerulesetversions)\n", " if err != nil {\n", " fmt.Printf(\"Error getting ruleset versions: %v\\n\", err)\n", " return\n", " }\n", "\n", " jsonBytes, err := json.MarshalIndent(response.Result, \"\", \" \")\n", " if err != nil {\n", " fmt.Printf(\"Error marshaling response: %v\\n\", err)\n", " return\n", " }\n", " fmt.Println(string(jsonBytes))\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "require('dotenv').config();\n", "\n", "const RulesetsV1 = require('ibm-networking-services/cis/rulesets/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: process.env.CIS_SERVICES_APIKEY,\n", " }),\n", " crn: process.env.CRN,\n", " zoneIdentifier: process.env.ZONE_ID,\n", " serviceUrl: process.env.API_ENDPOINT,\n", "};\n", "\n", "const rulesetsV1 = new RulesetsV1(options);\n", "\n", "const params = {\n", " rulesetPhase: process.env.RULESET_PHASE,\n", "};\n", "\n", "rulesetsV1.getZoneEntryPointRulesetVersions(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " console.log('Entrypoint Ruleset Versions:\\n', JSON.stringify(result, null, 2));\n", " })\n", " .catch(err => {\n", " console.error('Error fetching entrypoint ruleset versions:\\n', err);\n", " });\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "try {\n", " GetZoneEntryPointRulesetVersionsOptions options = new GetZoneEntryPointRulesetVersionsOptions.Builder()\n", " .rulesetPhase(\"http_request_firewall_custom\")\n", " .build();\n", "\n", " Response response = service.getZoneEntryPointRulesetVersions(options).execute();\n", " ListRulesetsResp listRulesetsResp = response.getResult();\n", "\n", " System.out.println(\"Number of versions: \" + listRulesetsResp.getResult().size());\n", " for (RulesetResp version : listRulesetsResp.getResult()) {\n", " System.out.println(\"Version ID: \" + version.getId());\n", " System.out.println(\"Name: \" + version.getName());\n", " System.out.println(\"Created on: \" + version.getCreatedOn());\n", " }\n", "\n", "} catch (ServiceResponseException e) {\n", " System.err.printf(\"Service returned status code %d: %s\\nError details: %s\\n\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo());\n", "}\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}": { "get": { "tags": [ "Zone Rulesets" ], "summary": "Get a zone entry point ruleset version", "operationId": "get_zone_entry_point_ruleset_version", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.zone-rulesets-phases-entrypoint-versions.read" } ] }, "description": "Fetches a specific version of a zone entry point ruleset.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "$ref": "#/components/parameters/ruleset_phase" }, { "$ref": "#/components/parameters/ruleset_version" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "description": "Created via Go SDK", "id": "1b7f639a68c84184a76deb59ce4c618e", "kind": "zone", "last_updated": "2025-09-24T17:24:34.765667Z", "name": "my-custom-ruleset", "phase": "http_request_firewall_custom", "version": "1", "rules": null } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/zones/$ZONE_ID/rulesets/phases/$RULESET_PHASE/entrypoint/versions/$RULESET_VERSION \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main", "", "import (", " \"encoding/json\"", " \"fmt\"", " \"os\"", "", " \"github.com/IBM/go-sdk-core/v5/core\"", " \"github.com/IBM/networking-go-sdk/rulesetsv1\"", ")", "", "func main() {", " authenticator := &core.IamAuthenticator{", " ApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),", " URL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),", " }", "", " options := &rulesetsv1.RulesetsV1Options{", " ServiceName: \"cis_services\",", " URL: os.Getenv(\"API_ENDPOINT\"),", " Authenticator: authenticator,", " Crn: core.StringPtr(os.Getenv(\"CRN\")),", " ZoneIdentifier: core.StringPtr(os.Getenv(\"ZONE_ID\")),", " }", "", " service, err := rulesetsv1.NewRulesetsV1(options)", " if err != nil {", " panic(err)", " }", "", " getzonerulesetversion := &rulesetsv1.GetZoneEntryPointRulesetVersionOptions{", " RulesetVersion: core.StringPtr(\"1\"),", " RulesetPhase: core.StringPtr(os.Getenv(\"RULESET_PHASE\")),", " }", "", " _, response, err := service.GetZoneEntryPointRulesetVersion(getzonerulesetversion)", " if err != nil {", " fmt.Printf(\"Error getting ruleset rule: %v\\n\", err)", " return", " }", "", " jsonBytes, err := json.MarshalIndent(response.Result, \"\", \" \")", " if err != nil {", " fmt.Printf(\"Error marshaling response: %v\\n\", err)", " return", " }", " fmt.Println(string(jsonBytes))", "}" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "require('dotenv').config();\n", "\n", "const RulesetsV1 = require('ibm-networking-services/cis/rulesets/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: process.env.CIS_SERVICES_APIKEY,\n", " }),\n", " crn: process.env.CRN,\n", " zoneIdentifier: process.env.ZONE_ID,\n", " serviceUrl: process.env.API_ENDPOINT,\n", " version: '1',\n", "};\n", "\n", "const rulesetsV1 = new RulesetsV1(options);\n", "\n", "const params = {\n", " rulesetPhase: process.env.RULESET_PHASE,\n", " rulesetVersion: process.env.RULESET_VERSION,\n", "};\n", "\n", "rulesetsV1.getZoneEntryPointRulesetVersion(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " console.log('Entrypoint Ruleset Version Details:\\n', JSON.stringify(result, null, 2));\n", " })\n", " .catch(err => {\n", " console.error('Error fetching entrypoint ruleset version:\\n', err);\n", " });\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "try {\n", " GetZoneEntryPointRulesetVersionOptions options = new GetZoneEntryPointRulesetVersionOptions.Builder()\n", " .rulesetPhase(\"http_request_firewall_custom\")\n", " .rulesetVersion(\"version1\")\n", " .build();\n", "\n", " Response response = service.getZoneEntryPointRulesetVersion(options).execute();\n", " RulesetResp rulesetResp = response.getResult();\n", "\n", " System.out.println(\"Ruleset ID: \" + rulesetResp.getResult().getId());\n", " System.out.println(\"Name: \" + rulesetResp.getResult().getName());\n", " System.out.println(\"Description: \" + rulesetResp.getResult().getDescription());\n", " System.out.println(\"Phase: \" + rulesetResp.getResult().getPhase());\n", " System.out.println(\"Created On: \" + rulesetResp.getResult().getCreatedOn());\n", " System.out.println(\"Modified On: \" + rulesetResp.getResult().getModifiedOn());\n", "\n", "} catch (ServiceResponseException e) {\n", " System.err.printf(\"Service returned status code %d: %s\\nError details: %s\\n\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo());\n", "}\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/rulesets/{ruleset_id}/rules": { "post": { "tags": [ "Zone Rulesets" ], "summary": "Create a zone ruleset rule", "operationId": "create_zone_ruleset_rule", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.zone-rulesets-rules.create" } ] }, "description": "Create a zone ruleset rule.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "$ref": "#/components/parameters/ruleset_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_create" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "description": "updated description", "id": "1b7f639a68c84184a76deb59ce4c618e", "kind": "zone", "last_updated": "2025-10-05T18:19:48.156251Z", "name": "my-custom-ruleset", "phase": "http_request_firewall_custom", "version": "10", "source": "firewall_custom", "rules": [ { "action": "block", "description": "Block traffic from IP 192.0.2.1", "enabled": true, "expression": "ip.src == 192.0.2.1", "id": "73f8b4b296a34285b4d638ac110291c9", "last_updated": "2025-10-05T18:12:46.865395Z", "ref": "73f8b4b296a34285b4d638ac110291c9", "version": "1" }, { "action": "block", "description": "Block specific IP", "enabled": true, "expression": "ip.src == 192.0.2.1", "id": "2e3c9fe4c0bd4c80a0e4e7ec855681a1", "last_updated": "2025-10-05T18:18:29.4285Z", "ref": "2e3c9fe4c0bd4c80a0e4e7ec855681a1", "version": "1" }, { "action": "block", "description": "Block specific IP", "enabled": true, "expression": "ip.src == 192.0.2.1", "id": "be24069f34904fe28ae1dd734f982f43", "last_updated": "2025-10-05T18:19:48.156251Z", "ref": "be24069f34904fe28ae1dd734f982f43", "version": "1" } ] } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/zones/$ZONE_ID/rulesets/$RULESET_ID/rules \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\\\n", " -d '{\"action\":\"block\",\"action_parameters\":{\"response\":{\"content\":\"{\\n \\\"success\\\": false,\\n \\\"error\\\": \\\"you have been blocked\\\"\\n}\",\"content_type\":\"application/json\",\"status_code\":400}},\"description\":\"Block when the IP address is not 1.1.1.1\",\"enabled\":true,\"expression\":\"ip.src ne 1.1.1.1\",\"id\":\"3a03d665bac047339bb530ecb439a90d\",\"logging\":{\"enabled\":true},\"ref\":\"my_ref\",\"position\":{\"before\":\"da5e8e506c8e7877fe06cdf4c41add54\"}}'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"context\"\n", " \"encoding/json\"\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/v5/core\"\n", " \"github.com/IBM/networking-go-sdk/rulesetsv1\"\n", ")\n", "\n", "func main() {\n", " authenticator := &core.IamAuthenticator{\n", " ApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", " URL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", " }\n", "\n", " options := &rulesetsv1.RulesetsV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: os.Getenv(\"API_ENDPOINT\"),\n", " Authenticator: authenticator,\n", " Crn: core.StringPtr(os.Getenv(\"CRN\")),\n", " ZoneIdentifier: core.StringPtr(os.Getenv(\"ZONE_ID\")),\n", " }\n", "\n", " service, err := rulesetsv1.NewRulesetsV1(options)\n", " if err != nil {\n", " panic(err)\n", " }\n", "\n", " rulesetID := os.Getenv(\"RULESET_ID\")\n", "\n", " action := \"block\"\n", " expression := `true`\n", " description := \"temporary rule\"\n", " enabled := true\n", "\n", " createRuleOpts := &rulesetsv1.CreateZoneRulesetRuleOptions{\n", " RulesetID: core.StringPtr(rulesetID),\n", " Action: &action,\n", " Expression: &expression,\n", " Description: &description,\n", " Enabled: &enabled,\n", " }\n", "\n", " _, response, err := service.CreateZoneRulesetRuleWithContext(context.Background(), createRuleOpts)\n", " if err != nil {\n", " fmt.Printf(\"Error creating ruleset rule: %v\\n\", err)\n", " return\n", " }\n", "\n", " jsonBytes, err := json.MarshalIndent(response.Result, \"\", \" \")\n", " if err != nil {\n", " fmt.Printf(\"Error marshaling response: %v\\n\", err)\n", " return\n", " }\n", " fmt.Println(string(jsonBytes))\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "require('dotenv').config();\n", "\n", "const RulesetsV1 = require('ibm-networking-services/cis/rulesets/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: process.env.CIS_SERVICES_APIKEY,\n", " }),\n", " crn: process.env.CRN,\n", " zoneIdentifier: process.env.ZONE_ID,\n", " serviceUrl: process.env.API_ENDPOINT,\n", " version: '1',\n", "};\n", "\n", "const rulesetsV1 = new RulesetsV1(options);\n", "\n", "const params = {\n", " rulesetId: process.env.RULESET_ID,\n", " action: 'block',\n", " expression: 'ip.src == 192.0.2.1',\n", " description: 'Block specific IP',\n", " enabled: true,\n", "};\n", "\n", "rulesetsV1.createZoneRulesetRule(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " console.log('Rule created successfully:\\n', JSON.stringify(result, null, 2));\n", " })\n", " .catch(err => {\n", " console.error('Error creating rule:\\n', err);\n", " });\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "try {\n", " RulesetActionParameters rulesetActionParameters = new RulesetActionParameters.Builder()\n", " .id(\"cf-unique-header-id\")\n", " .value(\"some-value\")\n", " .build();\n", "\n", " Ratelimit ratelimit = new Ratelimit.Builder()\n", " .characteristics(new ArrayList<>(Arrays.asList(\"ip.src\")))\n", " .period(60L)\n", " .requestsPerPeriod(1000L)\n", " .action(new RatelimitAction.Builder()\n", " .mode(\"simulate\")\n", " .timeout(60L)\n", " .response(new RatelimitResponse.Builder()\n", " .contentType(\"text/plain\")\n", " .body(\"Rate limit exceeded\")\n", " .build())\n", " .build())\n", " .build();\n", "\n", " Logging logging = new Logging.Builder()\n", " .enabled(true)\n", " .build();\n", "\n", " CreateZoneRulesetRuleOptions createZoneRulesetRuleOptions = new CreateZoneRulesetRuleOptions.Builder()\n", " .rulesetId(\"example-ruleset-id\")\n", " .action(\"set_header\")\n", " .actionParameters(rulesetActionParameters)\n", " .ratelimit(ratelimit)\n", " .expression(\"(http.request.uri.path ~ \\\"^/admin\\\")\")\n", " .description(\"Set header for /admin path\")\n", " .enabled(true)\n", " .logging(logging)\n", " .build();\n", "\n", " Response response = service.createZoneRulesetRule(createZoneRulesetRuleOptions).execute();\n", " RulesetResp result = response.getResult();\n", "\n", " String ruleId = result.getResult().getId();\n", " System.out.println(\"Created rule with ID: \" + ruleId);\n", "\n", "} catch (ServiceResponseException e) {\n", " System.err.printf(\"Service returned status code %d: %s\\nError details: %s\\n\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo());\n", "}\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/rulesets/{ruleset_id}/rules/{rule_id}": { "patch": { "tags": [ "Zone Rulesets" ], "summary": "Update a zone ruleset rule", "operationId": "update_zone_ruleset_rule", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.zone-rulesets-rules.update" } ] }, "description": "Update a zone ruleset rule.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "$ref": "#/components/parameters/ruleset_id" }, { "$ref": "#/components/parameters/rule_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_update" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "description": "Created via Go SDK", "id": "1b7f639a68c84184a76deb59ce4c618e", "kind": "zone", "last_updated": "2025-09-25T07:12:47.382454Z", "name": "my-custom-ruleset", "phase": "http_request_firewall_custom", "version": "5", "rules": [ { "id": "6fb5e1eb7e78479ebc679838e78c0b79", "version": "1", "action": "block", "enabled": true, "description": "temp desc", "expression": "true", "ref": "6fb5e1eb7e78479ebc679838e78c0b79", "last_updated": "2025-09-25T06:51:26.40789Z" }, { "id": "dc976c1bf1c142dba8e94511d7ea1ba6", "version": "1", "action": "block", "enabled": false, "description": "temp desc 1", "expression": "true", "ref": "dc976c1bf1c142dba8e94511d7ea1ba6", "last_updated": "2025-09-25T06:51:51.14351Z" }, { "id": "0565946a112748bc8c0425fdb16dc0bc", "version": "2", "action": "block", "enabled": true, "description": "updated temp rule", "expression": "true", "ref": "0565946a112748bc8c0425fdb16dc0bc", "last_updated": "2025-09-25T07:12:47.382454Z" } ] } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/zones/$ZONE_ID/rulesets/$RULESET_ID/rules/$RULE_ID \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\\\n", " -d '{\"action\":\"block\",\"action_parameters\":{\"response\":{\"content\":\"{\\n \\\"success\\\": false,\\n \\\"error\\\": \\\"you have been blocked\\\"\\n}\",\"content_type\":\"application/json\",\"status_code\":400}},\"description\":\"Block when the IP address is not 1.1.1.1\",\"enabled\":true,\"expression\":\"ip.src ne 1.1.1.1\",\"id\":\"3a03d665bac047339bb530ecb439a90d\",\"logging\":{\"enabled\":true},\"ref\":\"my_ref\",\"position\":{\"before\":\"da5e8e506c8e7877fe06cdf4c41add54\"}}'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"context\"\n", " \"encoding/json\"\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/v5/core\"\n", " \"github.com/IBM/networking-go-sdk/rulesetsv1\"\n", ")\n", "\n", "func main() {\n", " authenticator := &core.IamAuthenticator{\n", " ApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", " URL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", " }\n", "\n", " options := &rulesetsv1.RulesetsV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: os.Getenv(\"API_ENDPOINT\"),\n", " Authenticator: authenticator,\n", " Crn: core.StringPtr(os.Getenv(\"CRN\")),\n", " ZoneIdentifier: core.StringPtr(os.Getenv(\"ZONE_ID\")),\n", " }\n", "\n", " service, err := rulesetsv1.NewRulesetsV1(options)\n", " if err != nil {\n", " panic(err)\n", " }\n", "\n", " rulesetID := os.Getenv(\"RULESET_ID\")\n", "\n", " action := \"block\"\n", " expression := `true`\n", " description := \"updated temp rule\"\n", " enabled := true\n", "\n", " updateRuleOpts := &rulesetsv1.UpdateZoneRulesetRuleOptions{\n", " RulesetID: core.StringPtr(rulesetID),\n", " RuleID: core.StringPtr(\"0565946a112748bc8c0425fdb16dc0bc\"),\n", " Action: &action,\n", " Expression: &expression,\n", " Description: &description,\n", " Enabled: &enabled,\n", " }\n", "\n", " _, response, err := service.UpdateZoneRulesetRuleWithContext(context.Background(), updateRuleOpts)\n", " if err != nil {\n", " fmt.Printf(\"Error updating ruleset rule: %v\\n\", err)\n", " return\n", " }\n", "\n", " jsonBytes, err := json.MarshalIndent(response.Result, \"\", \" \")\n", " if err != nil {\n", " fmt.Printf(\"Error marshaling response: %v\\n\", err)\n", " return\n", " }\n", " fmt.Println(string(jsonBytes))\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "require('dotenv').config();\n", "\n", "const RulesetsV1 = require('ibm-networking-services/cis/rulesets/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: process.env.CIS_SERVICES_APIKEY,\n", " }),\n", " crn: process.env.CRN,\n", " zoneIdentifier: process.env.ZONE_ID,\n", " serviceUrl: process.env.API_ENDPOINT,\n", " version: '1',\n", "};\n", "\n", "const rulesetsV1 = new RulesetsV1(options);\n", "\n", "const params = {\n", " rulesetId: process.env.RULESET_ID,\n", " ruleId: process.env.RULE_ID,\n", " action: 'challenge',\n", " description: 'Updated to challenge suspicious IPs',\n", " enabled: true,\n", " expression: 'ip.src == 192.0.2.2',\n", "};\n", "\n", "rulesetsV1.updateZoneRulesetRule(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " console.log('Rule updated successfully:\\n', JSON.stringify(result, null, 2));\n", " })\n", " .catch(err => {\n", " console.error('Error updating rule:\\n', err);\n", " });\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "try {\n", " RulesetActionParameters updatedActionParameters = new RulesetActionParameters.Builder()\n", " .id(\"cf-unique-header-id\")\n", " .value(\"updated-value\")\n", " .build();\n", "\n", " Logging updatedLogging = new Logging.Builder()\n", " .enabled(false)\n", " .build();\n", "\n", " UpdateZoneRulesetRuleOptions updateZoneRulesetRuleOptions = new UpdateZoneRulesetRuleOptions.Builder()\n", " .rulesetId(\"example-ruleset-id\")\n", " .ruleId(\"df8f96e8baea4e14a03e1b04d7d5df22\")\n", " .action(\"set_header\")\n", " .actionParameters(updatedActionParameters)\n", " .expression(\"(http.request.uri.path ~ \\\"^/admin\\\")\")\n", " .description(\"Updated rule for admin path\")\n", " .enabled(true)\n", " .logging(updatedLogging)\n", " .build();\n", "\n", " Response response = service.updateZoneRulesetRule(updateZoneRulesetRuleOptions).execute();\n", " RulesetResp updatedResult = response.getResult();\n", "\n", " System.out.println(\"Updated rule ID: \" + updatedResult.getResult().getId());\n", "\n", "} catch (ServiceResponseException e) {\n", " System.err.printf(\"Service returned status code %d: %s\\nError details: %s\\n\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo());\n", "}\n" ] } ] } ] } } }, "delete": { "tags": [ "Zone Rulesets" ], "summary": "Delete a zone ruleset rule", "operationId": "delete_zone_ruleset_rule", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.zone-rulesets-rules.delete" } ] }, "description": "Delete an instance ruleset rule.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "$ref": "#/components/parameters/ruleset_id" }, { "$ref": "#/components/parameters/rule_id" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/zones/$ZONE_ID/rulesets/$RULESET_ID/rules/$RULE_ID \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"encoding/json\"\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/v5/core\"\n", " \"github.com/IBM/networking-go-sdk/rulesetsv1\"\n", ")\n", "\n", "func main() {\n", " authenticator := &core.IamAuthenticator{\n", " ApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", " URL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", " }\n", "\n", " options := &rulesetsv1.RulesetsV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: os.Getenv(\"API_ENDPOINT\"),\n", " Authenticator: authenticator,\n", " Crn: core.StringPtr(os.Getenv(\"CRN\")),\n", " ZoneIdentifier: core.StringPtr(os.Getenv(\"ZONE_ID\")),\n", " }\n", "\n", " service, err := rulesetsv1.NewRulesetsV1(options)\n", " if err != nil {\n", " panic(err)\n", " }\n", "\n", " rulesetID := os.Getenv(\"RULESET_ID\")\n", "\n", " deleteRuleOps := &rulesetsv1.DeleteZoneRulesetRuleOptions{\n", " RulesetID: core.StringPtr(rulesetID),\n", " RuleID: core.StringPtr(\"0565946a112748bc8c0425fdb16dc0bc\"),\n", " }\n", "\n", " _, response, err := service.DeleteZoneRulesetRule(deleteRuleOps)\n", " if err != nil {\n", " fmt.Printf(\"Error deleting ruleset rule: %v\\n\", err)\n", " return\n", " }\n", "\n", " jsonBytes, err := json.MarshalIndent(response.Result, \"\", \" \")\n", " if err != nil {\n", " fmt.Printf(\"Error marshaling response: %v\\n\", err)\n", " return\n", " }\n", " fmt.Println(string(jsonBytes))\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "require('dotenv').config();\n", "\n", "const RulesetsV1 = require('ibm-networking-services/cis/rulesets/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: process.env.CIS_SERVICES_APIKEY,\n", " }),\n", " crn: process.env.CRN,\n", " zoneIdentifier: process.env.ZONE_ID,\n", " serviceUrl: process.env.API_ENDPOINT,\n", " version: '1',\n", "};\n", "\n", "const rulesetsV1 = new RulesetsV1(options);\n", "\n", "const params = {\n", " rulesetId: process.env.RULESET_ID,\n", " ruleId: process.env.RULE_ID,\n", "};\n", "\n", "rulesetsV1.deleteZoneRulesetRule(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " console.log('Rule deleted successfully:\\n', JSON.stringify(result, null, 2));\n", " })\n", " .catch(err => {\n", " console.error('Error deleting rule:\\n', err);\n", " });\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "try {\n", " DeleteZoneRulesetRuleOptions deleteZoneRulesetRuleOptions = new DeleteZoneRulesetRuleOptions.Builder()\n", " .rulesetId(\"example-ruleset-id\")\n", " .ruleId(\"df8f96e8baea4e14a03e1b04d7d5df22\")\n", " .build();\n", "\n", " Response response = service.deleteZoneRulesetRule(deleteZoneRulesetRuleOptions).execute();\n", " RuleResp result = response.getResult();\n", "\n", " System.out.println(\"Deleted rule ID: \" + result.getResult().getId());\n", "\n", "} catch (ServiceResponseException e) {\n", " System.err.printf(\"Service returned status code %d: %s\\nError details: %s\\n\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo());\n", "}\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/routing/smart_routing": { "get": { "tags": [ "Routing" ], "summary": "Get Routing feature smart routing setting", "operationId": "get_smart_routing", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.performance.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.smart-routing.read" } ] }, "description": "Get Routing feature smart routing setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/smart_routing_resp" }, "examples": { "response": { "value": { "result": { "id": "smart_routing", "value": "on", "editable": true, "modified_on": "2018-01-01T05:20:00.123Z" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/routing/smart_routing \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import RoutingV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " route = RoutingV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " route.set_service_url(endpoint)\n", " resp = route.get_smart_routing()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/routingv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &routingv1.RoutingV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := routingv1.NewRoutingV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewGetSmartRoutingOptions()\n", "\tresult, response, err := service.GetSmartRouting(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetSmartRoutingOptions getSmartRoutingOptions = new GetSmartRoutingOptions();\n", "\n", " // Invoke operation\n", " Response response = service.getSmartRouting(getSmartRoutingOptions).execute();\n", " SmartRoutingResp smartRoutingRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const RoutingAPI = require('ibm-networking-services/cis/routing/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "}\n", "\n", "const routingApi = new RoutingAPI(options);\n", "\n", "routingApi.getSmartRouting()\n", " .then(response => {\n", " const routing = response.result.result;\n", " console.log(routing);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "patch": { "tags": [ "Routing" ], "summary": "Update Routing feature smart route setting", "operationId": "update_smart_routing", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.performance.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.smart-routing.update" } ] }, "description": "Update Routing feature smart route setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/smart_routing_setting" } } }, "description": "Update Routing feature smart routing setting." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/smart_routing_resp" }, "examples": { "response": { "value": { "result": { "id": "smart_routing", "value": "on", "editable": true, "modified_on": "2018-01-01T05:20:00.123Z" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/routing/smart_routing \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import RoutingV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " route = RoutingV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " route.set_service_url(endpoint)\n", " resp = route.update_smart_routing(value=\"on\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/routingv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &routingv1.RoutingV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := routingv1.NewRoutingV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewUpdateSmartRoutingOptions()\n", "\toptions.SetValue(routingv1.UpdateSmartRoutingOptions_Value_On)\n", "\tresult, response, err := service.UpdateSmartRouting(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " UpdateSmartRoutingOptions updateSmartRoutingOptions = new UpdateSmartRoutingOptions.Builder()\n", " .value(\"on\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.updateSmartRouting(updateSmartRoutingOptions).execute();\n", " SmartRoutingResp smartRoutingRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " value: 'on', // valid values 'on' or 'off'\n", "};\n", "\n", "routingApi.updateSmartRouting(params)\n", " .then(response => {\n", " const updatedRouting = response.result.result;\n", " console.log(updatedRouting);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/routing/tiered_caching": { "get": { "tags": [ "Routing" ], "summary": "Get routing tiered cache setting", "operationId": "get_routing_tiered_caching", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.performance.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.tiered-caching.read" } ] }, "description": "Get routing tiered cache setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routing_tiered_caching_resp" }, "examples": { "response": { "value": { "result": { "id": "tiered_caching", "value": "on", "editable": true, "modified_on": "2018-01-01T05:20:00.123Z" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/routing/tiered_caching \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " resp = route.get_routing_tiered_caching(crn=crn, zone_identifier=zone_id)\n" ] } ] } ] } } }, "patch": { "tags": [ "Routing" ], "summary": "Update routing tiered cache setting", "operationId": "update_routing_tiered_caching", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.performance.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.tiered-caching.update" } ] }, "description": "Update routing tiered cache setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routing_tiered_caching_setting" } } }, "description": "Update routing tiered cache setting." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routing_tiered_caching_resp" }, "examples": { "response": { "value": { "result": { "id": "tiered_caching", "value": "on", "editable": true, "modified_on": "2018-01-01T05:20:00.123Z" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/routing/tiered_caching \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " resp = route.update_routing_tiered_caching(crn=crn, zone_identifier=zone_id, value=\"on\")\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/routing/latency": { "get": { "tags": [ "Routing" ], "summary": "Get Routing Latency Analytics", "operationId": "get_routing_latency", "description": "Get Routing Latency Analytics for a given zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "query", "name": "bins", "description": "The number of bins", "required": false, "example": 50, "schema": { "type": "integer", "maximum": 1000 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routing_latency_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/routing/latency \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " resp = route.get_routing_latency(crn=crn, zone_identifier=zone_id)\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/routing/latency/colos": { "get": { "tags": [ "Routing" ], "summary": "Get Routing Latency Colos Analytics", "operationId": "get_routing_latency_colos", "description": "Get Routing Latency Colos Analytics for a given zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/routing_latency_colos_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/routing/latency/colos \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " resp = route.get_routing_latency(crn=crn, zone_identifier=zone_id)\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/dnssec": { "get": { "tags": [ "Zones Settings" ], "summary": "Get zone DNSSEC", "operationId": "get_zone_dnssec", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.reliability.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.dnssec.read" } ] }, "description": "Get DNSSEC setting for a given zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zones_dnssec_resp" }, "examples": { "response": { "value": { "result": { "status": "pending", "flags": 257, "algorithm": "13", "key_type": "ECDSAP256SHA256", "digest_type": "2", "digest_algorithm": "SHA256", "digest": "97C2244DC33CBC0B0E83A8B63209A7F160A5B7F779E23B1104744FB2821A798A", "ds": "example.com. 3600 IN DS 2371 13 2 97C2244DC33CBC0B0E83A8B63209A7F160A5B7F779E23B1104744FB2821A798A", "key_tag": 2371, "public_key": "mdsswUyr3DPW132mOi8V9xESWE8jTo0dxCjjnopKl+GqJxpVXckHAeF+KkxLbxILfDLUT0rAK9iUzy1L53eKGQ==", "modified_on": "2018-09-20T06:08:39.739Z" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/dnssec \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "Map headers = new HashMap<>();\n", "headers.put(\"content-type\", \"application/json\");\n", "headers.put(\"accept\", \"application/json\");\n", "headers.put(\"x-auth-user-token\", \"Bearer xxxxxx\");\n", "HttpResponse response = Unirest.get(\"https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/dnssec\")\n", " .headers(headers).asString();" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const ZoneSettingsAPI = require('ibm-networking-services/cis/zones-settings/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "}\n", "\n", "const zoneSettingApi = new ZoneSettingsAPI(options);\n", "\n", "zoneSettingApi.getZoneDnssec({})\n", " .then(response => {\n", " const zoneDNSsec = response.result.result;\n", " console.log(zoneDNSsec);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import ZonesSettingsV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " zonesSettings = ZonesSettingsV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " zonesSettings.set_service_url(endpoint)\n", " resp = zonesSettings.get_zone_dnssec()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/zonessettingsv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &zonessettingsv1.ZonesSettingsV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := zonessettingsv1.NewZonesSettingsV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewGetZoneDnssecOptions()\n", "\tresult, response, err := service.GetZoneDnssec(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.Status, response.RawResult)\n", "}\n" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update zone DNSSEC", "operationId": "update_zone_dnssec", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.reliability.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.dnssec.update" } ] }, "description": "Update DNSSEC setting for given zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnssec_input" } } }, "description": "Update zone DNSSEC setting." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zones_dnssec_resp" }, "examples": { "response": { "value": { "result": { "status": "pending", "flags": 257, "algorithm": "13", "key_type": "ECDSAP256SHA256", "digest_type": "2", "digest_algorithm": "SHA256", "digest": "97C2244DC33CBC0B0E83A8B63209A7F160A5B7F779E23B1104744FB2821A798A", "ds": "example.com. 3600 IN DS 2371 13 2 97C2244DC33CBC0B0E83A8B63209A7F160A5B7F779E23B1104744FB2821A798A", "key_tag": 2371, "public_key": "mdsswUyr3DPW132mOi8V9xESWE8jTo0dxCjjnopKl+GqJxpVXckHAeF+KkxLbxILfDLUT0rAK9iUzy1L53eKGQ==", "modified_on": "2018-09-20T06:08:39.739Z" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/dnssec \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"status\": \"enabled\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "status = 'disabled'\n", "resp = zonesSettings.update_zone_dnssec(status=status)\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateZoneDnssecOptions()\n", "options.SetStatus(zonessettingsv1.UpdateZoneDnssecOptions_Status_Active)\n", "result, response, err := service.UpdateZoneDnssec(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateZoneDnssec({\n", " status: 'disabled' // valid values 'disabled' or 'active'\n", "})\n", " .then(response => {\n", " const updatedZoneDNSsec = response.result.result;\n", " console.log(updatedZoneDNSsec);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/cname_flattening": { "get": { "tags": [ "Zones Settings" ], "summary": "Get zone CNAME flattening", "operationId": "get_zone_cname_flattening", "description": "Get CNAME flattening setting for a given zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zones_cname_flattening_resp" }, "examples": { "response": { "value": { "result": { "id": "cname_flattening", "value": "flatten_at_root", "modified_on": null, "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/cname_flattening \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "resp = zonesSettings.get_zone_cname_flattening()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetZoneCnameFlatteningOptions()\n", "result, response, err := service.GetZoneCnameFlattening(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getZoneCnameFlattening({})\n", " .then(response => {\n", " const zoneCname = response.result.result;\n", " console.log(zoneCname);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update zone CNAME flattening", "operationId": "update_zone_cname_flattening", "description": "Update CNAME flattening setting for given zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cname_flattening_input" } } }, "description": "Update zone CNAME flattening setting." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zones_cname_flattening_resp" }, "examples": { "response": { "value": { "result": { "id": "cname_flattening", "value": "flatten_at_root", "modified_on": null, "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/cname_flattening \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"flatten_at_root\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "resp = zonesSettings.update_zone_cname_flattening(\n", " value=\"fatten_all\")\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateZoneCnameFlatteningOptions()\n", "options.SetValue(zonessettingsv1.UpdateZoneCnameFlatteningOptions_Value_FlattenAll)\n", "result, response, err := service.UpdateZoneCnameFlattening(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateZoneCnameFlattening({\n", " value: 'flatten_at_root', // valid entry 'flatten_all' or 'flatten_at_root'\n", "})\n", " .then(response => {\n", " const updatedZoneCname = response.result.result;\n", " console.log(updatedZoneCname);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/opportunistic_encryption": { "get": { "tags": [ "Zones Settings" ], "summary": "Get opportunistic encryption setting", "operationId": "get_opportunistic_encryption", "description": "Get opportunistic encryption setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/opportunistic_encryption_resp" }, "examples": { "response": { "value": { "result": { "id": "opportunistic_encryption", "value": "off", "modified_on": null, "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/opportunistic_encryption \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_opportunistic_encryption()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetOpportunisticEncryptionOptions()\n", "result, response, err := service.GetOpportunisticEncryption(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getOpportunisticEncryption({})\n", " .then(response => {\n", " const opportunisticEncryption = response.result.result;\n", " console.log(opportunisticEncryption);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update opportunistic encryption setting", "operationId": "update_opportunistic_encryption", "description": "Update opportunistic encryption setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/opportunistic_encryption_setting" } } }, "description": "Update opportunistic encryption setting." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/opportunistic_encryption_resp" }, "examples": { "response": { "value": { "result": { "id": "opportunistic_encryption", "value": "on", "modified_on": "2018-10-08T09:32:10.916Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/opportunistic_encryption \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.update_opportunistic_encryption(\n", " value=\"on\")\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateOpportunisticEncryptionOptions()\n", "options.SetValue(zonessettingsv1.UpdateOpportunisticEncryptionOptions_Value_Off)\n", "result, response, err := service.UpdateOpportunisticEncryption(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateOpportunisticEncryption({\n", " value: 'on' // valid values 'on' or 'off'\n", "})\n", " .then(response => {\n", " const updatedEncryption = response.result.result;\n", " console.log(updatedEncryption);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/opportunistic_onion": { "get": { "tags": [ "Zones Settings" ], "summary": "Get opportunistic onion setting", "operationId": "get_opportunistic_onion", "description": "Get opportunistic onion setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/opportunistic_onion_resp" }, "examples": { "response": { "value": { "result": { "id": "opportunistic_onion", "value": "off", "modified_on": null, "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/opportunistic_onion \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update opportunistic onion setting", "operationId": "update_opportunistic_onion", "description": "Update opportunistic onion setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/opportunistic_onion_setting" } } }, "description": "Update opportunistic encryption setting." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/opportunistic_onion_resp" }, "examples": { "response": { "value": { "result": { "id": "opportunistic_onion", "value": "on", "modified_on": "2018-10-08T09:32:10.916Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/opportunistic_onion \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/challenge_ttl": { "get": { "tags": [ "Zones Settings" ], "summary": "Get challenge TTL setting", "operationId": "get_challenge_ttl", "description": "Get challenge TTL setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/challenge_ttl_resp" }, "examples": { "response": { "value": { "result": { "id": "challenge_ttl", "value": 1800, "modified_on": null, "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/challenge_ttl \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = self.zonesSettings.get_challenge_ttl().get_result()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetChallengeTtlOptions()\n", "result, response, err := service.GetChallengeTTL(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getChallengeTtl({})\n", " .then(response => {\n", " const challengeTtlSetting = response.result.result;\n", " console.log(challengeTtlSetting);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update challenge TTL setting", "operationId": "update_challenge_ttl", "description": "Update challenge TTL setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/challenge_ttl_setting" } } }, "description": "Update challenge TTL setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/challenge_ttl_resp" }, "examples": { "response": { "value": { "result": { "id": "challenge_ttl", "value": 1800, "modified_on": "2018-10-08T09:40:03.277Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/challenge_ttl \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": 1800}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.update_challenge_ttl(\n", " value=1800)\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateChallengeTtlOptions()\n", "options.SetValue(14400)\n", "result, response, err := service.UpdateChallengeTTL(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateChallengeTtl({\n", " value: 7200 // min - 300, max - 31536000.\n", "})\n", " .then(response => {\n", " const updatedChallengeTtl = response.result.result;\n", " console.log(updatedChallengeTtl);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/automatic_https_rewrites": { "get": { "tags": [ "Zones Settings" ], "summary": "Get automatic https rewrites setting", "operationId": "get_automatic_https_rewrites", "description": "Get automatic https rewrites setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/automatic_https_rewrites_resp" }, "examples": { "response": { "value": { "result": { "id": "automatic_https_rewrites", "value": "off", "modified_on": null, "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/automatic_https_rewrites \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_automatic_https_rewrites()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetAutomaticHttpsRewritesOptions()\n", "result, response, err := service.GetAutomaticHttpsRewrites(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getAutomaticHttpsRewrites({})\n", " .then(response => {\n", " const httpsRewrites = response.result.result;\n", " console.log(httpsRewrites);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update automatic https rewrites setting", "operationId": "update_automatic_https_rewrites", "description": "Update automatic https rewrites setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/automatic_https_rewrites_setting" } } }, "description": "Update automatic https rewrites setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/automatic_https_rewrites_resp" }, "examples": { "response": { "value": { "result": { "id": "automatic_https_rewrites", "value": "on", "modified_on": "2018-10-08T09:37:29.953Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/automatic_https_rewrites \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.update_automatic_https_rewrites(\n", " value=\"on\")\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateAutomaticHttpsRewritesOptions()\n", "options.SetValue(zonessettingsv1.UpdateAutomaticHttpsRewritesOptions_Value_On)\n", "result, response, err := service.UpdateAutomaticHttpsRewrites(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateAutomaticHttpsRewrites({\n", " value: 'on' // valid values 'on' or 'off'\n", "})\n", " .then(response => {\n", " const updatedHttpsRewrites = response.result.result;\n", " console.log(updatedHttpsRewrites);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/true_client_ip_header": { "get": { "tags": [ "Zones Settings" ], "summary": "Get true client IP setting", "operationId": "get_true_client_ip", "description": "Get true client IP setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/true_client_ip_resp" }, "examples": { "response": { "value": { "result": { "id": "true_client_ip_header", "value": "off", "modified_on": "2018-12-08T13:51:57.862Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/true_client_ip_header \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_true_client_ip()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetTrueClientIpOptions()\n", "result, response, err := service.GetTrueClientIp(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getTrueClientIp({})\n", " .then(response => {\n", " const trueClientIp = response.result.result;\n", " console.log(trueClientIp);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update true client IP setting", "operationId": "update_true_client_ip", "description": "Update true client IP setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_property_on_off_setting" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/true_client_ip_resp" }, "examples": { "response": { "value": { "result": { "id": "true_client_ip_header", "value": "on", "modified_on": "2018-12-08T18:58:10.519Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/true_client_ip_header \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.update_true_client_ip(\n", " value=\"on\")\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateTrueClientIpOptions()\n", "options.SetValue(zonessettingsv1.UpdateTrueClientIpOptions_Value_Off)\n", "result, response, err := service.UpdateTrueClientIp(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateTrueClientIp({\n", " value: 'off' \n", "})\n", " .then(response => {\n", " const updatedTrueClientIp = response.result.result;\n", " console.log(updatedTrueClientIp);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/always_use_https": { "get": { "tags": [ "Zones Settings" ], "summary": "Get always use https setting", "operationId": "get_always_use_https", "description": "Get always use https setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/always_use_https_resp" }, "examples": { "response": { "value": { "result": { "id": "always_use_https", "value": "off", "modified_on": null, "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/always_use_https \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_always_use_https()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetAlwaysUseHttpsOptions()\n", "result, response, err := service.GetAlwaysUseHttps(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getAlwaysUseHttps({})\n", " .then(response => {\n", " const alwaysUseHttps = response.result.result;\n", " console.log(alwaysUseHttps);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update always use https setting", "operationId": "update_always_use_https", "description": "Update always use https setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_property_on_off_setting" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/always_use_https_resp" }, "examples": { "response": { "value": { "result": { "id": "always_use_https", "value": "on", "modified_on": "2018-12-08T18:57:07.794Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/always_use_https \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.update_always_use_https(\n", " value=\"on\")\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateAlwaysUseHttpsOptions()\n", "options.SetValue(zonessettingsv1.UpdateAlwaysUseHttpsOptions_Value_On)\n", "result, response, err := service.UpdateAlwaysUseHttps(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateAlwaysUseHttps({\n", " value: 'on'\n", "})\n", " .then(response => {\n", " const updatedAlwaysUseHttps = response.result.result;\n", " console.log(updatedAlwaysUseHttps);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/image_size_optimization": { "get": { "tags": [ "Zones Settings" ], "summary": "Get image size optimization setting", "operationId": "get_image_size_optimization", "description": "Get image size optimization setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/image_size_optimization_resp" }, "examples": { "response": { "value": { "result": { "modified_on": "2018-12-08T13:53:17.136Z", "editable": true, "id": "image_size_optimization", "value": "off" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/image_size_optimization \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_image_size_optimization()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetImageSizeOptimizationOptions()\n", "result, response, err := service.GetImageSizeOptimization(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getImageSizeOptimization({})\n", " .then(response => {\n", " const imageSize = response.result.result;\n", " console.log(imageSize);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update image size optimization setting", "operationId": "update_image_size_optimization", "description": "Update image size optimization setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/image_size_optimization_setting" } } }, "description": "Update image size optimization setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/image_size_optimization_resp" }, "examples": { "response": { "value": { "result": { "modified_on": "2018-12-08T18:59:35.557Z", "editable": true, "id": "image_size_optimization", "value": "lossless" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/image_size_optimization \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"lossless\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.update_image_size_optimization(\n", " value=\"lossless\")\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateImageSizeOptimizationOptions()\n", "options.SetValue(zonessettingsv1.UpdateImageLoadOptimizationOptions_Value_On)\n", "result, response, err := service.UpdateImageSizeOptimization(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateImageSizeOptimization({\n", " value: 'on'\n", "})\n", " .then(response => {\n", " const updatedImageSizeOptimization = response.result.result;\n", " console.log(updatedImageSizeOptimization);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/script_load_optimization": { "get": { "tags": [ "Zones Settings" ], "summary": "Get script load optimization setting", "operationId": "get_script_load_optimization", "description": "Get script load optimization setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/script_load_optimization_resp" }, "examples": { "response": { "value": { "result": { "modified_on": "2018-12-08T13:51:51.231Z", "editable": true, "id": "script_load_optimization", "value": "off" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/script_load_optimization \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_script_load_optimization()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetScriptLoadOptimizationOptions()\n", "result, response, err := service.GetScriptLoadOptimization(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getScriptLoadOptimization({})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update script load optimization setting", "operationId": "update_script_load_optimization", "description": "Update script load optimization setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_property_on_off_setting" } } }, "description": "Update script load optimization setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/script_load_optimization_resp" }, "examples": { "response": { "value": { "result": { "modified_on": "2018-12-08T18:58:03.362Z", "editable": true, "id": "script_load_optimization", "value": "on" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/script_load_optimization \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.update_script_load_optimization(\n", " value=\"on\")\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateScriptLoadOptimizationOptions()\n", "options.SetValue(zonessettingsv1.UpdateScriptLoadOptimizationOptions_Value_Off)\n", "result, response, err := service.UpdateScriptLoadOptimization(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateScriptLoadOptimization({\n", " value: 'on'\n", "})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/image_load_optimization": { "get": { "tags": [ "Zones Settings" ], "summary": "Get image load optimization setting", "operationId": "get_image_load_optimization", "deprecated": true, "description": "Get image load optimization setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/image_load_optimization_resp" }, "examples": { "response": { "value": { "result": { "id": "image_load_optimization", "value": "off", "modified_on": "2018-12-08T13:51:38.150Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/image_load_optimization \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_image_load_optimization()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetImageLoadOptimizationOptions()\n", "result, response, err := service.GetImageLoadOptimization(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getImageLoadOptimization({})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update image load optimization setting", "operationId": "update_image_load_optimization", "deprecated": true, "description": "Update image load optimization setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_property_on_off_setting" } } }, "description": "Update image load optimization setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/image_load_optimization_resp" }, "examples": { "response": { "value": { "result": { "id": "image_load_optimization", "value": "on", "modified_on": "2018-12-08T18:57:49.315Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/image_load_optimization \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.update_image_load_optimization(\n", " value=\"on\")\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateImageLoadOptimizationOptions()\n", "options.SetValue(zonessettingsv1.UpdateImageLoadOptimizationOptions_Value_Off)\n", "result, response, err := service.UpdateImageLoadOptimization(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateImageLoadOptimization({\n", " value: 'off'\n", "})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/minify": { "get": { "tags": [ "Zones Settings" ], "summary": "Get minify setting", "operationId": "get_minify", "description": "Get minify setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/minify_resp" }, "examples": { "response": { "value": { "result": { "id": "minify", "value": { "html": "off", "css": "off", "js": "off" }, "modified_on": "2018-12-08T13:53:20.633Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/minify \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_minify().get_result()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetMinifyOptions()\n", "result, response, err := service.GetMinify(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getMinify({})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update minify setting", "operationId": "update_minify", "description": "Update minify setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/minify_setting" } } }, "description": "Update minify setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/minify_resp" }, "examples": { "response": { "value": { "result": { "id": "minify", "value": { "html": "on", "css": "on", "js": "on" }, "modified_on": "2018-12-08T18:59:40.961Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/minify \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"html\": \"on\", \"css\": \"on\", \"js\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "minify = {\n", " 'css': self.value,\n", " 'html': self.value,\n", " 'js': self.value\n", " }\n", "response = zonesSettings.update_minify(value=minify)\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateMinifyOptions()\n", "minifyOpt, err := service.NewMinifySettingValue(zonessettingsv1.MinifySettingValue_Css_Off, zonessettingsv1.MinifySettingValue_HTML_Off, zonessettingsv1MinifySettingValue_Js_Off)\n", "if err != nil {\n", "\treturn\n", "}\n", "options.SetValue(minifyOpt)\n", "result, response, err := service.UpdateMinTlsVersion(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateMinify({\n", " value: {\n", " css: 'on',\n", " html: 'on',\n", " js: 'on',\n", " },\n", "})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/min_tls_version": { "get": { "tags": [ "Zones Settings" ], "summary": "Get minimum TLS version setting", "operationId": "get_min_tls_version", "description": "Get minimum TLS version setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/min_tls_version_resp" }, "examples": { "response": { "value": { "result": { "id": "min_tls_version", "value": "1.3", "modified_on": null, "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/min_tls_version \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_min_tls_version()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetMinTlsVersionOptions()\n", "result, response, err := service.GetMinTlsVersion(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getMinTlsVersion({})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update minimum TLS version setting", "operationId": "update_min_tls_version", "description": "Update minimum TLS version setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/min_tls_version_setting" } } }, "description": "Update minimum TLS version setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/min_tls_version_resp" }, "examples": { "response": { "value": { "result": { "id": "min_tls_version", "value": "1.0", "modified_on": null, "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/min_tls_version \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"1.0\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.update_min_tls_version(\n", " value=\"1.2\")\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateMinTlsVersionOptions()\n", "options.SetValue(\"1.2\")\n", "result, response, err := service.UpdateMinTlsVersion(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateMinTlsVersion({\n", " value: '1.1', // valid entries- ['1.0', '1.1', '1.2', '1.3'];\n", "})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/ip_geolocation": { "get": { "tags": [ "Zones Settings" ], "summary": "Get IP geolocation setting", "operationId": "get_ip_geolocation", "description": "Get IP geolocation setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_geolocation_resp" }, "examples": { "response": { "value": { "result": { "id": "ip_geolocation", "value": "off", "modified_on": "2018-12-08T13:51:13.916Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/ip_geolocation \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_ip_geolocation()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetIpGeolocationOptions()\n", "result, response, err := service.GetIpGeolocation(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getIpGeolocation({})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update IP geolocation setting", "operationId": "update_ip_geolocation", "description": "Update IP geolocation setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_property_on_off_setting" } } }, "description": "Update IP geolocation setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip_geolocation_resp" }, "examples": { "response": { "value": { "result": { "id": "ip_geolocation", "value": "on", "modified_on": "2018-12-08T18:57:25.025Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/ip_geolocation \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.update_ip_geolocation(\n", " value=\"on\")\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateIpGeolocationOptions()\n", "options.SetValue(zonessettingsv1.UpdateIpGeolocationOptions_Value_On)\n", "result, response, err := service.UpdateIpGeolocation(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateIpGeolocation({\n", " value: 'off',\n", "})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/server_side_exclude": { "get": { "tags": [ "Zones Settings" ], "summary": "Get server side exclude setting", "operationId": "get_server_side_exclude", "description": "Get server side exclude setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server_side_exclude_resp" }, "examples": { "response": { "value": { "result": { "id": "server_side_exclude", "value": "off", "modified_on": "2018-12-08T13:51:24.448Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/server_side_exclude \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_server_side_exclude()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetServerSideExcludeOptions()\n", "result, response, err := service.GetServerSideExclude(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getServerSideExclude({})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update server side exclude setting", "operationId": "update_server_side_exclude", "description": "Update server side exclude setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_property_on_off_setting" } } }, "description": "Update server side exclude setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server_side_exclude_resp" }, "examples": { "response": { "value": { "result": { "id": "server_side_exclude", "value": "on", "modified_on": "2018-12-08T18:57:34.969Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/server_side_exclude \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.update_server_side_exclude(\n", " value=\"on\")\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateServerSideExcludeOptions()\n", "options.SetValue(zonessettingsv1.UpdateServerSideExcludeOptions_Value_On)\n", "result, response, err := service.UpdateServerSideExclude(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateServerSideExclude({\n", " value: 'off',\n", "})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/security_header": { "get": { "tags": [ "Zones Settings" ], "summary": "Get HTTP strict transport security setting", "operationId": "get_security_header", "description": "Get HTTP strict transport security setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/security_header_resp" }, "examples": { "response": { "value": { "result": { "id": "security_header", "value": { "strict_transport_security": { "preload": false, "max_age": 0, "enabled": false, "include_subdomains": false, "nosniff": false } }, "modified_on": "2018-12-08T13:53:24.178Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/security_header \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_security_header()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetSecurityHeaderOptions()\n", "result, response, err := service.GetSecurityHeader(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getSecurityHeader({})\n", " .then(response => {\n", " const securityHeaderConfig = response.result.result;\n", " console.log(securityHeaderConfig);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update HTTP strict transport security setting", "operationId": "update_security_header", "description": "Update HTTP strict transport security setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/security_header_setting" } } }, "description": "Update HTTP strict transport security setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/security_header_resp" }, "examples": { "response": { "value": { "result": { "id": "security_header", "value": { "strict_transport_security": { "preload": true, "max_age": 100, "enabled": true, "include_subdomains": true, "nosniff": true } }, "modified_on": "2018-12-08T18:59:44.507Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/security_header \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": {\"strict_transport_security\": {\"preload\": true, \"max_age\": 100, \"enabled\": true, \"include_subdomains\": true, \"nosniff\": true}}}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "strict_transport_security = {\n", " \"strict_transport_security\": {\n", " \"enabled\": True,\n", " \"max_age\": 86400,\n", " \"include_subdomains\": True,\n", " \"nosniff\": True\n", " }}\n", "response = zonesSettings.update_security_header(\n", " value=strict_transport_security)\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateSecurityHeaderOptions()\n", "valueOpt, err := service.NewSecurityHeaderSettingValueStrictTransportSecurity(true, 3600, true, true)\n", "if err != nil {\n", "\treturn\n", "}\n", "securityOpt, err := service.NewSecurityHeaderSettingValue(valueOpt)\n", "if err != nil {\n", "\treturn\n", "}\n", "options.SetValue(securityOpt)\n", "result, response, err := service.UpdateSecurityHeader(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const strict_transport_security = {\n", " enabled: true,\n", " include_subdomains: false,\n", " max_age: 0,\n", " nosniff: false,\n", " preload: false,\n", "}\n", "zoneSettingApi.updateSecurityHeader({\n", " value: {\n", " strict_transport_security : strict_transport_security\n", " }\n", "})\n", " .then(response => {\n", " const updatedSecurityHeader = response.result.result;\n", " console.log(updatedSecurityHeader);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/mobile_redirect": { "get": { "tags": [ "Zones Settings" ], "summary": "Get mobile redirect setting", "operationId": "get_mobile_redirect", "description": "Get mobile redirect setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mobile_redirect_resp" }, "examples": { "response": { "value": { "result": { "id": "mobile_redirect", "value": { "status": "off", "strip_uri": false, "mobile_subdomain": null }, "modified_on": null, "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/mobile_redirect \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_mobile_redirect()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetMobileRedirectOptions()\n", "result, response, err := service.GetMobileRedirect(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getMobileRedirect({})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update mobile redirect setting", "operationId": "update_mobile_redirect", "description": "Update mobile redirect setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mobile_redirec_setting" } } }, "description": "Update mobile redirect setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mobile_redirect_resp" }, "examples": { "response": { "value": { "result": { "id": "mobile_redirect", "value": { "status": "off", "mobile_subdomain": "m", "strip_uri": false }, "modified_on": "2018-12-08T18:57:07.794Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/mobile_redirect \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": {\"status\":\"off\",\"mobile_subdomain\":\"m\",\"strip_uri\":false}}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "value = {\n", " \"status\": \"on\",\n", " \"mobile_subdomain\": domain,\n", " \"strip_uri\": False\n", " }\n", "response = zonesSettings.update_mobile_redirect(\n", " value=value)\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateMobileRedirectOptions()\n", "mobileOpt, err := service.NewMobileRedirecSettingValue(zonessettingsv1.MobileRedirecSettingValue_Status_Off, \"m\", false)\n", "if err != nil {\n", "\treturn\n", "}\n", "options.SetValue(mobileOpt)\n", "result, response, err := service.UpdateMobileRedirect(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateMobileRedirect({\n", " value: {\n", " status: 'on',\n", " mobile_subdomain: ${SUB_DOMAIN_NAME}, // mobile sub domain\n", " strip_uri: false,\n", " },\n", "})\n", " .then(response => {\n", " const updatedMobileRedirect = response.result.result;\n", " console.log(updatedMobileRedirect);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/prefetch_preload": { "get": { "tags": [ "Zones Settings" ], "summary": "Get prefetch URLs from header setting", "operationId": "get_prefetch_preload", "description": "Get prefetch URLs from header setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/prefetch_preload_resp" }, "examples": { "response": { "value": { "result": { "id": "prefetch_preload", "value": "off", "modified_on": "2018-12-08T13:51:44.767Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/prefetch_preload \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_prefetch_preload().get_result()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetPrefetchPreloadOptions()\n", "result, response, err := service.GetPrefetchPreload(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getPrefetchPreload({})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update prefetch URLs from header setting", "operationId": "update_prefetch_preload", "description": "Update prefetch URLs from header setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_property_on_off_setting" } } }, "description": "Update prefetch URLs from header setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/prefetch_preload_resp" }, "examples": { "response": { "value": { "result": { "id": "prefetch_preload", "value": "on", "modified_on": "2018-12-08T18:57:56.421Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/prefetch_preload \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.update_prefetch_preload(\n", " value=\"on\")\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdatePrefetchPreloadOptions()\n", "options.SetValue(zonessettingsv1.UpdatePrefetchPreloadOptions_Value_On)\n", "result, response, err := service.UpdatePrefetchPreload(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updatePrefetchPreload({\n", " value: 'off',\n", "})\n", " .then(response => {\n", " const updatedPrefetchPreload = response.result.result;\n", " console.log(updatedPrefetchPreload);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/http2": { "get": { "tags": [ "Zones Settings" ], "summary": "Get HTTP/2 setting", "operationId": "get_http2", "description": "Get HTTP/2 setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/http2_resp" }, "examples": { "response": { "value": { "result": { "id": "http2", "value": "off", "modified_on": "2018-12-08T13:51:10.216Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/http2 \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_http2()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetHttp2Options()\n", "result, response, err := service.GetHttp2(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getHttp2({})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update HTTP/2 setting", "operationId": "update_http2", "description": "Update HTTP/2 setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_property_on_off_setting" } } }, "description": "Update HTTP/2 setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/http2_resp" }, "examples": { "response": { "value": { "result": { "id": "http2", "value": "on", "modified_on": "2018-12-08T18:57:21.423Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/http2 \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.update_http2(\n", " value=\"on\")\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateHttp2Options()\n", "options.SetValue(zonessettingsv1.UpdateHttp2Options_Value_Off)\n", "result, response, err := service.UpdateHttp2(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateHttp2({\n", " value: 'on',\n", "})\n", " .then(response => {\n", " const updatedHttp2 = response.result.result;\n", " console.log(updatedHttp2);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/http3": { "get": { "tags": [ "Zones Settings" ], "summary": "Get HTTP/3 setting", "operationId": "get_http3", "description": "Get HTTP/3 setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/http3_resp" }, "examples": { "response": { "value": { "result": { "id": "http3", "value": "off", "modified_on": "2018-12-08T13:51:10.216Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/http3 \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetHttp3Options()\n", "result, response, err := service.GetHttp3(options)\n", "...\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetHttp3Options getHttp3OptionsModel = new GetHttp3Options()\n", "", " // Invoke operation\n", " Response response = service.getHttp3(getHttp3Options).execute();\n", "", " Http3Resp http3RespResult = response.getResult();\n", "", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = zonesSettings.get_http3()\n", "print(response)" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "", "zoneSettingApi.getHttp3({})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update HTTP/3 setting", "operationId": "update_http3", "description": "Update HTTP/3 setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_property_on_off_setting" } } }, "description": "Update HTTP/3 setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/http3_resp" }, "examples": { "response": { "value": { "result": { "id": "http3", "value": "on", "modified_on": "2018-12-08T18:57:21.423Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/http3 \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateHttp3Options()\n", "options.SetValue(zonessettingsv1.UpdateHttp3Options_Value_Off)\n", "result, response, err := service.UpdateHttp3(options)\n", "...\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " UpdateHttp3Options updateHttp3Options = new UpdateHttp3Options.Builder()\n", " .value(\"on\")\n", " .build();\n", "", " // Invoke operation\n", " Response response = service.updateHttp3(updateHttp3Options).execute();\n", "", " Http3Resp http3RespResult = response.getResult();\n", "", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }\n", "" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = zonesSettings.update_http3(\n", " value=value,\n", " headers={}\n", " )\n", "print(response)" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "", "zoneSettingApi.updateHttp3({\n", " value: 'on',\n", "})\n", " .then(response => {\n", " const updatedHttp3 = response.result.result;\n", " console.log(updatedHttp3);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/ipv6": { "get": { "tags": [ "Zones Settings" ], "summary": "Get IPv6 compatibility setting", "operationId": "get_ipv6", "description": "Get IPv6 compatibility setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ipv6_resp" }, "examples": { "response": { "value": { "result": { "id": "ipv6", "value": "off", "modified_on": "2018-12-08T13:51:17.639Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/ipv6 \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_ipv6()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetIpv6Options()\n", "result, response, err := service.GetIpv6(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getIpv6({})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update IPv6 compatibility setting", "operationId": "update_ipv6", "description": "Update IPv6 compatibility setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_property_on_off_setting" } } }, "description": "Update IPv6 compatibility setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ipv6_resp" }, "examples": { "response": { "value": { "result": { "id": "ipv6", "value": "on", "modified_on": "2018-12-08T18:57:28.494Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/ipv6 \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.update_ipv6(\n", " value=\"on\")\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateIpv6Options()\n", "options.SetValue(zonessettingsv1.UpdateIpv6Options_Value_On)\n", "result, response, err := service.UpdateIpv6(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateIpv6({\n", " value: 'on',\n", "})\n", " .then(response => {\n", " const updatedIpv6 = response.result.result;\n", " console.log(updatedIpv6);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/websockets": { "get": { "tags": [ "Zones Settings" ], "summary": "Get web sockets setting", "operationId": "get_web_sockets", "description": "Get web sockets setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/websockets_resp" }, "examples": { "response": { "value": { "result": { "id": "websockets", "value": "off", "modified_on": "2018-12-08T13:51:34.312Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/websockets \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_web_sockets()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetWebSocketsOptions()\n", "result, response, err := service.GetWebSockets(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getWebSockets({})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update web sockets setting", "operationId": "update_web_sockets", "description": "Update web sockets setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_property_on_off_setting" } } }, "description": "Update web sockets setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/websockets_resp" }, "examples": { "response": { "value": { "result": { "id": "websockets", "value": "on", "modified_on": "2018-12-08T18:57:45.781Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/websockets \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.update_web_sockets(\n", " value=\"on\")\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateWebSocketsOptions()\n", "options.SetValue(zonessettingsv1.UpdateWebSocketsOptions_Value_Off)\n", "result, response, err := service.UpdateWebSockets(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateWebSockets({\n", " value: 'off',\n", "})\n", " .then(response => {\n", " const updatedWebSockets = response.result.result;\n", " console.log(updatedWebSockets);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/pseudo_ipv4": { "get": { "tags": [ "Zones Settings" ], "summary": "Get pseudo IPv4 setting", "operationId": "get_pseudo_ipv4", "description": "Get pseudo IPv4 setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pseudo_ipv4_resp" }, "examples": { "response": { "value": { "result": { "id": "pseudo_ipv4", "value": "off", "modified_on": "2018-12-08T13:53:12.222Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/pseudo_ipv4 \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_pseudo_ipv4()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetPseudoIpv4Options()\n", "result, response, err := service.GetPseudoIpv4(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getPseudoIpv4({})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update pseudo IPv4 setting", "operationId": "update_pseudo_ipv4", "description": "Update pseudo IPv4 setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pseudo_ipv4_setting" } } }, "description": "Update pseudo IPv4 setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pseudo_ipv4_resp" }, "examples": { "response": { "value": { "result": { "id": "pseudo_ipv4", "value": "add_header", "modified_on": "2018-12-08T18:59:30.268Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/pseudo_ipv4 \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"add_header\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.update_pseudo_ipv4(\n", " value=\"add_header\")\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdatePseudoIpv4Options()\n", "options.SetValue(zonessettingsv1.UpdatePseudoIpv4Options_Value_AddHeader)\n", "result, response, err := service.UpdatePseudoIpv4(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "zoneSettingApi.updatePseudoIpv4({\n", " value: 'add_header', // valid entry ['off', 'add_header', 'overwrite_header']\n", "})\n", " .then(response => {\n", " const updatedPseudoIpv4 = response.result.result;\n", " console.log(updatedPseudoIpv4);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/response_buffering": { "get": { "tags": [ "Zones Settings" ], "summary": "Get response buffering setting", "operationId": "get_response_buffering", "description": "Get response buffering setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_buffering_resp" }, "examples": { "response": { "value": { "result": { "id": "response_buffering", "value": "off", "modified_on": "2018-12-08T13:51:47.993Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/response_buffering \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_response_buffering()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetResponseBufferingOptions()\n", "result, response, err := service.GetResponseBuffering(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getResponseBuffering({})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update response buffering setting", "operationId": "update_response_buffering", "description": "Update response buffering setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_property_on_off_setting" } } }, "description": "Update response buffering setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_buffering_resp" }, "examples": { "response": { "value": { "result": { "id": "response_buffering", "value": "on", "modified_on": "2018-12-08T18:57:59.799Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/response_buffering \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.update_response_buffering(\n", " value=\"on\")\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateResponseBufferingOptions()\n", "options.SetValue(zonessettingsv1.UpdateResponseBufferingOptions_Value_On)\n", "result, response, err := service.UpdateResponseBuffering(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateResponseBuffering({\n", " value: 'on',\n", "})\n", " .then(response => {\n", " const updatedResponse = response.result.result;\n", " console.log(updatedResponse);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/hotlink_protection": { "get": { "tags": [ "Zones Settings" ], "summary": "Get hotlink protection setting", "operationId": "get_hotlink_protection", "description": "Get hotlink protection setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hotlink_protection_resp" }, "examples": { "response": { "value": { "result": { "id": "hotlink_protection", "value": "off", "modified_on": "2018-12-08T13:51:06.923Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/hotlink_protection \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_hotlink_protection()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetHotlinkProtectionOptions()\n", "result, response, err := service.GetHotlinkProtection(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getHotlinkProtection({})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update hotlink protection setting", "operationId": "update_hotlink_protection", "description": "Update hotlink protection setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_property_on_off_setting" } } }, "description": "Update hotlink protection setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hotlink_protection_resp" }, "examples": { "response": { "value": { "result": { "id": "hotlink_protection", "value": "on", "modified_on": "2018-12-08T18:57:17.898Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/hotlink_protection \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "response = zonesSettings.update_hotlink_protection(\n", " value=\"on\")\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateHotlinkProtectionOptions()\n", "options.SetValue(zonessettingsv1.UpdateHotlinkProtectionOptions_Value_Off)\n", "result, response, err := service.UpdateHotlinkProtection(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateHotlinkProtection({\n", " value: 'on',\n", "})\n", " .then(response => {\n", " const updatedHotlinkProtection = response.result.result;\n", " console.log(updatedHotlinkProtection);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/max_upload": { "get": { "tags": [ "Zones Settings" ], "summary": "Get maximum upload size setting", "operationId": "get_max_upload", "description": "Get maximum upload size setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/max_upload_resp" }, "examples": { "response": { "value": { "result": { "id": "max_upload", "value": 200, "modified_on": "2018-12-08T13:52:56.515Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/max_upload \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_max_upload()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetMaxUploadOptions()\n", "result, response, err := service.GetMaxUpload(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getMaxUpload({})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update maximum upload size setting", "operationId": "update_max_upload", "description": "Update maximum upload size setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/max_upload_setting" } } }, "description": "Update maximum upload size setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/max_upload_resp" }, "examples": { "response": { "value": { "result": { "id": "max_upload", "value": 100, "modified_on": "2018-12-08T18:58:39.110Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/max_upload \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": 100}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.update_max_upload(\n", " value=450)\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateMaxUploadOptions()\n", "options.SetValue(150)\n", "result, response, err := service.UpdateMaxUpload(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateMaxUpload({\n", " value: 125, // min 100, max 275\n", "})\n", " .then(response => {\n", " const updatedMaxUpload = response.result.result;\n", " console.log(updatedMaxUpload);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/tls_client_auth": { "get": { "tags": [ "Zones Settings" ], "summary": "Get TLS Client Auth setting", "operationId": "get_tls_client_auth", "description": "Get TLS Client Auth setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tls_client_auth_resp" }, "examples": { "response": { "value": { "result": { "id": "tls_client_auth", "value": "off", "modified_on": "2018-12-08T13:51:54.514Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/tls_client_auth \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_tls_client_auth()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetTlsClientAuthOptions()\n", "result, response, err := service.GetTlsClientAuth(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getTlsClientAuth({})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update TLS Client Auth setting", "operationId": "update_tls_client_auth", "description": "Update TLS Client Auth setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_property_on_off_setting" } } }, "description": "Update TLS Client Auth setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tls_client_auth_resp" }, "examples": { "response": { "value": { "result": { "id": "tls_client_auth", "value": "on", "modified_on": "2018-12-08T18:58:06.627Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/tls_client_auth \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.update_tls_client_auth(\n", " value=\"on\")\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateTlsClientAuthOptions()\n", "options.SetValue(zonessettingsv1.UpdateTlsClientAuthOptions_Value_On)\n", "result, response, err := service.UpdateTlsClientAuth(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateTlsClientAuth({\n", " value: 'on',\n", "})\n", " .then(response => {\n", " const updatedTlsClient = response.result.result;\n", " console.log(updatedTlsClient);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/brotli": { "get": { "tags": [ "Zones Settings" ], "summary": "Get brotli setting", "operationId": "get_brotli", "description": "Get brotli setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/brotli_resp" }, "examples": { "response": { "value": { "result": { "id": "brotli", "value": "off", "modified_on": "2018-12-08T13:51:03.697Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update brotli setting", "operationId": "update_brotli", "description": "Update brotli setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_property_on_off_setting" } } }, "description": "Update brotli setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/brotli_resp" }, "examples": { "response": { "value": { "result": { "id": "brotli", "value": "on", "modified_on": "2018-12-08T18:57:14.506Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/proxy_read_timeout": { "get": { "tags": [ "Zones Settings" ], "summary": "Get proxy read timeout setting", "operationId": "get_proxy_read_timeout", "description": "Get proxy read timeout setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxy_read_timeout_resp" }, "examples": { "response": { "value": { "result": { "id": "proxy_read_timeout", "value": "100", "modified_on": "2018-12-08T13:51:03.697Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update proxy read timeout setting", "operationId": "update_proxy_read_timeout", "description": "Update proxy read timeout setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxy_read_timeout_setting" } } }, "description": "Update proxy read timeout setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxy_read_timeout_resp" }, "examples": { "response": { "value": { "result": { "id": "proxy_read_timeout", "value": "600", "modified_on": "2018-12-08T18:57:14.506Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/browser_check": { "get": { "tags": [ "Zones Settings" ], "summary": "Get browser check setting", "operationId": "get_browser_check", "description": "Get browser check setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/browser_check_resp" }, "examples": { "response": { "value": { "result": { "id": "browser_check", "value": "off", "modified_on": "2018-12-08T13:51:03.697Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/browser_check \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_browser_check()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetBrowserCheckOptions()\n", "result, response, err := service.GetBrowserCheck(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getBrowserCheck({})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update browser check setting", "operationId": "update_browser_check", "description": "Update browser check setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_property_on_off_setting" } } }, "description": "Update browser check setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/browser_check_resp" }, "examples": { "response": { "value": { "result": { "id": "browser_check", "value": "on", "modified_on": "2018-12-08T18:57:14.506Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/browser_check \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.update_browser_check(\n", " value=\"on\")\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateBrowserCheckOptions()\n", "options.SetValue(zonessettingsv1.UpdateBrowserCheckOptions_Value_On)\n", "result, response, err := service.UpdateBrowserCheck(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateBrowserCheck({\n", " value: 'on',\n", "})\n", " .then(response => {\n", " const updatedBrowserCheck = response.result.result;\n", " console.log(updatedBrowserCheck);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/origin_error_page_pass_thru": { "get": { "tags": [ "Zones Settings" ], "summary": "Get enable error pages on setting", "operationId": "get_enable_error_pages_on", "description": "Get enable error pages on setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/origin_error_page_pass_thru_resp" }, "examples": { "response": { "value": { "result": { "id": "origin_error_page_pass_thru", "value": "off", "modified_on": "2018-12-08T13:51:41.567Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/origin_error_page_pass_thru \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_enable_error_pages_on()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetEnableErrorPagesOnOptions()\n", "result, response, err := service.GetEnableErrorPagesOn(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getEnableErrorPagesOn({})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update enable error pages on setting", "operationId": "update_enable_error_pages_on", "description": "Update enable error pages on setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_property_on_off_setting" } } }, "description": "Update Enable error pages on setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/origin_error_page_pass_thru_resp" }, "examples": { "response": { "value": { "result": { "id": "origin_error_page_pass_thru", "value": "on", "modified_on": "2018-12-08T18:57:52.826Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/origin_error_page_pass_thru \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.update_enable_error_pages_on(\n", " value=\"on\")\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateEnableErrorPagesOnOptions()\n", "options.SetValue(zonessettingsv1.UpdateEnableErrorPagesOnOptions_Value_On)\n", "result, response, err := service.UpdateEnableErrorPagesOn(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateEnableErrorPagesOn({\n", " value: 'on',\n", "})\n", " .then(response => {\n", " const updatedSetting= response.result.result;\n", " console.log(updatedSetting);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/waf": { "get": { "tags": [ "Zones Settings" ], "summary": "Get web application firewall setting", "operationId": "get_web_application_firewall", "description": "Get web application firewall setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/waf_resp" }, "examples": { "response": { "value": { "result": { "id": "waf", "value": "off", "modified_on": "2018-12-08T18:41:10.036Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/waf \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_web_application_firewall()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetWebApplicationFirewallOptions()\n", "result, response, err := service.GetWebApplicationFirewall(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getWebApplicationFirewall({})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update web application firewall setting", "operationId": "update_web_application_firewall", "description": "A Web Application Firewall (WAF) blocks requests that contain malicious content.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_property_on_off_setting" } } }, "description": "Update web application firewall setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/waf_resp" }, "examples": { "response": { "value": { "result": { "id": "waf", "value": "on", "modified_on": "2018-12-08T18:41:10.036Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/waf \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.update_web_application_firewall(\n", " value=\"on\")\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateWebApplicationFirewallOptions()\n", "options.SetValue(zonessettingsv1.UpdateWebApplicationFirewallOptions_Value_Off)\n", "result, response, err := service.UpdateWebApplicationFirewall(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateWebApplicationFirewall({\n", " value: 'off',\n", "})\n", " .then(response => {\n", " const updatedSetting= response.result.result;\n", " console.log(updatedSetting);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/ciphers": { "get": { "tags": [ "Zones Settings" ], "summary": "Get ciphers setting", "operationId": "get_ciphers", "description": "Get ciphers setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ciphers_resp" }, "examples": { "response": { "value": { "result": { "id": "ciphers", "value": [ "AES256-GCM-SHA384", "AES256-SHA256" ], "modified_on": "2018-12-08T18:41:10.036Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/ciphers \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.get_ciphers()\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewGetCiphersOptions()\n", "result, response, err := service.GetCiphers(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.getCiphers({})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update ciphers setting", "operationId": "update_ciphers", "description": "Update ciphers setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ciphers_setting" } } }, "description": "Update ciphers setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ciphers_resp" }, "examples": { "response": { "value": { "result": { "id": "waf", "value": "on", "modified_on": "2018-12-08T18:41:10.036Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/ciphers \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": [\"AES256-GCM-SHA384\", \"AES256-SHA256\"]}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "response = zonesSettings.update_ciphers(\n", " value=[\"AES256-GCM-SHA384\", \"AES256-SHA256\"])\n", "...\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "options := service.NewUpdateCiphersOptions()\n", "options.SetValue([]string{zonessettingsv1.UpdateCiphersOptions_Value_Aes128GcmSha256})\n", "result, response, err := service.UpdateCiphers(options)\n", "...\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "zoneSettingApi.updateCiphers({\n", " value: ['ECDHE-RSA-AES128-GCM-SHA256', 'AES128-SHA'],\n", "})\n", " .then(response => {\n", " const updatedCiphers= response.result.result;\n", " console.log(updatedCiphers);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/origin_max_http_version": { "get": { "tags": [ "Zones Settings" ], "summary": "Get origin max http version setting", "operationId": "get_origin_max_http_version", "description": "Get origin max http version setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/origin_max_http_version_resp" }, "examples": { "response": { "value": { "result": { "id": "origin_max_http_version", "value": "2", "modified_on": "2024-02-08T18:41:10.036Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/origin_max_http_version \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update origin max http version setting", "operationId": "update_origin_max_http_version", "description": "Update origin max http version setting for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/origin_max_http_version" } } }, "description": "Update ciphers setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/origin_max_http_version_resp" }, "examples": { "response": { "value": { "result": { "id": "origin_max_http_version", "value": "1", "modified_on": "2023-12-08T18:41:10.036Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/origin_max_http_version \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"1\"}'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/cache/origin_post_quantum_encryption": { "get": { "tags": [ "Zones Settings" ], "summary": "Get origin post quantum encryption setting", "operationId": "get_origin_post_quantum_encryption", "description": "Get origin post quantum encryption setting for a zone.", "parameters": [ { "in": "path", "name": "crn", "x-sdk-global-param": true, "description": "Full URL-encoded cloud resource name (CRN) of resource instance", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "zone_identifier", "x-sdk-global-param": true, "description": "Zone identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/origin_post_quantum_encryption_resp" }, "examples": { "response": { "value": { "result": { "id": "origin_pqe", "value": "off", "modified_on": "2024-02-08T18:41:10.036Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/cache/origin_post_quantum_encryption \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "put": { "tags": [ "Zones Settings" ], "summary": "Update origin post quantum encryption setting", "operationId": "update_origin_post_quantum_encryption", "description": "Update origin post quantum encryption setting for a zone.", "parameters": [ { "in": "path", "name": "crn", "x-sdk-global-param": true, "description": "Full URL-encoded cloud resource name (CRN) of resource instance", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "zone_identifier", "x-sdk-global-param": true, "description": "Zone identifier", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/origin_post_quantum_encryption" } } }, "description": "Update ciphers setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/origin_post_quantum_encryption_resp" }, "examples": { "response": { "value": { "result": { "id": "origin_pqe", "value": "off", "modified_on": "2023-12-08T18:41:10.036Z", "editable": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/cache/origin_post_quantum_encryption \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"preferred\"}'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/replace_insecure_js": { "get": { "tags": [ "Zones Settings" ], "summary": "Get replace insecure Javascript setting", "operationId": "get_replace_insecure_js", "description": "Get replace insecure Javascript for a zone.", "parameters": [ { "in": "path", "name": "crn", "x-sdk-global-param": true, "description": "Full URL-encoded cloud resource name (CRN) of resource instance", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "zone_identifier", "x-sdk-global-param": true, "description": "Zone identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/replace_insecure_js_resp" }, "examples": { "response": { "value": { "result": { "id": "replace_insecure_js", "value": "off", "editable": true }, "success": true, "errors": [], "messages": [], "result_info": {} } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/replace_insecure_js \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update replace insecure Javascript setting", "operationId": "update_replace_insecure_js", "description": "Update replace insecure Javascript setting for a zone.", "parameters": [ { "in": "path", "name": "crn", "x-sdk-global-param": true, "description": "Full URL-encoded cloud resource name (CRN) of resource instance", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "zone_identifier", "x-sdk-global-param": true, "description": "Zone identifier", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/replace_insecure_js" } } }, "description": "Update ciphers setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/replace_insecure_js_resp" }, "examples": { "response": { "value": { "result": { "id": "replace_insecure_js", "value": "off", "modified_on": "2023-12-08T18:41:10.036Z", "editable": true }, "success": true, "errors": [], "messages": [], "result_info": {} } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/replace_insecure_js \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/email_obfuscation": { "get": { "tags": [ "Zones Settings" ], "summary": "Get email address obfuscation setting", "operationId": "get_email_obfuscation", "description": "Get email address obfuscation for a zone.", "parameters": [ { "in": "path", "name": "crn", "x-sdk-global-param": true, "description": "Full URL-encoded cloud resource name (CRN) of resource instance", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "zone_identifier", "x-sdk-global-param": true, "description": "Zone identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/email_obfuscation_resp" }, "examples": { "response": { "value": { "result": { "id": "email_obfuscation", "value": "on", "editable": true }, "success": true, "errors": [], "messages": [], "result_info": {} } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/email_obfuscation \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Update email address obfuscation setting", "operationId": "update_email_obfuscation", "description": "Update email address obfuscation setting for a zone.", "parameters": [ { "in": "path", "name": "crn", "x-sdk-global-param": true, "description": "Full URL-encoded cloud resource name (CRN) of resource instance", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "zone_identifier", "x-sdk-global-param": true, "description": "Zone identifier", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/email_obfuscation" } } }, "description": "Update email address obfuscation setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/email_obfuscation_resp" }, "examples": { "response": { "value": { "result": { "id": "email_obfuscation", "value": "off", "modified_on": "2023-12-08T18:41:10.036Z", "editable": true }, "success": true, "errors": [], "messages": [], "result_info": {} } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/email_obfuscation \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ] } } } }, "/v1/ips": { "get": { "tags": [ "IP Allowlist" ], "summary": "List all IP addresses used by the CIS proxy", "operationId": "list_ips", "description": "List of all IP addresses used by the CIS proxy.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ip-response" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "ipv4_cidrs": [ "173.245.48.0/20", "103.21.244.0/22", "103.22.200.0/22", "103.31.4.0/22", "141.101.64.0/18", "108.162.192.0/18", "190.93.240.0/20", "188.114.96.0/20", "197.234.240.0/22", "198.41.128.0/17", "162.158.0.0/15", "104.16.0.0/12", "172.64.0.0/13", "131.0.72.0/22" ], "ipv6_cidrs": [ "2400:cb00::/32", "2606:4700::/32", "2803:f800::/32", "2405:b500::/32", "2405:8100::/32", "2a06:98c0::/29", "2c0f:f248::/32" ] } } } } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal Server Error" }, "504": { "description": "Gateway Timeout! Backend endpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com//v1/ips \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import CisIpApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read end-point from environment\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cisIpApi = CisIpApiV1.new_instance(service_name=\"cis_services\")\n", " cisIpApi.set_service_url(endpoint)\n", " resp = cisIpApi.list_ips().get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/cisipapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tglobalOptions := &cisipapiv1.CisIpApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t}\n", "\tservice, serviceErr := cisipapiv1.NewCisIpApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewListIpsOptions()\n", "\tresult, response, err := service.ListIps(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ListIpsOptions listIpsOptions = new ListIpsOptions();\n", "\n", " // Invoke operation\n", " Response response = service.listIps(listIpsOptions).execute();\n", " IpResponse ipResponseResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/load_balancers": { "get": { "tags": [ "Global Load Balancer" ], "summary": "List all load balancers", "operationId": "list_all_load_balancers", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.reliability.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.load-balancers.read" } ] }, "description": "List configured load balancers.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_load_balancers_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": [ { "id": "451e8d47e817a8c2f2038638bac23541", "created_on": "2020-12-16T07:54:04.996Z", "modified_on": "2020-12-16T07:54:04.996Z", "description": "Test GLB", "name": "glbtest.com", "ttl": 30, "fallback_pool": "6bccf67198c3f061d82dda09f3d2e4e8", "default_pools": [ "7df7b9b072f72a4eb11d0fa1d4bb2d29" ], "region_pools": { "WNAM": [ "de90f38ced07c2e2f4df50b1f61d4194", "9290f38c5d07c2e2f4df57b1f61d4196" ], "ENAM": [ "00920f38ce07c2e2f4df50b1f61d4194" ] }, "pop_pools": { "LAX": [ "de90f38ced07c2e2f4df50b1f61d4194", "9290f38c5d07c2e2f4df57b1f61d4196" ], "LHR": [ "abd90f38ced07c2e2f4df50b1f61d4194", "f9138c5d07c2e2f4df57b1f61d4196" ], "SJC": [ "00920f38ce07c2e2f4df50b1f61d4194" ] }, "proxied": true, "enabled": true, "session_affinity": "ip_cookie", "session_affinity_attributes": { "samesite": "Auto", "secure": "Auto", "drain_duration": 0 }, "session_affinity_ttl": 5000, "steering_policy": "dynamic_latency" } ] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/load_balancers \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import GlobalLoadBalancerV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_identifier = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " globalLoadBalancer = GlobalLoadBalancerV1.new_instance(\n", " crn=crn, zone_identifier=zone_identifier, service_name=\"cis_services\")\n", " globalLoadBalancer.set_service_url(endpoint)\n", " resp = globalLoadBalancer.list_all_load_balancers().get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/globalloadbalancerv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &globalloadbalancerv1.GlobalLoadBalancerV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := globalloadbalancerv1.NewGlobalLoadBalancerV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\tglbOpt := service.NewListAllLoadBalancersOptions()\n", "\tresult, response, err := service.ListAllLoadBalancers(glbOpt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ListAllLoadBalancersOptions listAllLoadBalancersOptions = new ListAllLoadBalancersOptions();\n", "\n", " // Invoke operation\n", " Response response = service.listAllLoadBalancers(listAllLoadBalancersOptions).execute();\n", " ListLoadBalancersResp listLoadBalancersRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const GlobalLoadBalancerAPI = require('ibm-networking-services/cis/global-load-balancer/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "}\n", "\n", "const glbApi = new GlobalLoadBalancerAPI(options);\n", "\n", "glbApi.listAllLoadBalancers({})\n", " .then(response => {\n", " const glbList = response.result.result;\n", " console.log(glbList);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "post": { "tags": [ "Global Load Balancer" ], "summary": "Create load balancer", "operationId": "create_load_balancer", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.reliability.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.load-balancers.create" } ] }, "description": "Create a load balancer for a given zone. The zone should be active before placing an order of a load balancer.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/load_balancers_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "451e8d47e817a8c2f2038638bac23541", "created_on": "2020-12-16T07:54:04.996Z", "modified_on": "2020-12-16T07:54:04.996Z", "description": "Test GLB", "name": "glbtest.com", "ttl": 30, "fallback_pool": "6bccf67198c3f061d82dda09f3d2e4e8", "default_pools": [ "7df7b9b072f72a4eb11d0fa1d4bb2d29" ], "region_pools": { "WNAM": [ "de90f38ced07c2e2f4df50b1f61d4194", "9290f38c5d07c2e2f4df57b1f61d4196" ], "ENAM": [ "00920f38ce07c2e2f4df50b1f61d4194" ] }, "pop_pools": { "LAX": [ "de90f38ced07c2e2f4df50b1f61d4194", "9290f38c5d07c2e2f4df57b1f61d4196" ], "LHR": [ "abd90f38ced07c2e2f4df50b1f61d4194", "f9138c5d07c2e2f4df57b1f61d4196" ], "SJC": [ "00920f38ce07c2e2f4df50b1f61d4194" ] }, "proxied": true, "enabled": true, "session_affinity": "ip_cookie", "session_affinity_attributes": { "samesite": "Auto", "secure": "Auto", "drain_duration": 0 }, "session_affinity_ttl": 5000, "steering_policy": "dynamic_latency" } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/load_balancer_req" } } }, "description": "Order a load balancer." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/load_balancers \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\n", " \"description\": \"\",\n", " \"proxied\": true,\n", " \"enabled\": true,\n", " \"name\": \"www.example.com\",\n", " \"session_affinity\": \"none\",\n", " \"session_affinity_ttl\": 5000,\n", " \"steering_policy\": \"geo\",\n", " \"fallback_pool\": \"4112ba6c2974ec43886f90736968e838\",\n", " \"default_pools\": [\n", " \"6563ebae141638f92ebbdc4a821bef8c\",\n", " \"4112ba6c2974ec43886f90736968e838\"\n", " ],\n", " \"pop_pools\": {},\n", " \"region_pools\": {\n", " \"EEU\": [\n", " \"4112ba6c2974ec43886f90736968e838\"\n", " ],\n", " \"ENAM\": [\n", " \"6563ebae141638f92ebbdc4a821bef8c\"\n", " ],\n", " \"WEU\": [\n", " \"4112ba6c2974ec43886f90736968e838\"\n", " ],\n", " \"WNAM\": [\n", " \"6563ebae141638f92ebbdc4a821bef8c\"\n", " ]\n", " }\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import GlobalLoadBalancerV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_identifier = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " globalLoadBalancer = GlobalLoadBalancerV1.new_instance(\n", " crn=crn, zone_identifier=zone_identifier, service_name=\"cis_services\")\n", " globalLoadBalancer.set_service_url(endpoint)\n", " name = \"test_lb1.alpha1.sdk.cistest-load.com\"\n", " default_pools = [\"6563ebae141638f92ebbdc4a821bef8c\",\n", " \"4112ba6c2974ec43886f90736968e838\"]\n", " fallback_pool = \"4112ba6c2974ec43886f90736968e838\"\n", " description = \"Test load balancer 1\"\n", " ttl = 60\n", " region_pools = {\n", " \"EEU\": [\n", " \"4112ba6c2974ec43886f90736968e838\"\n", " ],\n", " \"ENAM\": [\n", " \"6563ebae141638f92ebbdc4a821bef8c\"\n", " ],\n", " \"WEU\": [\n", " \"4112ba6c2974ec43886f90736968e838\"\n", " ],\n", " \"WNAM\": [\n", " \"6563ebae141638f92ebbdc4a821bef8c\"\n", " ]\n", " }\n", " pop_pools = None\n", " proxied = False\n", " enabled = False\n", " session_affinity = \"cookie\"\n", " session_affinity_ttl = 5000\n", " steering_policy = \"dynamic_latency\"\n", " resp = globalLoadBalancer.create_load_balancer(\n", " name=name,\n", " fallback_pool=fallback_pool, default_pools=default_pools,\n", " description=description, ttl=ttl, region_pools=region_pools,\n", " pop_pools=pop_pools, proxied=proxied, enabled=enabled,\n", " session_affinity=session_affinity, session_affinity_ttl=session_affinity_ttl,\n", " steering_policy=steering_policy).get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/globalloadbalancerv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &globalloadbalancerv1.GlobalLoadBalancerV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := globalloadbalancerv1.NewGlobalLoadBalancerV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\t// create glb\n", "\tglbOpt := service.NewCreateLoadBalancerOptions()\n", "\tglbOpt.SetName(\"test1.\" + os.Getenv(\"URL\"))\n", "\tglbOpt.SetDefaultPools([]string{\"c775e22a-5db5-461\"})\n", "\tglbOpt.SetFallbackPool(\"c775e22a-5db5-46198765465\")\n", "\tglbOpt.SetDescription(\"test glb\")\n", "\tglbOpt.SetEnabled(false)\n", "\tglbOpt.SetSessionAffinity(globalloadbalancerv1.CreateLoadBalancerOptions_SessionAffinity_Cookie)\n", "\tglbOpt.SetSessionAffinityTTL(5000)\n", "\tglbOpt.SetSteeringPolicy(globalloadbalancerv1.CreateLoadBalancerOptions_SteeringPolicy_DynamicLatency)\n", "\tresult, response, err := service.CreateLoadBalancer(glbOpt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " CreateLoadBalancerOptions createLoadBalancerOptions = new CreateLoadBalancerOptions.Builder()\n", " .name(\"example.java.sdk.cistest-load.com\")\n", " .fallbackPool(pIdentifier)\n", " .defaultPools(new java.util.ArrayList(java.util.Arrays.asList(pIdentifier)))\n", " .description(\"Load Balancer for cistest-load.com\")\n", " .ttl(Long.valueOf(\"1\"))\n", " .proxied(false)\n", " .enabled(false)\n", " .sessionAffinity(\"ip_cookie\")\n", " .sessionAffinityTtl(Long.valueOf(\"5000\"))\n", " .steeringPolicy(\"dynamic_latency\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.createLoadBalancer(createLoadBalancerOptions).execute();\n", " LoadBalancersResp loadBalancersRespResult = response.getResult();\n", "\n", " identifier = loadBalancersRespResult.getResult().getId();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "// Construct the params object for operation createLoadBalancer\n", "\n", "const loadBalancerConfig = {\n", " name: ${DOMAIN_NAME},\n", " description: 'Load Balancer for ${DOMAIN_NAME}',\n", " ttl: 30,\n", " proxied: true,\n", " enabled: true,\n", " sessionAffinity: 'ip_cookie',\n", " sessionAffinityTtl: 5000,\n", " steeringPolicy: 'dynamic_latency',\n", " defaultPools: ${poolIds},\n", " fallbackPool: ${poolId},\n", "};\n", "\n", "glbApi.createLoadBalancer(loadBalancerConfig)\n", " .then(response => {\n", " const newLoadBalancer = response.result.result;\n", " console.log(newLoadBalancer);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/load_balancers/{load_balancer_identifier}": { "put": { "tags": [ "Global Load Balancer" ], "summary": "Edit load balancer", "operationId": "edit_load_balancer", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.reliability.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.load-balancers.update" } ] }, "description": "Edit porperties of an existing load balancer.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "load_balancer_identifier", "description": "Load balancer identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/load_balancers_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": [ { "id": "451e8d47e817a8c2f2038638bac23541", "created_on": "2020-12-16T07:54:04.996Z", "modified_on": "2020-12-16T07:54:04.996Z", "description": "Test GLB", "name": "glbtest.com", "ttl": 30, "fallback_pool": "6bccf67198c3f061d82dda09f3d2e4e8", "default_pools": [ "7df7b9b072f72a4eb11d0fa1d4bb2d29" ], "region_pools": { "WNAM": [ "de90f38ced07c2e2f4df50b1f61d4194", "9290f38c5d07c2e2f4df57b1f61d4196" ], "ENAM": [ "00920f38ce07c2e2f4df50b1f61d4194" ] }, "pop_pools": { "LAX": [ "de90f38ced07c2e2f4df50b1f61d4194", "9290f38c5d07c2e2f4df57b1f61d4196" ], "LHR": [ "abd90f38ced07c2e2f4df50b1f61d4194", "f9138c5d07c2e2f4df57b1f61d4196" ], "SJC": [ "00920f38ce07c2e2f4df50b1f61d4194" ] }, "proxied": true, "enabled": true, "session_affinity": "ip_cookie", "session_affinity_attributes": { "samesite": "Auto", "secure": "Auto", "drain_duration": 0 }, "session_affinity_ttl": 5000, "steering_policy": "dynamic_latency" } ] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/load_balancer_req" } } }, "description": "Edit properties" }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/load_balancers/:lb_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\n", " \"description\": \"load balancer for www.example.com\",\n", " \"proxied\": false,\n", " \"enabled\": true,\n", " \"ttl\": 10,\n", " \"name\": \"www.example.com\",\n", " \"session_affinity\": \"none\",\n", " \"session_affinity_ttl\": 5000,\n", " \"steering_policy\": \"geo\",\n", " \"fallback_pool\": \"4112ba6c2974ec43886f90736968e838\",\n", " \"default_pools\": [\n", " \"6563ebae141638f92ebbdc4a821bef8c\",\n", " \"4112ba6c2974ec43886f90736968e838\"\n", " ],\n", " \"pop_pools\": {},\n", " \"region_pools\": {\n", " \"EEU\": [\n", " \"4112ba6c2974ec43886f90736968e838\"\n", " ],\n", " \"ENAM\": [\n", " \"6563ebae141638f92ebbdc4a821bef8c\"\n", " ],\n", " \"WEU\": [\n", " \"4112ba6c2974ec43886f90736968e838\"\n", " ],\n", " \"WNAM\": [\n", " \"6563ebae141638f92ebbdc4a821bef8c\"\n", " ]\n", " }\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import GlobalLoadBalancerV1\n", "\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_identifier = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " globalLoadBalancer = GlobalLoadBalancerV1.new_instance(\n", " crn=crn, zone_identifier=zone_identifier, service_name=\"cis_services\")\n", " globalLoadBalancer.set_service_url(endpoint)\n", " name = \"test_lb1.alpha1.sdk.cistest-load.com\"\n", " default_pools = [\"6563ebae141638f92ebbdc4a821bef8c\",\n", " \"4112ba6c2974ec43886f90736968e838\"]\n", " fallback_pool = \"4112ba6c2974ec43886f90736968e838\"\n", " description = \"Test load balancer 2\"\n", " ttl = 60\n", " region_pools = {\n", " \"EEU\": [\n", " \"4112ba6c2974ec43886f90736968e838\"\n", " ],\n", " \"ENAM\": [\n", " \"6563ebae141638f92ebbdc4a821bef8c\"\n", " ],\n", " \"WEU\": [\n", " \"4112ba6c2974ec43886f90736968e838\"\n", " ],\n", " \"WNAM\": [\n", " \"6563ebae141638f92ebbdc4a821bef8c\"\n", " ]\n", " }\n", " pop_pools = None\n", " proxied = False\n", " enabled = True\n", " session_affinity = \"ip_cookie\"\n", " session_affinity_ttl = 5000\n", " steering_policy = \"random\"\n", " load_balancer_identifier = \"7e18c0979bfd05c96a064636c1415c20\" # sample load balancer id\n", " resp = globalLoadBalancer.edit_load_balancer(\n", " load_balancer_identifier=load_balancer_identifier, name=name,\n", " fallback_pool=fallback_pool, default_pools=default_pools,\n", " description=description, ttl=ttl, region_pools=region_pools,\n", " pop_pools=pop_pools, proxied=proxied, enabled=enabled,\n", " session_affinity=session_affinity, session_affinity_ttl=session_affinity_ttl,\n", " steering_policy=steering_policy).get_result()\n", " print(resp)\n", "\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/globalloadbalancerv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &globalloadbalancerv1.GlobalLoadBalancerV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := globalloadbalancerv1.NewGlobalLoadBalancerV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\t// update glb\n", "\tglbOpt := service.NewEditLoadBalancerOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\tglbOpt.SetName(\"test1.\" + os.Getenv(\"URL\"))\n", "\tglbOpt.SetDefaultPools([]string{\"c775e22a-5db5-461\"})\n", "\tglbOpt.SetFallbackPool(\"c775e22a-5db5-46198765465\")\n", "\tglbOpt.SetDescription(\"test glb\")\n", "\tglbOpt.SetEnabled(false)\n", "\tglbOpt.SetSessionAffinity(globalloadbalancerv1.CreateLoadBalancerOptions_SessionAffinity_Cookie)\n", "\tglbOpt.SetSessionAffinityTTL(5000)\n", "\tglbOpt.SetSteeringPolicy(globalloadbalancerv1.CreateLoadBalancerOptions_SteeringPolicy_DynamicLatency)\n", "\tresult, response, err := service.EditLoadBalancer(glbOpt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " EditLoadBalancerOptions editLoadBalancerOptions = new EditLoadBalancerOptions.Builder()\n", " .loadBalancerIdentifier(identifier)\n", " .name(\"example.java.sdk.cistest-load.com\")\n", " .fallbackPool(pIdentifier)\n", " .defaultPools(new java.util.ArrayList(java.util.Arrays.asList(pIdentifier)))\n", " .description(\"Load Balancer for www.example.com\")\n", " .ttl(Long.valueOf(\"30\"))\n", " .proxied(true)\n", " .enabled(true)\n", " .sessionAffinity(\"ip_cookie\")\n", " .sessionAffinityTtl(Long.valueOf(\"5000\"))\n", " .steeringPolicy(\"dynamic_latency\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.editLoadBalancer(editLoadBalancerOptions).execute();\n", " LoadBalancersResp loadBalancersRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " name: `app.${DOMAIN_NAME}`, // app.example.com\n", " description: 'Load Balancer for ${DOMAIN_NAME}',\n", " ttl: 30,\n", " proxied: true,\n", " enabled: true,\n", " sessionAffinity: 'ip_cookie',\n", " sessionAffinityTtl: 5000,\n", " steeringPolicy: 'dynamic_latency',\n", " defaultPools: ${poolIds}, // list of selected pool\n", " fallbackPool: ${poolId},\n", " loadBalancerIdentifier: ${loadBalancerId},\n", "};\n", "\n", "glbApi.editLoadBalancer(loadBalancerConfig)\n", " .then(response => {\n", " const updatedGLB = response.result.result;\n", " console.log(updatedGLB);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "delete": { "tags": [ "Global Load Balancer" ], "summary": "Delete load balancer", "operationId": "delete_load_balancer", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.reliability.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.load-balancers.delete" } ] }, "description": "Delete a load balancer.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "load_balancer_identifier", "description": "Load balancer identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_load_balancers_resp", "example": { "application/json": { "result": { "id": "678106b2b5143fa9560e320961500f81" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/load_balancers/:lb_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import GlobalLoadBalancerV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_identifier = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " globalLoadBalancer = GlobalLoadBalancerV1.new_instance(\n", " crn=crn, zone_identifier=zone_identifier, service_name=\"cis_services\")\n", " globalLoadBalancer.set_service_url(endpoint)\n", " load_balancer_identifier = \"7e18c0979bfd05c96a064636c1415c20\" # sample load balancer id\n", " resp = globalLoadBalancer.delete_load_balancer(\n", " load_balancer_identifier=load_balancer_identifier).get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/globalloadbalancerv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &globalloadbalancerv1.GlobalLoadBalancerV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := globalloadbalancerv1.NewGlobalLoadBalancerV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewDeleteLoadBalancerOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\tresult, response, err := service.DeleteLoadBalancer(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " DeleteLoadBalancerOptions deleteLoadBalancerOptions = new DeleteLoadBalancerOptions.Builder()\n", " .loadBalancerIdentifier(identifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.deleteLoadBalancer(deleteLoadBalancerOptions).execute();\n", " DeleteLoadBalancersResp deleteLoadBalancersRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "glbApi.deleteLoadBalancer({\n", " loadBalancerIdentifier: ${loadBalancerId},\n", "})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "get": { "tags": [ "Global Load Balancer" ], "summary": "Get load balancer", "operationId": "get_load_balancer_settings", "description": "For a given zone identifier and load balancer ID, get the load balancer settings.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "load_balancer_identifier", "description": "Load balancer identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/load_balancers_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": [ { "id": "451e8d47e817a8c2f2038638bac23541", "created_on": "2020-12-16T07:54:04.996Z", "modified_on": "2020-12-16T07:54:04.996Z", "description": "Test GLB", "name": "glbtest.com", "ttl": 30, "fallback_pool": "6bccf67198c3f061d82dda09f3d2e4e8", "default_pools": [ "7df7b9b072f72a4eb11d0fa1d4bb2d29" ], "region_pools": { "WNAM": [ "de90f38ced07c2e2f4df50b1f61d4194", "9290f38c5d07c2e2f4df57b1f61d4196" ], "ENAM": [ "00920f38ce07c2e2f4df50b1f61d4194" ] }, "pop_pools": { "LAX": [ "de90f38ced07c2e2f4df50b1f61d4194", "9290f38c5d07c2e2f4df57b1f61d4196" ], "LHR": [ "abd90f38ced07c2e2f4df50b1f61d4194", "f9138c5d07c2e2f4df57b1f61d4196" ], "SJC": [ "00920f38ce07c2e2f4df50b1f61d4194" ] }, "proxied": true, "enabled": true, "session_affinity": "ip_cookie", "session_affinity_attributes": { "samesite": "Auto", "secure": "None", "drain_duration": 0 }, "session_affinity_ttl": 5000, "steering_policy": "dynamic_latency" } ] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/load_balancers/:lb_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import GlobalLoadBalancerV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_identifier = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " globalLoadBalancer = GlobalLoadBalancerV1.new_instance(\n", " crn=crn, zone_identifier=zone_identifier, service_name=\"cis_services\")\n", " globalLoadBalancer.set_service_url(endpoint)\n", " load_balancer_identifier = \"7e18c0979bfd05c96a064636c1415c20\" # sample load balancer id\n", " resp = globalLoadBalancer.get_load_balancer_settings(\n", " load_balancer_identifier=load_balancer_identifier).get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/globalloadbalancerv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &globalloadbalancerv1.GlobalLoadBalancerV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := globalloadbalancerv1.NewGlobalLoadBalancerV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewGetLoadBalancerSettingsOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\tresult, response, err := service.GetLoadBalancerSettings(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetLoadBalancerSettingsOptions getLoadBalancerSettingsOptions = new GetLoadBalancerSettingsOptions.Builder()\n", " .loadBalancerIdentifier(identifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.getLoadBalancerSettings(getLoadBalancerSettingsOptions).execute();\n", " LoadBalancersResp loadBalancersRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "glbApi.getLoadBalancerSettings({\n", " loadBalancerIdentifier: ${loadBalancerId},\n", "})\n", " .then(response => {\n", " const glbConfig = response.result.result;\n", " console.log(glbConfig);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/dns_records_bulk": { "get": { "tags": [ "DNS Records" ], "summary": "Export zone file", "operationId": "get_dns_records_bulk", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.reliability.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.dns-records-bulk.read" } ] }, "description": "Export zone file", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "text/plain; charset=utf-8": { "schema": { "type": "string", "format": "binary" }, "examples": { "response": { "value": ";; A Records\n test-import.com.\t1\tIN\tA\t192.168.178.5" } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \"https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/dns_records_bulk\" \\\n", " -H \"x-auth-user-token: Bearer xxxxxx\" \\\n", " -H \"Content-Type: application/json\"\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import DnsRecordBulkV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " record = DnsRecordBulkV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " record.set_service_url(endpoint)\n", " resp = record.get_dns_records_bulk()\n", " print(resp.get_result().text)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/dnsrecordbulkv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &dnsrecordbulkv1.DnsRecordBulkV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := dnsrecordbulkv1.NewDnsRecordBulkV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewGetDnsRecordsBulkOptions()\n", "\tresult, response, err := service.GetDnsRecordsBulk(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tp := make([]byte, 256)\n", "\t_, err = result.Read(p)\n", "\tif err != nil {\n", "\t\tfmt.Println(err)\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(string(p))\n", "\tfmt.Println(response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetDnsRecordsBulkOptions getDnsRecordsBulkOptions = new GetDnsRecordsBulkOptions();\n", " // Invoke operation\n", " Response response = service.getDnsRecordsBulk(getDnsRecordsBulkOptions).execute();\n", " InputStream inputStreamResult = response.getResult();\n", " // reads till the end of the stream\n", " int i;\n", " char c;\n", " while((i = inputStreamResult.read())!=-1) {\n", " \n", " // converts integer to character\n", " c = (char)i; \n", " // prints character\n", " System.out.print(c);\n", " }\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const DnsRecordBulkV1 = require('ibm-networking-services/cis/dnsrecordsbulkv1/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "// Initialize the service client.\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "};\n", "\n", "const dnsRecordBulkV1 = new DnsRecordBulkV1(options);\n", "\n", "const response = dnsRecordBulkV1.getDnsRecordsBulk()\n", " .then(response => {\n", " const { result } = response || {};\n", " const dnsRecordsBulk = result.result;\n", " console.log(dnsRecordsBulk);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", " " ] } ] } ] } } }, "post": { "tags": [ "DNS Records" ], "summary": "Import zone file", "operationId": "post_dns_records_bulk", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.reliability.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.dns-records-bulk.create" } ] }, "description": "Import zone file", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "file": { "type": "string", "description": "File to upload", "format": "binary" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_records_object" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "recs_added": 5, "total_records_parsed": 5 }, "timing": { "start_time": "2020-04-02T12:20:00.000Z", "end_time": "2020-04-02T12:20:01.000Z", "process_time": 1 } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \"https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/dns_records_bulk\" \\\n", " -H \"x-auth-user-token: Bearer xxxxxx\" \\\n", " --form \"file=@bind_config.txt\"\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import DnsRecordBulkV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " record = DnsRecordBulkV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " record.set_service_url(endpoint)\n", " # open /tmp/record.txt file\n", " data = open(\"/tmp/records.txt\", \"rb\")\n", " resp = record.post_dns_records_bulk(file=data)\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"io\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/dnsrecordbulkv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &dnsrecordbulkv1.DnsRecordBulkV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := dnsrecordbulkv1.NewDnsRecordBulkV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewPostDnsRecordsBulkOptions()\n", "\tvar reader io.ReadCloser\n", "\treader, err := os.Open(\"records.txt\")\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\topt.SetFile(reader)\n", "\topt.SetFileContentType(\"application/octet-stream\")\n", "\tresult, response, err := service.PostDnsRecordsBulk(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.RecsAdded, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " // Create Test File that will be used for bulk import\n", " try {\n", " // Create a file\n", " File myObj = new File(\"test_dns_records.txt\");\n", " if (myObj.createNewFile()) {\n", " System.out.println(\"File created: \" + myObj.getName());\n", " } else {\n", " System.out.println(\"File already exists.\");\n", " }\n", "\n", " // Write to the file\n", " FileWriter myWriter = new FileWriter(\"test_dns_records.txt\");\n", " myWriter.write(\"example.sdk.cistest-load.com. 1 IN A 1.1.1.1\");\n", " myWriter.close();\n", " } catch (IOException e) {\n", " System.out.println(\"An error occurred.\");\n", " e.printStackTrace();\n", " }\n", " // Read the file content\n", " String data = null;\n", " try {\n", " File myObj = new File(\"test_dns_records.txt\");\n", " Scanner myReader = new Scanner(myObj);\n", " while (myReader.hasNextLine()) {\n", " data = myReader.nextLine();\n", " System.out.println(data);\n", " }\n", " myReader.close();\n", " } catch (FileNotFoundException e) {\n", " System.out.println(\"An error occurred.\");\n", " e.printStackTrace();\n", " }\n", " try {\n", " PostDnsRecordsBulkOptions postDnsRecordsBulkOptions = new PostDnsRecordsBulkOptions.Builder()\n", " .file(TestUtilities.createMockStream(data))\n", " .fileContentType(\"text\")\n", " .build();\n", " // Invoke operation\n", " Response response = service.postDnsRecordsBulk(postDnsRecordsBulkOptions).execute();\n", " DnsRecordsObject dnsRecordsObjectResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }\n", " \n", " // Delete the test file\n", " File myObj = new File(\"test_dns_records.txt\"); \n", " if (myObj.delete()) { \n", " System.out.println(\"Deleted the file: \" + myObj.getName());\n", " } else {\n", " System.out.println(\"Failed to delete the file.\");\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " file: ${path_to_upload_dns_records_file}),\n", "};\n", "const response = dnsRecordBulkV1.postDnsRecordsBulk(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const dnsRecordsBulk = result.result;\n", " console.log(dnsRecordsBulk);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/firewall/access_rules/rules": { "get": { "tags": [ "Zone Firewall Access Rules" ], "summary": "List all firewall access rules", "operationId": "list_all_zone_access_rules", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.ip-firewall-rules.read" } ] }, "description": "List all firewall access rules for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "query", "name": "notes", "description": "Search access rules by note.(Not case sensitive)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "mode", "description": "Search access rules by mode.", "required": false, "example": "block", "schema": { "type": "string", "enum": [ "block", "challenge", "whitelist", "js_challenge" ] } }, { "in": "query", "name": "configuration.target", "description": "Search access rules by configuration target", "required": false, "example": "ip", "schema": { "type": "string", "enum": [ "ip", "ip_range", "asn", "country" ] } }, { "in": "query", "name": "configuration.value", "description": "Search access rules by configuration value which can be IP, IPrange, or country code", "required": false, "example": "1.2.3.4", "schema": { "type": "string" } }, { "in": "query", "name": "page", "description": "Page number of paginated results.", "required": false, "schema": { "type": "integer", "default": 1 } }, { "in": "query", "name": "per_page", "description": "Maximum number of access rules per page.", "required": false, "schema": { "type": "integer", "minimum": 5, "default": 20 } }, { "in": "query", "name": "order", "description": "Field by which to order list of access rules.", "required": false, "schema": { "type": "string", "enum": [ "configuration.target", "configuration.value", "mode" ] } }, { "in": "query", "name": "direction", "description": "Direction in which to order results [ascending/descending order].", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "in": "query", "name": "match", "description": "Whether to match all (all) or atleast one search parameter (any).", "required": false, "schema": { "type": "string", "enum": [ "any", "all" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_zone_access_rules_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": [ { "id": "92f17202ed8bd63d69a66b86a49a8f6b", "notes": "This rule is set because of an event that occurred and caused X.", "allowed_modes": [ "whitelist", "block", "challenge", "js_challenge" ], "mode": "block", "scope": { "type": "zone" }, "created_on": "2018-10-01T05:20:00.123Z", "modified_on": "2018-10-01T05:20:00.123Z", "configuration": { "target": "ip_range", "value": "192.168.1.0/24" } } ], "result_info": { "page": 1, "per_page": 25, "total_pages": 1, "count": 1, "total_count": 1 } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/access_rules/rules \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import ZoneFirewallAccessRulesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " rule = ZoneFirewallAccessRulesV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " rule.set_service_url(endpoint)\n", " resp = rule.list_all_zone_access_rules()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/zonefirewallaccessrulesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &zonefirewallaccessrulesv1.ZoneFirewallAccessRulesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := zonefirewallaccessrulesv1.NewZoneFirewallAccessRulesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewListAllZoneAccessRulesOptions()\n", "\tresult, response, err := service.ListAllZoneAccessRules(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ListAllZoneAccessRulesOptions listAllZoneAccessRulesOptions = new ListAllZoneAccessRulesOptions.Builder()\n", " .notes(\"testString\")\n", " .mode(\"block\")\n", " .configurationTarget(\"ip\")\n", " .configurationValue(\"1.2.3.4\")\n", " .page(Long.valueOf(\"26\"))\n", " .perPage(Long.valueOf(\"5\"))\n", " .order(\"configuration.target\")\n", " .direction(\"asc\")\n", " .match(\"any\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.listAllZoneAccessRules(listAllZoneAccessRulesOptions).execute();\n", " ListZoneAccessRulesResp listZoneAccessRulesRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const ZoneFirewallAccessRulesV1 = require('ibm-networking-services/cis/zonefirewallaccessrulesv1/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "// Initialize the service client.\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "};\n", "\n", "const zoneFirewallAccessRulesV1 = new ZoneFirewallAccessRulesV1(options);\n", "\n", "zoneFirewallAccessRulesV1.listAllZoneAccessRules()\n", " .then(response => {\n", " const { result } = response || {};\n", " const zoneAccessRules = result.result;\n", " console.log(JSON.stringify(zoneAccessRules, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "post": { "tags": [ "Zone Firewall Access Rules" ], "summary": "Create firewall access rule", "operationId": "create_zone_access_rule", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.ip-firewall-rules.create" } ] }, "description": "Create a new firewall access rule for a given zone under a service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_access_rule_input" } } }, "description": "Access rule parameters." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_access_rule_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "92f17202ed8bd63d69a66b86a49a8f6b", "notes": "This rule is added because of event X that occurred on date xyz", "allowed_modes": [ "whitelist", "block", "challenge", "js_challenge" ], "mode": "block", "scope": { "type": "zone" }, "created_on": "2018-10-01T05:20:00.123Z", "modified_on": "2018-10-01T05:20:00.123Z", "configuration": { "target": "ip", "value": "192.168.1.100" } } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/access_rules/rules \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " --data '{ \\\n", " \"mode\": \"block\", \\\n", " \"notes\": \"This rule is added because of event X that occurred on date xyz\", \\\n", " \"configuration\": { \\\n", " \"target\": \"ip\", \\\n", " \"value\": \"192.168.1.100\" \\\n", " } \\\n", " }'\n", " \n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import ZoneFirewallAccessRulesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " rule = ZoneFirewallAccessRulesV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " rule.set_service_url(endpoint)\n", " # input variables\n", " notes = \"This rule is added because of event X that occurred on date xyz\"\n", " mode = \"challenge\"\n", " configuration = {\n", " \"target\": \"ip\",\n", " \"value\": \"192.168.2.44\"\n", " }\n", " # create instance\n", " resp = rule.create_zone_access_rule(\n", " mode=mode, configuration=configuration, notes=notes)\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/zonefirewallaccessrulesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &zonefirewallaccessrulesv1.ZoneFirewallAccessRulesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := zonefirewallaccessrulesv1.NewZoneFirewallAccessRulesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewCreateZoneAccessRuleOptions()\n", "\toptions.SetMode(zonefirewallaccessrulesv1.CreateZoneAccessRuleOptions_Mode_Challenge)\n", "\tconfigOpt, err := service.NewZoneAccessRuleInputConfiguration(\"172.168.1.1\", zonefirewallaccessrulesv1.ZoneAccessRuleInputConfiguration_Target_Ip)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\toptions.SetConfiguration(configOpt)\n", "\tresult, response, err := service.CreateZoneAccessRule(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ZoneAccessRuleInputConfiguration zoneAccessRuleInputConfigurationModel = new ZoneAccessRuleInputConfiguration.Builder()\n", " .target(\"ip\")\n", " .value(\"1.1.1.2\")\n", " .build();\n", "\n", " CreateZoneAccessRuleOptions createZoneAccessRuleOptions = new CreateZoneAccessRuleOptions.Builder()\n", " .mode(\"block\")\n", " .notes(\"This rule is added because of event X that occurred on date xyz\")\n", " .configuration(zoneAccessRuleInputConfigurationModel)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.createZoneAccessRule(createZoneAccessRuleOptions).execute();\n", " ZoneAccessRuleResp zoneAccessRuleRespResult = response.getResult();\n", " identifier = zoneAccessRuleRespResult.getResult().getId();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " allowed_modes: ['whitelist', 'block', 'challenge', 'js_challenge'],\n", " mode: 'whitelist',\n", " notes: 'This is for verifying the api',\n", " configuration: { target: 'ip', value: '10.38.9.8' },\n", "};\n", "zoneFirewallAccessRulesV1.createZoneAccessRule(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const zoneAccessRule = result.result;\n", " console.log(JSON.stringify(zoneAccessRule, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/firewall/access_rules/rules/{accessrule_identifier}": { "delete": { "tags": [ "Zone Firewall Access Rules" ], "summary": "Delete firewall access rule", "operationId": "delete_zone_access_rule", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.ip-firewall-rules.delete" } ] }, "description": "Delete an access rule, given its ID.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "accessrule_identifier", "description": "Identifier of the access rule to be deleted.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_zone_access_rule_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "f1aba936b94213e5b8dca0c0dbf1f9cc" } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/access_rules/rules/:rule_id \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import ZoneFirewallAccessRulesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " rule = ZoneFirewallAccessRulesV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " rule.set_service_url(endpoint)\n", " resp = rule.delete_zone_access_rule(\n", " accessrule_identifier=\"5a62487d404946dbaf7143bd9541b735\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/zonefirewallaccessrulesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &zonefirewallaccessrulesv1.ZoneFirewallAccessRulesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := zonefirewallaccessrulesv1.NewZoneFirewallAccessRulesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewDeleteZoneAccessRuleOptions(\"5a62487d404946dbaf7143bd9541b735\")\n", "\tresult, response, err := service.DeleteZoneAccessRule(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " DeleteZoneAccessRuleOptions deleteZoneAccessRuleOptions = new DeleteZoneAccessRuleOptions.Builder()\n", " .accessruleIdentifier(identifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.deleteZoneAccessRule(deleteZoneAccessRuleOptions).execute();\n", " DeleteZoneAccessRuleResp deleteZoneAccessRuleRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " accessruleIdentifier: ${zoneFirewallAccessRuleId},\n", "};\n", "zoneFirewallAccessRulesV1.deleteZoneAccessRule(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const zoneAccessRule = result.result;\n", " console.log(JSON.stringify(zoneAccessRule, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "get": { "tags": [ "Zone Firewall Access Rules" ], "summary": "Get firewall access rule", "operationId": "get_zone_access_rule", "description": "Get the details of a firewall access rule for a given zone under a given service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "accessrule_identifier", "description": "Identifier of firewall access rule for the given zone.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_access_rule_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "92f17202ed8bd63d69a66b86a49a8f6b", "notes": "This rule is set because of an event that occurred and caused X.", "allowed_modes": [ "whitelist", "block", "challenge", "js_challenge" ], "mode": "block", "scope": { "type": "zone" }, "created_on": "2018-10-01T05:20:00.123Z", "modified_on": "2018-10-01T05:20:00.123Z", "configuration": { "target": "ip_range", "value": "192.168.1.0/24" } } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/access_rules/rules/:rule_id \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import ZoneFirewallAccessRulesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " rule = ZoneFirewallAccessRulesV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " rule.set_service_url(endpoint)\n", " resp = rule.get_zone_access_rule(\n", " accessrule_identifier=\"5a62487d404946dbaf7143bd9541b735\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/zonefirewallaccessrulesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &zonefirewallaccessrulesv1.ZoneFirewallAccessRulesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := zonefirewallaccessrulesv1.NewZoneFirewallAccessRulesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewGetZoneAccessRuleOptions(\"5a62487d404946dbaf7143bd9541b735\")\n", "\tresult, response, err := service.GetZoneAccessRule(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetZoneAccessRuleOptions getZoneAccessRuleOptions = new GetZoneAccessRuleOptions.Builder()\n", " .accessruleIdentifier(identifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.getZoneAccessRule(getZoneAccessRuleOptions).execute();\n", " ZoneAccessRuleResp zoneAccessRuleRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " accessruleIdentifier: ${zoneFirewallAccessRuleId},\n", "};\n", "zoneFirewallAccessRulesV1.getZoneAccessRule(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const zoneAccessRule = result.result;\n", " console.log(JSON.stringify(zoneAccessRule, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Zone Firewall Access Rules" ], "summary": "Update firewall access rule", "operationId": "update_zone_access_rule", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.ip-firewall-rules.update" } ] }, "description": "Update an existing firewall access rule for a given zone under a given service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "accessrule_identifier", "description": "Identifier of firewall access rule", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_access_rule_update_input" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_access_rule_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "92f17202ed8bd63d69a66b86a49a8f6b", "notes": "This rule is added because of event X that occurred on date xyz", "allowed_modes": [ "whitelist", "block", "challenge", "js_challenge" ], "mode": "block", "scope": { "type": "zone" }, "created_on": "2018-10-01T05:20:00.123Z", "modified_on": "2018-10-01T05:20:00.123Z", "configuration": { "target": "ip", "value": "192.168.1.100" } } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/access_rules/rules/:rule_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " --data '{ \\\n", " \"mode\": \"block\", \\\n", " \"notes\": \"This rule is added because of event X that occurred on date xyz\" \\\n", " }'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import ZoneFirewallAccessRulesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " rule = ZoneFirewallAccessRulesV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " rule.set_service_url(endpoint)\n", " # input variables\n", " notes = \"This rule is added because of event X that occurred on date xyz\"\n", " mode = \"challenge\"\n", " configuration = {\n", " \"target\": \"ip\",\n", " \"value\": \"192.168.2.44\"\n", " }\n", " # create instance\n", " resp = rule.update_zone_access_rule(\n", " accessrule_identifier=\"5a62487d404946dbaf7143bd9541b735\", mode=mode, configuration=configuration, notes=notes)\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/zonefirewallaccessrulesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &zonefirewallaccessrulesv1.ZoneFirewallAccessRulesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := zonefirewallaccessrulesv1.NewZoneFirewallAccessRulesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewUpdateZoneAccessRuleOptions(\"5a62487d404946dbaf7143bd9541b735\")\n", "\toptions.SetMode(zonefirewallaccessrulesv1.CreateZoneAccessRuleOptions_Mode_Challenge)\n", "\tresult, response, err := service.UpdateZoneAccessRule(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " UpdateZoneAccessRuleOptions updateZoneAccessRuleOptions = new UpdateZoneAccessRuleOptions.Builder()\n", " .accessruleIdentifier(identifier)\n", " .mode(\"block\")\n", " .notes(\"This rule is added because of event X that occurred on date xyz\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.updateZoneAccessRule(updateZoneAccessRuleOptions).execute();\n", " ZoneAccessRuleResp zoneAccessRuleRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " accessruleIdentifier: ${zoneFirewallAccessRuleId},\n", " notes: 'This is for verifying the api',\n", "};\n", "zoneFirewallAccessRulesV1.updateZoneAccessRule(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const deletedRangeApp = result.result;\n", " console.log(JSON.stringify(deletedRangeApp, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", " " ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/firewall/ua_rules": { "get": { "tags": [ "User-Agent Blocking Rules" ], "summary": "List all user-agent blocking rules", "operationId": "list_all_zone_user_agent_rules", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.ua-rules.read" } ] }, "description": "List all user agent blocking rules.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "query", "name": "page", "description": "Page number of paginated results.", "required": false, "schema": { "type": "integer", "default": 1 } }, { "in": "query", "name": "per_page", "description": "Maximum number of user-agent rules per page.", "required": false, "schema": { "type": "integer", "minimum": 5, "default": 20 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_useragent_rules_resp" }, "examples": { "response": { "value": { "result": [ { "id": "xxxxxx" } ], "success": true, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result_info": { "page": 1, "per_page": 25, "count": 0, "total_count": 0, "total_pages": 0 } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/ua_rules \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import UserAgentBlockingRulesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_identifier = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " userAgentBlockingRules = UserAgentBlockingRulesV1.new_instance(\n", " crn=crn, zone_identifier=zone_identifier, service_name=\"cis_services\")\n", " userAgentBlockingRules.set_service_url(endpoint)\n", " page = 1\n", " per_page = 20\n", " resp = userAgentBlockingRules.list_all_zone_user_agent_rules(\n", " page=page, per_page=per_page).get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/useragentblockingrulesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &useragentblockingrulesv1.UserAgentBlockingRulesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := useragentblockingrulesv1.NewUserAgentBlockingRulesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewListAllZoneUserAgentRulesOptions()\n", "\tresult, response, err := service.ListAllZoneUserAgentRules(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ListAllZoneUserAgentRulesOptions listAllZoneUserAgentRulesOptions = new ListAllZoneUserAgentRulesOptions.Builder()\n", " .page(Long.valueOf(\"26\"))\n", " .perPage(Long.valueOf(\"5\"))\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.listAllZoneUserAgentRules(listAllZoneUserAgentRulesOptions).execute();\n", " ListUseragentRulesResp listUseragentRulesRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const UserAgentBlockingRulesV1 = require('ibm-networking-services/cis/useragentblockingrulesv1/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "// Initialize the service client.\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "};\n", "\n", "const userAgentBlockingRulesV1 = new UserAgentBlockingRulesV1(options);\n", "\n", "userAgentBlockingRulesV1.listAllZoneUserAgentRules()\n", " .then(response => {\n", " const { result } = response || {};\n", " const zoneUserAgentRules = result.result;\n", " console.log(JSON.stringify(zoneUserAgentRules, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "post": { "tags": [ "User-Agent Blocking Rules" ], "summary": "Create user-agent blocking rule", "operationId": "create_zone_user_agent_rule", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.ua-rules.create" } ] }, "description": "Create a new user-agent blocking rule for a given zone under a service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/useragent_rule_input" } } }, "description": "User-agent blocking rule parameters." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/useragent_rule_resp" }, "examples": { "response": { "value": { "success": true, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "id": "xxxxxx" } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/ua_rules \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "-d '{\n", " \"paused\": false,\n", " \"description\": \"Prevent access from abusive clients identified by this UserAgent to mitigate DDoS attack\",\n", " \"mode\": \"block\",\n", " \"configuration\": {\n", " \"target\": \"ua\",\n", " \"value\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4\"\n", " }\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import UserAgentBlockingRulesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_identifier = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " userAgentBlockingRules = UserAgentBlockingRulesV1.new_instance(\n", " crn=crn, zone_identifier=zone_identifier, service_name=\"cis_services\")\n", " userAgentBlockingRules.set_service_url(endpoint)\n", " paused = False\n", " description = \"Prevent access from abusive clients identified by this UserAgent to mitigate DDoS attack\"\n", " mode = \"block\"\n", " configuration = {\n", " \"target\": \"ua\",\n", " \"value\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4\"\n", " }\n", " resp = userAgentBlockingRules.create_zone_user_agent_rule(\n", " mode=mode, configuration=configuration,\n", " paused=paused, description=description).get_result()\n", " print(resp)\n", "\n", " resp = userAgentBlockingRules.create_zone_user_agent_rule(\n", " crn=crn, zone_identifier=zone_identifier, mode=mode, configuration=configuration, \n", " paused=paused, description=description).get_result()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/useragentblockingrulesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &useragentblockingrulesv1.UserAgentBlockingRulesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := useragentblockingrulesv1.NewUserAgentBlockingRulesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewCreateZoneUserAgentRuleOptions()\n", "\tuaConfigOpt, uaConfigErr := service.NewUseragentRuleInputConfiguration(\"ua\", \"Mozilla/2.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4\")\n", "\tif uaConfigErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions.SetMode(useragentblockingrulesv1.CreateZoneUserAgentRuleOptions_Mode_Challenge)\n", "\toptions.SetConfiguration(uaConfigOpt)\n", "\toptions.SetDescription(\"Test user agent rule\")\n", "\toptions.SetPaused(false)\n", "\tresult, response, err := service.CreateZoneUserAgentRule(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " UseragentRuleInputConfiguration useragentRuleInputConfigurationModel = new UseragentRuleInputConfiguration.Builder()\n", " .target(\"ua\")\n", " .value(\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4\")\n", " .build();\n", "\n", " CreateZoneUserAgentRuleOptions createZoneUserAgentRuleOptions = new CreateZoneUserAgentRuleOptions.Builder()\n", " .paused(true)\n", " .description(\"Prevent access from abusive clients identified by this UserAgent to mitigate DDoS attack\")\n", " .mode(\"block\")\n", " .configuration(useragentRuleInputConfigurationModel)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.createZoneUserAgentRule(createZoneUserAgentRuleOptions).execute();\n", " UseragentRuleResp useragentRuleRespResult = response.getResult();\n", " identifier = useragentRuleRespResult.getResult().getId();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " paused: false,\n", " description:\n", " 'Prevent access from abusive clients identified by this UserAgent to mitigate DDoS attack',\n", " mode: 'block',\n", " configuration: {\n", " target: 'ua',\n", " value:\n", " 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4',\n", " },\n", "};\n", "userAgentBlockingRulesV1.createZoneUserAgentRule(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const zoneUserAgentRule = result.result;\n", " console.log(JSON.stringify(zoneUserAgentRule, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/firewall/ua_rules/{useragent_rule_identifier}": { "delete": { "tags": [ "User-Agent Blocking Rules" ], "summary": "Delete user-agent blocking rule", "operationId": "delete_zone_user_agent_rule", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.ua-rules.delete" } ] }, "description": "Delete a user-agent blocking rule for a particular zone, given its ID.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "useragent_rule_identifier", "description": "Identifier of the user-agent rule to be deleted.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_useragent_rule_resp" }, "examples": { "response": { "value": { "success": true, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "id": "xxxxxx" } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/ua_rules/:useragent_rule_identifier \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import UserAgentBlockingRulesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_identifier = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " userAgentBlockingRules = UserAgentBlockingRulesV1.new_instance(\n", " crn=crn, zone_identifier=zone_identifier, service_name=\"cis_services\")\n", " userAgentBlockingRules.set_service_url(endpoint)\n", " useragent_rule_identifier = \"0218ec392eb34aebaff2106e8a1914ae\"\n", " resp = userAgentBlockingRules.delete_zone_user_agent_rule(\n", " useragent_rule_identifier=useragent_rule_identifier).get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/useragentblockingrulesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &useragentblockingrulesv1.UserAgentBlockingRulesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := useragentblockingrulesv1.NewUserAgentBlockingRulesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewDeleteZoneUserAgentRuleOptions(\"6563ebae141638f92ebbdc4a821bef8c\")\n", "\tresult, response, err := service.DeleteZoneUserAgentRule(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " DeleteZoneUserAgentRuleOptions deleteZoneUserAgentRuleOptions = new DeleteZoneUserAgentRuleOptions.Builder()\n", " .useragentRuleIdentifier(identifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.deleteZoneUserAgentRule(deleteZoneUserAgentRuleOptions).execute();\n", " DeleteUseragentRuleResp deleteUseragentRuleRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " useragentRuleIdentifier: ${userAgentBlockingRuleId},\n", "};\n", "userAgentBlockingRulesV1.deleteZoneUserAgentRule(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const deletedZoneAccessRule = result.result;\n", " console.log(JSON.stringify(deletedZoneAccessRule, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "get": { "tags": [ "User-Agent Blocking Rules" ], "summary": "Get user-agent blocking rule", "operationId": "get_user_agent_rule", "description": "For a given service instance, zone ID and user-agent rule ID, get the user-agent blocking rule details.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "useragent_rule_identifier", "description": "Identifier of user-agent blocking rule for the given zone.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/useragent_rule_resp" }, "examples": { "response": { "value": { "success": true, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "id": "xxxxxx" } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/ua_rules/:useragent_rule_identifier \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import UserAgentBlockingRulesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_identifier = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " userAgentBlockingRules = UserAgentBlockingRulesV1.new_instance(\n", " crn=crn, zone_identifier=zone_identifier, service_name=\"cis_services\")\n", " userAgentBlockingRules.set_service_url(endpoint)\n", " useragent_rule_identifier = \"0218ec392eb34aebaff2106e8a1914ae\"\n", " resp = userAgentBlockingRules.get_user_agent_rule(\n", " useragent_rule_identifier=useragent_rule_identifier).get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/useragentblockingrulesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &useragentblockingrulesv1.UserAgentBlockingRulesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := useragentblockingrulesv1.NewUserAgentBlockingRulesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewGetUserAgentRuleOptions(\"6563ebae141638f92ebbdc4a821bef8c\")\n", "\tresult, response, err := service.GetUserAgentRule(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetUserAgentRuleOptions getUserAgentRuleOptions = new GetUserAgentRuleOptions.Builder()\n", " .useragentRuleIdentifier(identifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.getUserAgentRule(getUserAgentRuleOptions).execute();\n", " UseragentRuleResp useragentRuleRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " useragentRuleIdentifier: ${userAgentBlockingRuleId},\n", "};\n", "userAgentBlockingRulesV1.getUserAgentRule(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const userAgentRule = result.result;\n", " console.log(JSON.stringify(userAgentRule, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "put": { "tags": [ "User-Agent Blocking Rules" ], "summary": "Update user-agent blocking rule", "operationId": "update_user_agent_rule", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.ua-rules.update" } ] }, "description": "Update an existing user-agent blocking rule for a given zone under a given service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "useragent_rule_identifier", "description": "Identifier of user-agent rule", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/useragent_rule_input" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/useragent_rule_resp" }, "examples": { "response": { "value": { "success": true, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "id": "xxxxxx" } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/ua_rules:useragent_rule_identifier \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "-d '{\n", " \"mode\": \"block\",\n", " \"configuration\": {\n", " \"target\": \"ua\",\n", " \"value\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4\"\n", " }\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import UserAgentBlockingRulesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_identifier = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " userAgentBlockingRules = UserAgentBlockingRulesV1.new_instance(\n", " crn=crn, zone_identifier=zone_identifier, service_name=\"cis_services\")\n", " userAgentBlockingRules.set_service_url(endpoint)\n", " paused = True\n", " description = \"Prevent access from abusive clients identified by this UserAgent to mitigate DDoS attack\"\n", " mode = \"block\"\n", " configuration = {\n", " \"target\": \"ua\",\n", " \"value\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4\"\n", " useragent_rule_identifier = \"0218ec392eb34aebaff2106e8a1914ae\"\n", " \n", " resp = userAgentBlockingRules.update_user_agent_rule(\n", " useragent_rule_identifier=useragent_rule_identifier,\n", " mode=mode, configuration=configuration, paused=paused, description=description).get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/useragentblockingrulesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &useragentblockingrulesv1.UserAgentBlockingRulesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := useragentblockingrulesv1.NewUserAgentBlockingRulesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewUpdateUserAgentRuleOptions(\"6563ebae141638f92ebbdc4a821bef8c\")\n", "\tuaConfigOpt, uaConfigErr := service.NewUseragentRuleInputConfiguration(\"ua\", \"Mozilla/2.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4\")\n", "\tif uaConfigErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions.SetMode(useragentblockingrulesv1.UpdateUserAgentRuleOptions_Mode_Challenge)\n", "\toptions.SetConfiguration(uaConfigOpt)\n", "\toptions.SetDescription(\"Test user agent rule\")\n", "\toptions.SetPaused(false)\n", "\tresult, response, err := service.UpdateUserAgentRule(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " UseragentRuleInputConfiguration useragentRuleInputConfigurationModel = new UseragentRuleInputConfiguration.Builder()\n", " .target(\"ua\")\n", " .value(\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4\")\n", " .build();\n", "\n", " UpdateUserAgentRuleOptions updateUserAgentRuleOptions = new UpdateUserAgentRuleOptions.Builder()\n", " .useragentRuleIdentifier(identifier)\n", " .paused(true)\n", " .description(\"Prevent access from abusive clients identified by this UserAgent to mitigate DDoS attack\")\n", " .mode(\"block\")\n", " .configuration(useragentRuleInputConfigurationModel)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.updateUserAgentRule(updateUserAgentRuleOptions).execute();\n", " UseragentRuleResp useragentRuleRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " configuration: {\n", " target: 'ua',\n", " value:\n", " 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4',\n", " },\n", " mode: 'block',\n", " notes: 'This is for verifying the api for user agent blocking rule.',\n", " useragentRuleIdentifier: ${userAgentBlockingRuleId},\n", "};\n", "userAgentBlockingRulesV1.updateUserAgentRule(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const updatedUserAgentRule = result.result;\n", " console.log(JSON.stringify(updatedUserAgentRule, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v2/{crn}/zones/{zone_id}/analytics/firewall_events": { "get": { "tags": [ "Firewall Event Analytics" ], "summary": "Firewall event analytics data", "operationId": "firewall_event_analytics", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.firewall-events-analytics.read" } ] }, "description": "Provides a full log of the mitigations performed by the CIS Firewall features including; Firewall Rules, Rate Limiting, Security Level, Access Rules (IP, IP Range, ASN, and Country), WAF (Web Application Firewall), User Agent Blocking, Zone Lockdown, and Advanced DDoS Protection.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "in": "query", "name": "dataset", "description": "The dataset of analytics data.", "required": false, "schema": { "type": "string", "enum": [ "firewallEventsAdaptiveGroups" ] } }, { "in": "query", "name": "filter", "description": "The 'datetime' is a filter base on time range. This filter can combine with operators ('gt', 'lt', 'geq', 'leq', 'neq', and 'in') to filter data by specified time range, e.g., `filter=datetime_geq:2020-06-28T00:00:00Z&filter=datetime_leq:2020-06-29T00:00:00Z`.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of events to return. (minimum is 1 and maximum is 10000)", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 10000, "default": 10000 } }, { "in": "query", "name": "orderBy", "description": "Output order of the events.", "required": false, "schema": { "type": "string", "enum": [ "datetime_ASC", "datetime_DESC", "datetimeFifteenMinutes_ASC", "datetimeFifteenMinutes_DESC", "datetimeHour_ASC", "datetimeHour_DESC", "datetimeFiveMinutes_ASC", "datetimeFiveMinutes_DESC", "datetimeMinute_ASC", "datetimeMinute_DESC", "action_ASC", "action_DESC", "avg_sampleInterval_ASC", "avg_sampleInterval_DESC", "clientASNDescription_ASC", "clientASNDescription_DESC", "clientAsn_ASC", "clientAsn_DESC", "clientCountryName_ASC", "clientCountryName_DESC", "clientIPClass_ASC", "clientIPClass_DESC", "clientIP_ASC", "clientIP_DESC", "clientRefererHost_ASC", "clientRefererHost_DESC", "clientRefererPath_ASC", "clientRefererPath_DESC", "clientRefererQuery_ASC", "clientRefererQuery_DESC", "clientRefererScheme_ASC", "clientRefererScheme_DESC", "clientRequestHTTPHost_ASC", "clientRequestHTTPHost_DESC", "clientRequestHTTPMethodName_ASC", "clientRequestHTTPMethodName_DESC", "clientRequestHTTPProtocol_ASC", "clientRequestHTTPProtocol_DESC", "clientRequestPath_ASC", "clientRequestPath_DESC", "clientRequestQuery_ASC", "clientRequestQuery_DESC", "clientRequestScheme_ASC", "clientRequestScheme_DESC", "count_ASC", "count_DESC", "edgeColoName_ASC", "edgeColoName_DESC", "edgeResponseStatus_ASC", "edgeResponseStatus_DESC", "kind_ASC", "kind_DESC", "matchIndex_ASC", "matchIndex_DESC", "originResponseStatus_ASC", "originResponseStatus_DESC", "originatorRayName_ASC", "originatorRayName_DESC", "rayName_ASC", "rayName_DESC", "ref_ASC", "ref_DESC", "ruleId_ASC", "ruleId_DESC", "sampleInterval_ASC", "sampleInterval_DESC", "source_ASC", "source_DESC", "userAgent_ASC", "userAgent_DESC", "visibility_ASC", "visibility_DESC" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewall_event_analytics" } } } }, "400": { "description": "Bad input parameter" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/v1/{crn}/load_balancers/events": { "get": { "tags": [ "Global Load Balancer Events" ], "summary": "List all load balancer events", "operationId": "get_load_balancer_events", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.load-balancer-events.read" } ] }, "description": "Get load balancer events for all origins.", "parameters": [ { "$ref": "#/components/parameters/crn" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_events_resp" }, "examples": { "response": { "value": { "result": [ { "id": 4896661264171190000, "timestamp": "2018-10-06T21:34:40.000Z", "pool": { "id": "277fd43c41410af9b94c0cd6471e3272", "name": "hk-pool", "healthy": true, "changed": true, "minimum_origins": 1 }, "origins": [ { "name": "hk01", "address": "", "ip": "x.x.x.x", "enabled": true, "healthy": true, "failure_reason": "No failures", "changed": true } ] }, { "id": 5243357240757643000, "timestamp": "2018-10-06T20:23:34.000Z", "pool": { "id": "277fd43c41410af9b94c0cd6471e3272", "name": "hk-pool", "healthy": false, "changed": true, "minimum_origins": 1 }, "origins": [ { "name": "hk01", "address": "", "ip": "x.x.x.x", "enabled": true, "healthy": false, "failure_reason": "HTTP timeout occurred", "changed": true } ] } ], "success": true, "errors": [], "messages": [], "result_info": { "page": 1, "per_page": 50, "count": 2, "total_count": 2 } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/load_balancers/events \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import GlobalLoadBalancerEventsV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " globalLoadBalancerEvents = GlobalLoadBalancerEventsV1.new_instance(\n", " crn=crn, service_name=\"cis_services\")\n", " globalLoadBalancerEvents.set_service_url(endpoint)\n", " resp = globalLoadBalancerEvents.get_load_balancer_events().get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/globalloadbalancereventsv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tglobalOptions := &globalloadbalancereventsv1.GlobalLoadBalancerEventsV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t}\n", "\tservice, serviceErr := globalloadbalancereventsv1.NewGlobalLoadBalancerEventsV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\tglbOpt := service.NewGetLoadBalancerEventsOptions()\n", "\tresult, response, err := service.GetLoadBalancerEvents(glbOpt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetLoadBalancerEventsOptions getLoadBalancerEventsOptions = new GetLoadBalancerEventsOptions();\n", "\n", " // Invoke operation\n", " Response response = service.getLoadBalancerEvents(getLoadBalancerEventsOptions).execute();\n", " ListEventsResp listEventsRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const GLBEventsAPI = require('ibm-networking-services/cis/global-load-balancer-events/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "}\n", "\n", "const glbEventsApi = new GLBEventsAPI(options);\n", "\n", "glbEventsApi.getLoadBalancerEvents({})\n", " .then(response => {\n", " const glbEventList = response.result.result;\n", " console.log(glbEventList);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/settings/waf": { "get": { "tags": [ "WAF settings (previous)" ], "operationId": "get_waf_settings", "deprecated": true, "summary": "Get WAF setting", "description": "Get WAF of a specific zone. WAF is moving to the Managed Rules engine for enhanced performance and security. For information about migrating to Managed Rules, see [Migration to managed rules](/docs/cis?topic=cis-migrating-to-managed-rules). This API is not available post-migration.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/waf-response" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "waf", "value": "on", "editable": true, "modified_on": "2018-01-10T05:13:13.967946Z" } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal Server Error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/waf \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import WafApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " waf = WafApiV1.new_instance(\n", " crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " waf.set_service_url(endpoint)\n", " resp = waf.get_waf_settings()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/wafapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &wafapiv1.WafApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := wafapiv1.NewWafApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewGetWafSettingsOptions()\n", "\tresult, response, err := service.GetWafSettings(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetWafSettingsOptions getWafSettingsOptions = new GetWafSettingsOptions();\n", "\n", " // Invoke operation\n", " Response response = service.getWafSettings(getWafSettingsOptions).execute();\n", " WafResponse wafResponseResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const WafApiV1 = require('ibm-networking-services/cis/wafapiv1/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "// Initialize the service client.\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "};\n", "\n", "const wafApiV1 = new WafApiV1(options);\n", "wafApiV1.getWafSettings()\n", " .then(response => {\n", " const { result } = response || {};\n", " const wafSettings = result.result;\n", " console.log(JSON.stringify(wafSettings, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "WAF settings (previous)" ], "operationId": "update_waf_settings", "deprecated": true, "summary": "Set WAF setting", "description": "Set WAF (on | off) for a specific zone. WAF is moving to the Managed Rules engine for enhanced performance and security. For information about migrating to Managed Rules, see [Migration to managed rules](/docs/cis?topic=cis-migrating-to-managed-rules). This API is not available post-migration.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/waf-body" } } }, "description": "The valid value is on | off." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/waf-response" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "waf", "value": "on", "editable": true, "modified_on": "2018-01-10T05:13:13.967946Z" } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal Server Error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/waf \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import WafApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " waf = WafApiV1.new_instance(\n", " crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " waf.set_service_url(endpoint)\n", " resp = waf.update_waf_settings(value=\"off\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/wafapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &wafapiv1.WafApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := wafapiv1.NewWafApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewUpdateWafSettingsOptions()\n", "\toptions.SetValue(wafapiv1.UpdateWafSettingsOptions_Value_On)\n", "\tresult, response, err := service.UpdateWafSettings(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " UpdateWafSettingsOptions updateWafSettingsOptions = new UpdateWafSettingsOptions.Builder()\n", " .value(\"on\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.updateWafSettings(updateWafSettingsOptions).execute();\n", " WafResponse wafResponseResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " value: 'on',\n", "};\n", "wafApiV1.updateWafSettings(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const updatedWafSettings = result.result;\n", " console.log(JSON.stringify(updatedWafSettings, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/security_level": { "get": { "tags": [ "Security Level Setting" ], "summary": "Get security-level setting", "operationId": "get_security_level_setting", "description": "For a given zone identifier, get security-level setting.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/security_level_setting_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [ { "status": "OK" } ], "result": { "id": "security_level,", "value": "medium", "editable": true, "modified_on": "2014-01-01T05:20:00.12345Z" }, "result_info": { "page": 1, "per_page": 2, "count": 1, "total_count": 200 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/security_level \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import FirewallApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " firewall = FirewallApiV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " firewall.set_service_url(endpoint)\n", " resp = firewall.get_security_level_setting()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/firewallapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &firewallapiv1.FirewallApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := firewallapiv1.NewFirewallApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewGetSecurityLevelSettingOptions()\n", "\tresult, response, err := service.GetSecurityLevelSetting(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetSecurityLevelSettingOptions getSecurityLevelSettingOptions = new GetSecurityLevelSettingOptions();\n", "\n", " // Invoke operation\n", " Response response = service.getSecurityLevelSetting(getSecurityLevelSettingOptions).execute();\n", " SecurityLevelSettingResp securityLevelSettingRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const FirewallApiV1 = require('ibm-networking-services/cis/firewallapiv1/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "// Initialize the service client.\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "};\n", "\n", "const firewallApiV1 = new FirewallApiV1(options);\n", "firewallApiV1.getSecurityLevelSetting()\n", " .then(response => {\n", " const { result } = response || {};\n", " const securityLevelSetting = result.result;\n", " console.log(JSON.stringify(securityLevelSetting, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Security Level Setting" ], "summary": "Set security-level setting", "operationId": "set_security_level_setting", "description": "For a given zone identifier, set security-level setting.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/security_level_setting_req" } } }, "description": "Set security-level setting." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/security_level_setting_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [ { "status": "OK" } ], "result": { "id": "security_level,", "value": "medium", "editable": true, "modified_on": "2014-01-01T05:20:00.12345Z" }, "result_info": { "page": 1, "per_page": 2, "count": 1, "total_count": 200 } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/security_level \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " --data '{\"value\": \"under_attack\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import FirewallApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " firewall = FirewallApiV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " firewall.set_service_url(endpoint)\n", " resp = firewall.set_security_level_setting(value=\"low\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/firewallapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &firewallapiv1.FirewallApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := firewallapiv1.NewFirewallApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewSetSecurityLevelSettingOptions()\n", "\topt.SetValue(firewallapiv1.SetSecurityLevelSettingOptions_Value_High)\n", "\tresult, response, err := service.SetSecurityLevelSetting(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " SetSecurityLevelSettingOptions setSecurityLevelSettingOptions = new SetSecurityLevelSettingOptions.Builder()\n", " .value(\"under_attack\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.setSecurityLevelSetting(setSecurityLevelSettingOptions).execute();\n", " SecurityLevelSettingResp securityLevelSettingRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " value: 'medium ', // Example of security-level setting\n", "};\n", "firewallApiV1.setSecurityLevelSetting(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const securityLevelSetting = result.result;\n", " console.log(JSON.stringify(securityLevelSetting, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/rate_limits": { "get": { "tags": [ "Zone Rate Limits" ], "summary": "List all rate limits", "operationId": "list_all_zone_rate_limits", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.rate-limits.read" } ] }, "description": "The details of Rate Limit for a given zone under a given service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "query", "name": "page", "description": "Page number of paginated results.", "required": false, "schema": { "type": "integer", "default": 1 } }, { "in": "query", "name": "per_page", "description": "Maximum number of rate limits per page.", "required": false, "schema": { "type": "integer", "minimum": 5, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_ratelimit_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": [ { "id": "92f17202ed8bd63d69a66b86a49a8f6b", "disabled": "false,", "description": "Prevent multiple login failures to mitigate brute force attacks", "bypass": [ { "name": "url", "value": "example.com/*" } ], "threshold": 1000, "period": 60, "correlate": { "by": "nat" }, "action": { "mode": "simulate", "timeout": 60, "response": { "content_type": "text/plain", "body": "This request has been rate-limited." } }, "match": { "request": { "methods": [ "_ALL_" ], "schemes": [ "_ALL_" ], "url": "*.example.org/path*" }, "response": { "status": [ 403 ], "headers": [ { "name": "Cf-Cache-Status", "op": "ne", "value": "HIT" } ], "origin_traffic": false } } } ], "result_info": { "page": 1, "per_page": 10, "count": 1, "total_count": 1 } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/rate_limits \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import ZoneRateLimitsV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " limit = ZoneRateLimitsV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " limit.set_service_url(endpoint)\n", " resp = limit.list_all_zone_rate_limits()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/zoneratelimitsv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &zoneratelimitsv1.ZoneRateLimitsV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := zoneratelimitsv1.NewZoneRateLimitsV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewListAllZoneRateLimitsOptions()\n", "\tresult, response, err := service.ListAllZoneRateLimits(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ListAllZoneRateLimitsOptions listAllZoneRateLimitsOptions = new ListAllZoneRateLimitsOptions.Builder()\n", " .page(Long.valueOf(\"26\"))\n", " .perPage(Long.valueOf(\"5\"))\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.listAllZoneRateLimits(listAllZoneRateLimitsOptions).execute();\n", " ListRatelimitResp listRatelimitRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const ZoneRateLimitAPI = require('ibm-networking-services/cis/zoneratelimitsv1/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "};\n", "\n", "const rateLimitApi = new ZoneRateLimitAPI(options);\n", "\n", "rateLimitApi.listAllZoneRateLimits({})\n", " .then(response => {\n", " const rateLimitList = response.result.result;\n", " console.log(rateLimitList);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "post": { "tags": [ "Zone Rate Limits" ], "summary": "Create rate limit", "operationId": "create_zone_rate_limits", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.rate-limits.create" } ] }, "description": "Create a new rate limit for a given zone under a service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ratelimit_input" } } }, "description": "Rate limit parameters." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ratelimit_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "92f17202ed8bd63d69a66b86a49a8f6b", "disabled": "false,", "description": "Prevent multiple login failures to mitigate brute force attacks", "bypass": [ { "name": "url", "value": "example.com/*" } ], "threshold": 1000, "period": 60, "correlate": { "by": "nat" }, "action": { "mode": "simulate", "timeout": 60, "response": { "content_type": "text/plain", "body": "This request has been rate-limited." } }, "match": { "request": { "methods": [ "_ALL_" ], "schemes": [ "_ALL_" ], "url": "*.example.org/path*" }, "response": { "status": [ 403 ], "headers": [ { "name": "Cf-Cache-Status", "op": "ne", "value": "HIT" } ], "origin_traffic": false } } } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/rate_limits \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "--data '{\"id\":\"372e67954025e0ba6aaa6d586b9e0b59\",\"disabled\":false,\"description\":\"Prevent multiple login failures to mitigate brute force attacks\",\"match\":{\"request\":{\"methods\":[\"GET\",\"POST\"],\"schemes\":[\"HTTP\",\"HTTPS\"],\"url\":\"*.example.org/path*\"},\"response\":{\"status\":[401,403],\"headers\":[{\"name\":\"Cf-Cache-Status\",\"op\":\"ne\",\"value\":\"HIT\"}]}},\"bypass\":[{\"name\":\"url\",\"value\":\"api.example.com/*\"}],\"threshold\":60,\"period\":900,\"action\":{\"mode\":\"challenge\",\"timeout\":86400,\"response\":{\"content_type\":\"text/xml\",\"body\":\"This request has been rate-limited.\"}}}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import ZoneRateLimitsV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " limit = ZoneRateLimitsV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " limit.set_service_url(endpoint)\n", " threshold = 40\n", " period = 2\n", " url = \"*.example.org/path*\"\n", " action = {\n", " \"mode\": \"simulate\",\n", " \"timeout\": 60,\n", " \"response\": {\n", " \"content_type\": \"text/plain\",\n", " \"body\": \"This request has been rate-limited.\"\n", " }\n", " }\n", " correlate = {\n", " \"by\": \"nat\"\n", " }\n", " match = {\n", " \"request\": {\n", " \"methods\": [\n", " \"_ALL_\"\n", " ],\n", " \"schemes\": [\n", " \"_ALL_\"\n", " ],\n", " \"url\": url\n", " }\n", " }\n", "\n", " bypass = [\n", " {\n", " \"name\": \"url\",\n", " \"value\": \"api.example.com/*\"\n", " }\n", " ]\n", " resp = limit.create_zone_rate_limits(\n", " threshold=threshold, period=period, action=action, match=match, bypass=bypass, correlate=correlate)\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/zoneratelimitsv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\turl := os.Getenv(\"URL\")\n", "\tglobalOptions := &zoneratelimitsv1.ZoneRateLimitsV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := zoneratelimitsv1.NewZoneRateLimitsV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\tactionOpt, err := service.NewRatelimitInputAction(zoneratelimitsv1.RatelimitInputAction_Mode_Simulate)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tactionOpt.Timeout = core.Int64Ptr(60)\n", "\tactionOpt.Response = &zoneratelimitsv1.RatelimitInputActionResponse{\n", "\t\tContentType: core.StringPtr(zoneratelimitsv1.RatelimitInputActionResponse_ContentType_TextPlain),\n", "\t\tBody: core.StringPtr(\"This request has been rate-limited.\"),\n", "\t}\n", "\tbypassOpt, err := service.NewRatelimitInputBypassItem(zoneratelimitsv1.RatelimitInputBypassItem_Name_URL, \"api.example.com/*\")\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tcorrelateOpt, err := service.NewRatelimitInputCorrelate(zoneratelimitsv1.RatelimitInputCorrelate_By_Nat)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tmatchReqOpt, err := service.NewRatelimitInputMatchRequest(url)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tmatchReqOpt.Methods = []string{zoneratelimitsv1.RatelimitInputMatchRequest_Methods_All}\n", "\tmatchReqOpt.Schemes = []string{zoneratelimitsv1.RatelimitInputMatchRequest_Schemes_All}\n", "\n", "\tmatchOpt := zoneratelimitsv1.RatelimitInputMatch{\n", "\t\tRequest: matchReqOpt,\n", "\t}\n", "\toptions := service.NewCreateZoneRateLimitsOptions()\n", "\toptions.SetAction(actionOpt)\n", "\toptions.SetBypass([]zoneratelimitsv1.RatelimitInputBypassItem{*bypassOpt})\n", "\toptions.SetCorrelate(correlateOpt)\n", "\toptions.SetDisabled(false)\n", "\toptions.SetMatch(&matchOpt)\n", "\toptions.SetPeriod(2)\n", "\toptions.SetThreshold(40)\n", "\tresult, response, err := service.CreateZoneRateLimits(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " RatelimitInputBypassItem ratelimitInputBypassItemModel = new RatelimitInputBypassItem.Builder()\n", " .name(\"url\")\n", " .value(\"api.example.com/*\")\n", " .build();\n", "\n", " RatelimitInputActionResponse ratelimitInputActionResponseModel = new RatelimitInputActionResponse.Builder()\n", " .contentType(\"text/plain\")\n", " .body(\"This request has been rate-limited.\")\n", " .build();\n", "\n", " RatelimitInputAction ratelimitInputActionModel = new RatelimitInputAction.Builder()\n", " .mode(\"simulate\")\n", " .timeout(Long.valueOf(\"60\"))\n", " .response(ratelimitInputActionResponseModel)\n", " .build();\n", "\n", " RatelimitInputCorrelate ratelimitInputCorrelateModel = new RatelimitInputCorrelate.Builder()\n", " .by(\"nat\")\n", " .build();\n", "\n", " RatelimitInputMatchRequest ratelimitInputMatchRequestModel = new RatelimitInputMatchRequest.Builder()\n", " .methods(new java.util.ArrayList(java.util.Arrays.asList(\"GET\")))\n", " .schemes(new java.util.ArrayList(java.util.Arrays.asList(\"HTTP\")))\n", " .url(\"*.example.org/path*\")\n", " .build();\n", "\n", " RatelimitInputMatchResponseHeadersItem ratelimitInputMatchResponseHeadersItemModel = new RatelimitInputMatchResponseHeadersItem.Builder()\n", " .name(\"Cf-Cache-Status\")\n", " .op(\"ne\")\n", " .value(\"HIT\")\n", " .build();\n", "\n", " RatelimitInputMatchResponse ratelimitInputMatchResponseModel = new RatelimitInputMatchResponse.Builder()\n", " .status(new java.util.ArrayList(java.util.Arrays.asList(Long.valueOf(\"403\"))))\n", " .headers(new java.util.ArrayList(java.util.Arrays.asList(ratelimitInputMatchResponseHeadersItemModel)))\n", " .originTraffic(false)\n", " .build();\n", "\n", " RatelimitInputMatch ratelimitInputMatchModel = new RatelimitInputMatch.Builder()\n", " .request(ratelimitInputMatchRequestModel)\n", " .response(ratelimitInputMatchResponseModel)\n", " .build();\n", "\n", " CreateZoneRateLimitsOptions createZoneRateLimitsOptions = new CreateZoneRateLimitsOptions.Builder()\n", " .disabled(false)\n", " .description(\"Prevent multiple login failures to mitigate brute force attacks\")\n", " .bypass(new java.util.ArrayList(java.util.Arrays.asList(ratelimitInputBypassItemModel)))\n", " .threshold(Long.valueOf(\"1000\"))\n", " .period(Long.valueOf(\"60\"))\n", " .action(ratelimitInputActionModel)\n", " .correlate(ratelimitInputCorrelateModel)\n", " .match(ratelimitInputMatchModel)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.createZoneRateLimits(createZoneRateLimitsOptions).execute();\n", " RatelimitResp ratelimitRespResult = response.getResult();\n", " identifier = ratelimitRespResult.getResult().getId();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "// RatelimitInputMatchRequest\n", "const matchRequestModel = {\n", " methods: ['GET'],\n", " schemes: ['HTTP'],\n", " url: `*.${DOMAIN_NAME}/${PATH}*`,\n", "};\n", "\n", "// RatelimitInputMatchResponse\n", "const matchResponseModel = {\n", " status: [403],\n", " headers: [{\n", " name: 'Cf-Cache-Status',\n", " op: 'ne',\n", " value: 'HIT',\n", " }],\n", " origin_traffic: false,\n", "};\n", "\n", "const rateLimitParams = {\n", " threshold: 5,\n", " period: 2,\n", " action: {\n", " mode: 'simulate',\n", " timeout: 60,\n", " response: {\n", " content_type: 'text/plain',\n", " body: 'This request has been rate-limited.',\n", " },\n", " },\n", " match: {\n", " request: matchRequestModel,\n", " response: matchResponseModel,\n", " },\n", " disabled: false,\n", " description: 'Prevent multiple login failures to mitigate brute force attacks',\n", "};\n", "\n", "rateLimitApi.createZoneRateLimits(rateLimitParams)\n", " .then(response => {\n", " const newRateLimit = response.result.result;\n", " console.log(newRateLimit);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/rate_limits/{rate_limit_identifier}": { "delete": { "tags": [ "Zone Rate Limits" ], "summary": "Delete rate limit", "operationId": "delete_zone_rate_limit", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.rate-limits.delete" } ] }, "description": "Delete a rate limit, given its ID.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "rate_limit_identifier", "description": "Identifier of the rate limit to be deleted.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_rate_limit_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "92f17202ed8bd63d69a66b86a49a8f6b" } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/rate_limits/:rate_limit_id \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import ZoneRateLimitsV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " limit = ZoneRateLimitsV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " limit.set_service_url(endpoint)\n", " resp = limit.delete_zone_rate_limit(\n", " rate_limit_identifier=\"8c1e3ad689a240eda9cb3914f94aa377\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/zoneratelimitsv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &zoneratelimitsv1.ZoneRateLimitsV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := zoneratelimitsv1.NewZoneRateLimitsV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewDeleteZoneRateLimitOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\tresult, response, err := service.DeleteZoneRateLimit(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " DeleteZoneRateLimitOptions deleteZoneRateLimitOptions = new DeleteZoneRateLimitOptions.Builder()\n", " .rateLimitIdentifier(identifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.deleteZoneRateLimit(deleteZoneRateLimitOptions).execute();\n", " DeleteRateLimitResp deleteRateLimitRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "rateLimitApi.deleteZoneRateLimit({\n", " rateLimitIdentifier: ${rateLimitId}, // valid rate limit id\n", "})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "get": { "tags": [ "Zone Rate Limits" ], "summary": "Get a rate limit", "operationId": "get_rate_limit", "description": "Get the details of a rate limit for a given zone under a given service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "rate_limit_identifier", "description": "Identifier of rate limit for the given zone.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ratelimit_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "92f17202ed8bd63d69a66b86a49a8f6b", "disabled": "false,", "description": "Prevent multiple login failures to mitigate brute force attacks", "bypass": [ { "name": "url", "value": "example.com/*" } ], "threshold": 1000, "period": 60, "correlate": { "by": "nat" }, "action": { "mode": "simulate", "timeout": 60, "response": { "content_type": "text/plain", "body": "This request has been rate-limited." } }, "match": { "request": { "methods": [ "_ALL_" ], "schemes": [ "_ALL_" ], "url": "*.example.org/path*" }, "response": { "status": [ 403 ], "headers": [ { "name": "Cf-Cache-Status", "op": "ne", "value": "HIT" } ], "origin_traffic": false } } } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/rate_limits/:rate_limit_id \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import ZoneRateLimitsV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " limit = ZoneRateLimitsV1.new_instance(crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " limit.set_service_url(endpoint)\n", " resp = limit.get_rate_limit(\n", " rate_limit_identifier=\"8c1e3ad689a240eda9cb3914f94aa377\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/zoneratelimitsv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &zoneratelimitsv1.ZoneRateLimitsV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := zoneratelimitsv1.NewZoneRateLimitsV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewGetRateLimitOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\tresult, response, err := service.GetRateLimit(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetRateLimitOptions getRateLimitOptions = new GetRateLimitOptions.Builder()\n", " .rateLimitIdentifier(identifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.getRateLimit(getRateLimitOptions).execute();\n", " RatelimitResp ratelimitRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "rateLimitApi.getRateLimit({\n", " rateLimitIdentifier: ${rateLimitId}, // valid rate limit id\n", "})\n", " .then(response => {\n", " const rateLimit = response.result.result;\n", " console.log(rateLimit);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "put": { "tags": [ "Zone Rate Limits" ], "summary": "Update rate limit", "operationId": "update_rate_limit", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.rate-limits.update" } ] }, "description": "Update an existing rate limit for a given zone under a service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "rate_limit_identifier", "description": "Identifier of rate limit", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ratelimit_input" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ratelimit_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "92f17202ed8bd63d69a66b86a49a8f6b", "disabled": "false,", "description": "Prevent multiple login failures to mitigate brute force attacks", "bypass": [ { "name": "url", "value": "example.com/*" } ], "threshold": 1000, "period": 60, "correlate": { "by": "nat" }, "action": { "mode": "simulate", "timeout": 60, "response": { "content_type": "text/plain", "body": "This request has been rate-limited." } }, "match": { "request": { "methods": [ "_ALL_" ], "schemes": [ "_ALL_" ], "url": "*.example.org/path*" }, "response": { "status": [ 403 ], "headers": [ { "name": "Cf-Cache-Status", "op": "ne", "value": "HIT" } ], "origin_traffic": false } } } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/rate_limits/:rate_limit_id \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "--data '{\"id\":\"372e67954025e0ba6aaa6d586b9e0b59\",\"disabled\":false,\"description\":\"Prevent multiple login failures to mitigate brute force attacks\",\"match\":{\"request\":{\"methods\":[\"GET\",\"POST\"],\"schemes\":[\"HTTP\",\"HTTPS\"],\"url\":\"*.example.org/path*\"},\"response\":{\"status\":[401,403],\"headers\":[{\"name\":\"Cf-Cache-Status\",\"op\":\"ne\",\"value\":\"HIT\"}]}},\"bypass\":[{\"name\":\"url\",\"value\":\"api.example.com/*\"}],\"threshold\":60,\"period\":900,\"action\":{\"mode\":\"challenge\",\"timeout\":86400,\"response\":{\"content_type\":\"text/xml\",\"body\":\"This request has been rate-limited.\"}}}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import ZoneRateLimitsV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " limit = ZoneRateLimitsV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " limit.set_service_url(endpoint)\n", " threshold = 40\n", " period = 2\n", " url = \"*.example.org/path*\"\n", " action = {\n", " \"mode\": \"ban\",\n", " \"timeout\": 60,\n", " \"response\": {\n", " \"content_type\": \"text/plain\",\n", " \"body\": \"This request has been rate-limited.\"\n", " }\n", " }\n", " correlate = {\n", " \"by\": \"nat\"\n", " }\n", " match = {\n", " \"request\": {\n", " \"methods\": [\n", " \"_ALL_\"\n", " ],\n", " \"schemes\": [\n", " \"_ALL_\"\n", " ],\n", " \"url\": url\n", " }\n", " }\n", "\n", " bypass = [\n", " {\n", " \"name\": \"url\",\n", " \"value\": \"api.example.com/*\"\n", " }\n", " ]\n", " resp = limit.update_rate_limit(rate_limit_identifier=\"8c1e3ad689a240eda9cb3914f94aa377\", threshold=threshold,\n", " period=period, action=action, match=match, bypass=bypass, correlate=correlate)\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/zoneratelimitsv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\turl := os.Getenv(\"URL\")\n", "\tglobalOptions := &zoneratelimitsv1.ZoneRateLimitsV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := zoneratelimitsv1.NewZoneRateLimitsV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\tactionOpt, err := service.NewRatelimitInputAction(zoneratelimitsv1.RatelimitInputAction_Mode_Simulate)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tactionOpt.Timeout = core.Int64Ptr(60)\n", "\tactionOpt.Response = &zoneratelimitsv1.RatelimitInputActionResponse{\n", "\t\tContentType: core.StringPtr(zoneratelimitsv1.RatelimitInputActionResponse_ContentType_TextPlain),\n", "\t\tBody: core.StringPtr(\"This request has been rate-limited.\"),\n", "\t}\n", "\tbypassOpt, err := service.NewRatelimitInputBypassItem(zoneratelimitsv1.RatelimitInputBypassItem_Name_URL, \"api.example.com/*\")\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tcorrelateOpt, err := service.NewRatelimitInputCorrelate(zoneratelimitsv1.RatelimitInputCorrelate_By_Nat)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tmatchReqOpt, err := service.NewRatelimitInputMatchRequest(url)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tmatchReqOpt.Methods = []string{zoneratelimitsv1.RatelimitInputMatchRequest_Methods_All}\n", "\tmatchReqOpt.Schemes = []string{zoneratelimitsv1.RatelimitInputMatchRequest_Schemes_All}\n", "\n", "\tmatchOpt := zoneratelimitsv1.RatelimitInputMatch{\n", "\t\tRequest: matchReqOpt,\n", "\t}\n", "\toptions := service.NewUpdateRateLimitOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\toptions.SetAction(actionOpt)\n", "\toptions.SetBypass([]zoneratelimitsv1.RatelimitInputBypassItem{*bypassOpt})\n", "\toptions.SetCorrelate(correlateOpt)\n", "\toptions.SetDisabled(false)\n", "\toptions.SetMatch(&matchOpt)\n", "\toptions.SetPeriod(2)\n", "\toptions.SetThreshold(40)\n", "\tresult, response, err := service.UpdateRateLimit(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " RatelimitInputBypassItem ratelimitInputBypassItemModel = new RatelimitInputBypassItem.Builder()\n", " .name(\"url\")\n", " .value(\"api.example.com/*\")\n", " .build();\n", "\n", " RatelimitInputActionResponse ratelimitInputActionResponseModel = new RatelimitInputActionResponse.Builder()\n", " .contentType(\"text/plain\")\n", " .body(\"This request has been rate-limited.\")\n", " .build();\n", "\n", " RatelimitInputAction ratelimitInputActionModel = new RatelimitInputAction.Builder()\n", " .mode(\"simulate\")\n", " .timeout(Long.valueOf(\"60\"))\n", " .response(ratelimitInputActionResponseModel)\n", " .build();\n", "\n", " RatelimitInputCorrelate ratelimitInputCorrelateModel = new RatelimitInputCorrelate.Builder()\n", " .by(\"nat\")\n", " .build();\n", "\n", " RatelimitInputMatchRequest ratelimitInputMatchRequestModel = new RatelimitInputMatchRequest.Builder()\n", " .methods(new java.util.ArrayList(java.util.Arrays.asList(\"GET\")))\n", " .schemes(new java.util.ArrayList(java.util.Arrays.asList(\"HTTP\")))\n", " .url(\"*.example.org/path*\")\n", " .build();\n", "\n", " RatelimitInputMatchResponseHeadersItem ratelimitInputMatchResponseHeadersItemModel = new RatelimitInputMatchResponseHeadersItem.Builder()\n", " .name(\"Cf-Cache-Status\")\n", " .op(\"ne\")\n", " .value(\"HIT\")\n", " .build();\n", "\n", " RatelimitInputMatchResponse ratelimitInputMatchResponseModel = new RatelimitInputMatchResponse.Builder()\n", " .status(new java.util.ArrayList(java.util.Arrays.asList(Long.valueOf(\"403\"))))\n", " .headers(new java.util.ArrayList(java.util.Arrays.asList(ratelimitInputMatchResponseHeadersItemModel)))\n", " .originTraffic(false)\n", " .build();\n", "\n", " RatelimitInputMatch ratelimitInputMatchModel = new RatelimitInputMatch.Builder()\n", " .request(ratelimitInputMatchRequestModel)\n", " .response(ratelimitInputMatchResponseModel)\n", " .build();\n", "\n", " UpdateRateLimitOptions updateRateLimitOptions = new UpdateRateLimitOptions.Builder()\n", " .rateLimitIdentifier(identifier)\n", " .disabled(false)\n", " .description(\"Prevent multiple login failures to mitigate brute force attacks\")\n", " .bypass(new java.util.ArrayList(java.util.Arrays.asList(ratelimitInputBypassItemModel)))\n", " .threshold(Long.valueOf(\"1000\"))\n", " .period(Long.valueOf(\"60\"))\n", " .action(ratelimitInputActionModel)\n", " .correlate(ratelimitInputCorrelateModel)\n", " .match(ratelimitInputMatchModel)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.updateRateLimit(updateRateLimitOptions).execute();\n", " RatelimitResp ratelimitRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "\n", "// RatelimitInputMatchRequest\n", "const matchRequestModel = {\n", " methods: ['GET'],\n", " schemes: ['HTTP'],\n", " url: `*.${DOMAIN_NAME}/${PATH}*`,\n", "};\n", "\n", "// RatelimitInputMatchResponse\n", "const matchResponseModel = {\n", " status: [403],\n", " headers: [{\n", " name: 'Cf-Cache-Status',\n", " op: 'ne',\n", " value: 'HIT',\n", " }],\n", " origin_traffic: false,\n", "};\n", "\n", "const rateLimitParams = {\n", " threshold: 15,\n", " period: 2,\n", " action: {\n", " mode: 'simulate',\n", " timeout: 60,\n", " response: {\n", " content_type: 'text/plain',\n", " body: 'This request has been rate-limited.',\n", " },\n", " },\n", " match: {\n", " request: matchRequestModel,\n", " response: matchResponseModel,\n", " },\n", " disabled: false,\n", " description: 'modified description',\n", " rateLimitIdentifier: ${rateLimitId} // valid rate limit id\n", "};\n", "\n", "rateLimitApi.updateRateLimit(rateLimitParams)\n", " .then(response => {\n", " const updatedRateLimit = response.result.result;\n", " console.log(updatedRateLimit);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/rate_limit_analytics": { "get": { "tags": [ "Zone Rate Limits" ], "summary": "Get rate limit analytics", "operationId": "get_rate_limit_analytics", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.rate-limit-analytics.read" } ] }, "description": "Get rate limit analytics for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "query", "name": "since", "description": "The beginning of the requested time frame.", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "until", "description": "The end of the requested time frame.", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "time_delta", "description": "The time interval (seconds) of each analytic's record.", "required": true, "schema": { "type": "integer", "enum": [ 60, 3600, 86400, 2592000 ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ratelimit_analytics_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/v1/{crn}/load_balancers/pools": { "get": { "tags": [ "Global Load Balancer Pool" ], "summary": "List all pools", "operationId": "list_all_load_balancer_pools", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.load-balancer-pools.read" } ] }, "description": "List all configured load balancer pools.", "parameters": [ { "$ref": "#/components/parameters/crn" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_load_balancer_pools_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": [ { "id": "17b5962d775c646f3f9725cbc7a53df4", "created_on": "2014-01-01T05:20:00.12345Z", "modified_on": "2014-01-01T05:20:00.12345Z", "description": "Primary data center - Provider XYZ", "name": "primary-dc-1", "enabled": true, "healthy": true, "monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc", "minimum_origins": 1, "check_regions": [ "WNAM" ], "origins": [ { "name": "app-server-1", "address": "0.0.0.0", "enabled": true, "healthy": true, "weight": 1, "header": { "host": [ "example.com" ] }, "disabled_at": "2014-01-01T05:20:00.12345Z", "failure_reason": "HTTP Timeout occured" } ], "notification_email": "someone@example.com" } ] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/load_balancers/pools \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import GlobalLoadBalancerPoolsV0\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " globalLoadBalancerPools = GlobalLoadBalancerPoolsV0.new_instance(\n", " crn=crn, service_name=\"cis_services\")\n", " globalLoadBalancerPools.set_service_url(endpoint)\n", " resp = globalLoadBalancerPools.list_all_load_balancer_pools().get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/globalloadbalancerpoolsv0\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tglobalOptions := &globalloadbalancerpoolsv0.GlobalLoadBalancerPoolsV0Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t}\n", "\tservice, serviceErr := globalloadbalancerpoolsv0.NewGlobalLoadBalancerPoolsV0(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewListAllLoadBalancerPoolsOptions()\n", "\tresult, response, err := service.ListAllLoadBalancerPools(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ListAllLoadBalancerPoolsOptions listAllLoadBalancerPoolsOptions = new ListAllLoadBalancerPoolsOptions();\n", " // Invoke operation\n", " Response response = service.listAllLoadBalancerPools(listAllLoadBalancerPoolsOptions).execute();\n", " ListLoadBalancerPoolsResp listLoadBalancerPoolsRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const GLBPoolAPI = require('ibm-networking-services/cis/global-load-balancer-pools/v0');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "}\n", "\n", "const glbPoolApi = new GLBPoolAPI(options);\n", "\n", "glbPoolApi.listAllLoadBalancerPools({})\n", " .then(response => {\n", " const glbPools = response.result.result;\n", " console.log(glbPools);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "post": { "tags": [ "Global Load Balancer Pool" ], "summary": "Create pool", "operationId": "create_load_balancer_pool", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.load-balancer-pools.create" } ] }, "description": "Create a new load balancer pool", "parameters": [ { "$ref": "#/components/parameters/crn" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/load_balancer_pool_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "17b5962d775c646f3f9725cbc7a53df4", "created_on": "2014-01-01T05:20:00.12345Z", "modified_on": "2014-01-01T05:20:00.12345Z", "description": "Primary data center - Provider XYZ", "name": "primary-dc-1", "enabled": true, "healthy": true, "monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc", "minimum_origins": 1, "check_regions": [ "WNAM" ], "origins": [ { "name": "app-server-1", "address": "0.0.0.0", "enabled": true, "healthy": true, "weight": 1, "header": { "host": [ "example.com" ] }, "disabled_at": "2014-01-01T05:20:00.12345Z", "failure_reason": "HTTP Timeout occured" } ], "notification_email": "someone@example.com" } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/load_balancer_pool_req" } } }, "description": "Order a load balancer pool." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/load_balancers/pools \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\n", " \"description\": \"\",\n", " \"enabled\": true,\n", " \"minimum_origins\": 1,\n", " \"monitor\": \"92859a0f6b4d3e55b953e0e29bb96338\",\n", " \"name\": \"eu-pool\",\n", " \"notification_email\": \"\",\n", " \"check_regions\": [\n", " \"EEU\"\n", " ],\n", " \"origins\": [\n", " {\n", " \"name\": \"eu-origin1\",\n", " \"address\": \"150.0.0.1\",\n", " \"enabled\": true,\n", " \"weight\": 1\n", " },\n", " {\n", " \"name\": \"eu-origin2\",\n", " \"address\": \"150.0.0.2\",\n", " \"enabled\": true,\n", " \"weight\": 1\n", " }\n", " ]\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import GlobalLoadBalancerPoolsV0\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " globalLoadBalancerPools = GlobalLoadBalancerPoolsV0.new_instance(\n", " crn=crn, service_name=\"cis_services\")\n", " globalLoadBalancerPools.set_service_url(endpoint)\n", " name = \"test-lb-pool1\"\n", " check_regions = [\"WEU\", \"ENAM\"]\n", " origins = [{\"name\": \"app-server-1\", \"address\": \"www.test.com\",\n", " \"enabled\": True, \"weight\": 0.5}]\n", " description = \"Test GLB Pool 1\"\n", " minimum_origins = 1\n", " enabled = True\n", " notification_email = \"notify@in.ibm.com\"\n", " monitor = \"bbf53e07352ba94da066eedb9be97a2b\" # sample monitor id\n", " resp = globalLoadBalancerPools.create_load_balancer_pool(\n", " name=name, check_regions=check_regions, origins=origins,\n", " description=description, minimum_origins=minimum_origins, enabled=enabled,\n", " monitor=monitor, notification_email=notification_email).get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/globalloadbalancerpoolsv0\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tglobalOptions := &globalloadbalancerpoolsv0.GlobalLoadBalancerPoolsV0Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t}\n", "\tservice, serviceErr := globalloadbalancerpoolsv0.NewGlobalLoadBalancerPoolsV0(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewCreateLoadBalancerPoolOptions()\n", "\toptions.SetName(\"test-lb-pool2\")\n", "\tregions := []string{\"WEU\", \"WNAM\"}\n", "\toptions.SetCheckRegions(regions)\n", "\torigin := &globalloadbalancerpoolsv0.LoadBalancerPoolReqOriginsItem{\n", "\t\tName: core.StringPtr(\"app-server-2\"),\n", "\t\tAddress: core.StringPtr(\"www.test1.com\"),\n", "\t\tEnabled: core.BoolPtr(true),\n", "\t}\n", "\torigins := []globalloadbalancerpoolsv0.LoadBalancerPoolReqOriginsItem{*origin}\n", "\toptions.SetOrigins(origins)\n", "\toptions.SetDescription(\"Test GLB Pool 2\")\n", "\toptions.SetMinimumOrigins(1)\n", "\toptions.SetEnabled(true)\n", "\toptions.SetNotificationEmail(\"pool@in.ibm.com\")\n", "\toptions.SetMonitor(\"2be5d4a7-78f0-4c62-a957\")\n", "\tresult, response, err := service.CreateLoadBalancerPool(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " LoadBalancerPoolReqOriginsItem loadBalancerPoolReqOriginsItemModel = new LoadBalancerPoolReqOriginsItem.Builder()\n", " .name(\"app-server-1\")\n", " .address(\"www.test.com\")\n", " .enabled(true)\n", " .build();\n", " CreateLoadBalancerPoolOptions createLoadBalancerPoolOptions = new CreateLoadBalancerPoolOptions.Builder()\n", " .name(\"primary-dc-1\")\n", " .checkRegions(new java.util.ArrayList(java.util.Arrays.asList(\"WEU\")))\n", " .origins(new java.util.ArrayList(java.util.Arrays.asList(loadBalancerPoolReqOriginsItemModel)))\n", " .description(\"Primary data center - Provider XYZ\")\n", " .minimumOrigins(Long.valueOf(\"1\"))\n", " .enabled(true)\n", " .monitor(mIdentifier)\n", " .notificationEmail(\"someone@example.com\")\n", " .build();\n", " // Invoke operation\n", " Response response = service.createLoadBalancerPool(createLoadBalancerPoolOptions).execute();\n", " LoadBalancerPoolResp loadBalancerPoolRespResult = response.getResult();\n", " identifier = loadBalancerPoolRespResult.getResult().getId();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "// LoadBalancerPoolReqOriginsItem\n", "const loadBalancerPoolReqOriginsItemModel = {\n", " name: 'app-server-1',\n", " address: '123.4.5.6',\n", " enabled: true,\n", " weight: 1,\n", "};\n", "\n", "// Construct the pool configuration params\n", "\n", "const poolConfig = {\n", " name: 'primary-dc-1',\n", " checkRegions: ['WNAM'],\n", " origins: [loadBalancerPoolReqOriginsItemModel],\n", " description: 'Primary data center - Provider XYZ',\n", " minimumOrigins: 1,\n", " enabled: true,\n", " notificationEmail: 'xyz@domain.com',\n", "};\n", "\n", "glbPoolApi.createLoadBalancerPool(poolConfig)\n", " .then(response => {\n", " const newPool = response.result.result;\n", " console.log(newPool);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/load_balancers/pools/{pool_identifier}": { "get": { "tags": [ "Global Load Balancer Pool" ], "summary": "Get pool", "operationId": "get_load_balancer_pool", "description": "Get a single configured load balancer pool.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "in": "path", "name": "pool_identifier", "description": "Pool identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/load_balancer_pool_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "17b5962d775c646f3f9725cbc7a53df4", "created_on": "2014-01-01T05:20:00.12345Z", "modified_on": "2014-01-01T05:20:00.12345Z", "description": "Primary data center - Provider XYZ", "name": "primary-dc-1", "enabled": true, "healthy": true, "monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc", "minimum_origins": 1, "check_regions": [ "WNAM" ], "origins": [ { "name": "app-server-1", "address": "0.0.0.0", "enabled": true, "healthy": true, "weight": 1, "header": { "host": [ "example.com" ] }, "disabled_at": "2014-01-01T05:20:00.12345Z", "failure_reason": "HTTP Timeout occured" } ], "notification_email": "someone@example.com" } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/load_balancers/pools/:pool_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import GlobalLoadBalancerPoolsV0\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " globalLoadBalancerPools = GlobalLoadBalancerPoolsV0.new_instance(\n", " crn=crn, service_name=\"cis_services\")\n", " globalLoadBalancerPools.set_service_url(endpoint)\n", " pool_identifier = \"ddde5a417bb303b897f6037c86e4e1da\" # sample pool id\n", " resp = globalLoadBalancerPools.get_load_balancer_pool(\n", " pool_identifier=pool_identifier).get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/globalloadbalancerpoolsv0\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tglobalOptions := &globalloadbalancerpoolsv0.GlobalLoadBalancerPoolsV0Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t}\n", "\tservice, serviceErr := globalloadbalancerpoolsv0.NewGlobalLoadBalancerPoolsV0(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewGetLoadBalancerPoolOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\tresult, response, err := service.GetLoadBalancerPool(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetLoadBalancerPoolOptions getLoadBalancerPoolOptions = new GetLoadBalancerPoolOptions.Builder()\n", " .poolIdentifier(identifier)\n", " .build();\n", " // Invoke operation\n", " Response response = service.getLoadBalancerPool(getLoadBalancerPoolOptions).execute();\n", " LoadBalancerPoolResp loadBalancerPoolRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "glbPoolApi.getLoadBalancerPool({\n", " poolIdentifier: ${poolId},\n", "})\n", " .then(response => {\n", " const poolDetails = response.result.result;\n", " console.log(poolDetails);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "delete": { "tags": [ "Global Load Balancer Pool" ], "summary": "Delete pool", "operationId": "delete_load_balancer_pool", "description": "Delete a specific configured load balancer pool.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "in": "path", "name": "pool_identifier", "description": "Pool identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_load_balancer_pool_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "17b5962d775c646f3f9725cbc7a53df4" } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/load_balancers/pools/:pool_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import GlobalLoadBalancerPoolsV0\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " globalLoadBalancerPools = GlobalLoadBalancerPoolsV0.new_instance(\n", " crn=crn, service_name=\"cis_services\")\n", " globalLoadBalancerPools.set_service_url(endpoint)\n", " pool_identifier = \"ddde5a417bb303b897f6037c86e4e1da\" # sample pool id\n", " resp = globalLoadBalancerPools.delete_load_balancer_pool(\n", " pool_identifier=pool_identifier).get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/globalloadbalancerpoolsv0\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tglobalOptions := &globalloadbalancerpoolsv0.GlobalLoadBalancerPoolsV0Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t}\n", "\tservice, serviceErr := globalloadbalancerpoolsv0.NewGlobalLoadBalancerPoolsV0(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewDeleteLoadBalancerPoolOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\tresult, response, err := service.DeleteLoadBalancerPool(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " DeleteLoadBalancerPoolOptions deleteLoadBalancerPoolOptions = new DeleteLoadBalancerPoolOptions.Builder()\n", " .poolIdentifier(identifier)\n", " .build();\n", " // Invoke operation\n", " Response response = service.deleteLoadBalancerPool(deleteLoadBalancerPoolOptions).execute();\n", " DeleteLoadBalancerPoolResp deleteLoadBalancerPoolRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "glbPoolApi.deleteLoadBalancerPool({\n", " poolIdentifier: ${poolId},\n", "})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "put": { "tags": [ "Global Load Balancer Pool" ], "summary": "Edit pool", "operationId": "edit_load_balancer_pool", "description": "Edit a specific configured load balancer pool.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "in": "path", "name": "pool_identifier", "description": "Pool identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/load_balancer_pool_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "17b5962d775c646f3f9725cbc7a53df4", "created_on": "2014-01-01T05:20:00.12345Z", "modified_on": "2014-01-01T05:20:00.12345Z", "description": "Primary data center - Provider XYZ", "name": "primary-dc-1", "enabled": true, "healthy": true, "monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc", "minimum_origins": 1, "check_regions": [ "WNAM" ], "origins": [ { "name": "app-server-1", "address": "0.0.0.0", "enabled": true, "healthy": true, "weight": 1, "header": { "host": [ "example.com" ] }, "disabled_at": "2014-01-01T05:20:00.12345Z", "failure_reason": "HTTP Timeout occured" } ], "notification_email": "someone@example.com" } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/load_balancer_pool_req" } } }, "description": "Edit a load balancer pool." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/load_balancers/pools/:pool_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\n", " \"description\": \"asia-pacific pool\",\n", " \"enabled\": true,\n", " \"minimum_origins\": 1,\n", " \"monitor\": \"92859a0f6b4d3e55b953e0e29bb96338\",\n", " \"name\": \"ap-pool\",\n", " \"notification_email\": \"admin@example.com\",\n", " \"check_regions\": [\n", " \"SEAS\"\n", " ],\n", " \"origins\": [\n", " {\n", " \"name\": \"ap-origin1\",\n", " \"address\": \"100.0.0.1\",\n", " \"enabled\": true,\n", " \"weight\": 1\n", " }\n", " ]\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import GlobalLoadBalancerPoolsV0\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " globalLoadBalancerPools = GlobalLoadBalancerPoolsV0.new_instance(\n", " crn=crn, service_name=\"cis_services\")\n", " globalLoadBalancerPools.set_service_url(endpoint)\n", " name = \"test-lb-pool12\"\n", " check_regions = [\"WEU\", \"ENAM\"]\n", " origins = [{\"name\": \"app-server-2\", \"address\": \"www.test2.com\",\n", " \"enabled\": True, \"weight\": 0.5}]\n", " description = \"Test GLB Pool 2\"\n", " minimum_origins = 1\n", " enabled = True\n", " notification_email = \"notify@in.ibm.com\"\n", " pool_identifier = \"ddde5a417bb303b897f6037c86e4e1da\" # sample pool id\n", " monitor_identifier = \"bbf53e07352ba94da066eedb9be97a2b\" # sample monitor id\n", " resp = globalLoadBalancerPools.edit_load_balancer_pool(\n", " pool_identifier=pool_identifier, name=name,\n", " check_regions=check_regions, origins=origins, description=description,\n", " minimum_origins=minimum_origins, enabled=enabled, monitor=monitor_identifier,\n", " notification_email=notification_email).get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/globalloadbalancerpoolsv0\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tglobalOptions := &globalloadbalancerpoolsv0.GlobalLoadBalancerPoolsV0Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t}\n", "\tservice, serviceErr := globalloadbalancerpoolsv0.NewGlobalLoadBalancerPoolsV0(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewEditLoadBalancerPoolOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\toptions.SetName(\"test-lb-pool2\")\n", "\tregions := []string{\"WEU\", \"WNAM\"}\n", "\toptions.SetCheckRegions(regions)\n", "\torigin := &globalloadbalancerpoolsv0.LoadBalancerPoolReqOriginsItem{\n", "\t\tName: core.StringPtr(\"app-server-2\"),\n", "\t\tAddress: core.StringPtr(\"www.test1.com\"),\n", "\t\tEnabled: core.BoolPtr(true),\n", "\t}\n", "\torigins := []globalloadbalancerpoolsv0.LoadBalancerPoolReqOriginsItem{*origin}\n", "\toptions.SetOrigins(origins)\n", "\toptions.SetDescription(\"Test GLB Pool 2\")\n", "\toptions.SetMinimumOrigins(1)\n", "\toptions.SetEnabled(true)\n", "\toptions.SetNotificationEmail(\"pool@in.ibm.com\")\n", "\toptions.SetMonitor(\"2be5d4a7-78f0-4c62-a957\")\n", "\tresult, response, err := service.EditLoadBalancerPool(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " LoadBalancerPoolReqOriginsItem loadBalancerPoolReqOriginsItemModel = new LoadBalancerPoolReqOriginsItem.Builder()\n", " .name(\"app-server-1\")\n", " .address(\"www.test.com\")\n", " .enabled(true)\n", " .build();\n", " EditLoadBalancerPoolOptions editLoadBalancerPoolOptions = new EditLoadBalancerPoolOptions.Builder()\n", " .poolIdentifier(identifier)\n", " .name(\"primary-dc-1\")\n", " .checkRegions(new java.util.ArrayList(java.util.Arrays.asList(\"WEU\")))\n", " .origins(new java.util.ArrayList(java.util.Arrays.asList(loadBalancerPoolReqOriginsItemModel)))\n", " .description(\"Primary data center - Provider XYZ\")\n", " .minimumOrigins(Long.valueOf(\"1\"))\n", " .enabled(true)\n", " .monitor(mIdentifier)\n", " .notificationEmail(\"someone@example.com\")\n", " .build();\n", " // Invoke operation\n", " Response response = service.editLoadBalancerPool(editLoadBalancerPoolOptions).execute();\n", " LoadBalancerPoolResp loadBalancerPoolRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const poolConfig = {\n", " name: 'primary-dc-1',\n", " checkRegions: ['WNAM'],\n", " description: 'Primary data center - Provider XYZ',\n", " minimumOrigins: 1,\n", " enabled: true,\n", " notificationEmail: 'xyz@domain.com',,\n", " monitor: ${healthCheckId}, // link a health check monitor to the pool\n", " poolIdentifier: ${poolId},\n", "};\n", "\n", "glbPoolApi.editLoadBalancerPool(poolConfig)\n", " .then(response => {\n", " const updatedPool = response.result.result;\n", " console.log(updatedPool);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/firewall/lockdowns": { "get": { "tags": [ "Zone Lockdown Rules" ], "summary": "List all lockdown rules", "operationId": "list_all_zone_lockown_rules", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.domain-lockdown-rules.read" } ] }, "description": "List all lockdown rules for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "query", "name": "page", "description": "Page number of paginated results.", "required": false, "schema": { "type": "integer", "default": 1 } }, { "in": "query", "name": "per_page", "description": "Maximum number of lockdown rules per page.", "required": false, "schema": { "type": "integer", "minimum": 5, "default": 20 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_lockdown_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": [ { "id": "372e67954025e0ba6aaa6d586b9e0b59", "paused": false, "description": "Restrict access to these endpoints to requests from a known IP address", "urls": [ "api.mysite.com/some/endpoint*" ], "configurations": [ { "target": "ip_range", "value": "2.2.2.0/24" } ] } ], "result_info": { "page": 1, "per_page": 25, "count": 1, "total_count": 1, "total_pages": 1 } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/lockdowns \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import ZoneLockdownV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " lockdown = ZoneLockdownV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " lockdown.set_service_url(endpoint)\n", " resp = lockdown.list_all_zone_lockown_rules()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/zonelockdownv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &zonelockdownv1.ZoneLockdownV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := zonelockdownv1.NewZoneLockdownV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewListAllZoneLockownRulesOptions()\n", "\tresult, response, err := service.ListAllZoneLockownRules(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ListAllZoneLockownRulesOptions listAllZoneLockownRulesOptions = new ListAllZoneLockownRulesOptions.Builder()\n", " .page(Long.valueOf(\"26\"))\n", " .perPage(Long.valueOf(\"5\"))\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.listAllZoneLockownRules(listAllZoneLockownRulesOptions).execute();\n", " ListLockdownResp listLockdownRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const ZoneLockdownV1 = require('ibm-networking-services/cis/zonelockdownv1/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "// Initialize the service client.\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "};\n", "\n", "const zoneLockdownV1 = new ZoneLockdownV1(options);\n", "zoneLockdownV1.listAllZoneLockownRules()\n", " .then(response => {\n", " const { result } = response || {};\n", " const zoneLockdownRules = result.result;\n", " console.log(zoneLockdownRules);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "post": { "tags": [ "Zone Lockdown Rules" ], "summary": "Create lockdown rule", "operationId": "create_zone_lockdown_rule", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.domain-lockdown-rules.create" } ] }, "description": "Create a new lockdown rule for a given zone under a service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lockdown_input" } } }, "description": "Lockdown parameters." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lockdown_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "372e67954025e0ba6aaa6d586b9e0b59", "paused": false, "description": "Restrict access to these endpoints to requests from a known IP address", "urls": [ "api.mysite.com/some/endpoint*" ], "configurations": [ { "target": "ip_range", "value": "2.2.2.0/24" } ] } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/lockdowns \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "-d '{\n", " \"urls\": [\"api.mysite.com/some/endpoint*\"],\n", " \"configurations\": [\n", " {\n", " \"id\": \"xxxxxx\"\n", " \"target\": \"ip_range\",\n", " \"value\": \"2.2.2.0/24\"\n", " }\n", " ]\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import ZoneLockdownV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " lockdown = ZoneLockdownV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " lockdown.set_service_url(endpoint)\n", " url = [\"api.mysite.com/some/endpoint*\"]\n", " config = [{\n", " \"target\": \"ip\",\n", " \"value\": \"198.51.100.4\"\n", " }]\n", " pause = True\n", " resp = lockdown.create_zone_lockdown_rule(\n", " urls=url, configurations=config, paused=pause)\n", " print(resp)\n", "\n", " resp = lockdown.create_zone_lockdown_rule(\n", " crn=crn, zone_identifier=zone_id, urls=url, configurations=config, paused=pause)\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/zonelockdownv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &zonelockdownv1.ZoneLockdownV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := zonelockdownv1.NewZoneLockdownV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\tconfig := zonelockdownv1.LockdownInputConfigurationsItem{\n", "\t\tTarget: core.StringPtr(zonelockdownv1.LockdownInputConfigurationsItem_Target_IpRange),\n", "\t\tValue: core.StringPtr(\"192.51.100.4/24\"),\n", "\t}\n", "\tconfigs := []zonelockdownv1.LockdownInputConfigurationsItem{config}\n", "\toptions := service.NewCreateZoneLockdownRuleOptions()\n", "\toptions.SetConfigurations(configs)\n", "\toptions.SetDescription(\"Lockdown rule with ip range\")\n", "\toptions.SetPaused(true)\n", "\toptions.SetUrls([]string{\"api.mysite.com/some/endpoint*\", \"api.oursite.com/some/endpoint*\"})\n", "\tresult, response, err := service.CreateZoneLockdownRule(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " LockdownInputConfigurationsItem lockdownInputConfigurationsItemModel = new LockdownInputConfigurationsItem.Builder()\n", " .target(\"ip\")\n", " .value(\"1.1.1.1\")\n", " .build();\n", "\n", " CreateZoneLockdownRuleOptions createZoneLockdownRuleOptions = new CreateZoneLockdownRuleOptions.Builder()\n", " .paused(false)\n", " .description(\"Restrict access to these endpoints to requests from a known IP address\")\n", " .urls(new java.util.ArrayList(java.util.Arrays.asList(\"api.mysite.com/some/endpoint*\")))\n", " .configurations(new java.util.ArrayList(java.util.Arrays.asList(lockdownInputConfigurationsItemModel)))\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.createZoneLockdownRule(createZoneLockdownRuleOptions).execute();\n", " LockdownResp lockdownRespResult = response.getResult();\n", " identifier = lockdownRespResult.getResult().getId();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " description: 'Creating Zone Lockdown Rule',\n", " configurations: [\n", " {\n", " id: '372e67954025e0ba6aaa6d586b9e0b50',\n", " target: 'ip_range',\n", " value: '2.0.2.0/24',\n", " },\n", " ],\n", " urls: ['api.mysite.com/some/endpoint*'],\n", " paused: false,\n", "};\n", "zoneLockdownV1.createZoneLockdownRule(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const zoneLockdownRule = result.result;\n", " console.log(JSON.stringify(zoneLockdownRule, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/firewall/lockdowns/{lockdown_rule_identifier}": { "delete": { "tags": [ "Zone Lockdown Rules" ], "summary": "Delete lockdown rule", "operationId": "delete_zone_lockdown_rule", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.domain-lockdown-rules.delete" } ] }, "description": "Delete a lockdown rule for a particular zone, given its ID.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "lockdown_rule_identifier", "description": "Identifier of the lockdown rule to be deleted.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_lockdown_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "372e67954025e0ba6aaa6d586b9e0b59" } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/lockdowns/:lockdown_rule_identifier \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import ZoneLockdownV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " lockdown = ZoneLockdownV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " lockdown.set_service_url(endpoint)\n", " resp = lockdown.delete_zone_lockdown_rule(\n", " lockdown_rule_identifier=\"6885c7b7899d481e8696579cca03808e\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/zonelockdownv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &zonelockdownv1.ZoneLockdownV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := zonelockdownv1.NewZoneLockdownV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewDeleteZoneLockdownRuleOptions(\"6885c7b7899d481e8696579cca03808e\")\n", "\tresult, response, err := service.DeleteZoneLockdownRule(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " DeleteZoneLockdownRuleOptions deleteZoneLockdownRuleOptions = new DeleteZoneLockdownRuleOptions.Builder()\n", " .lockdownRuleIdentifier(identifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.deleteZoneLockdownRule(deleteZoneLockdownRuleOptions).execute();\n", " DeleteLockdownResp deleteLockdownRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " accessruleIdentifier: ${zoneFirewallAccessRuleId},\n", "};\n", "zoneLockdownV1.deleteZoneLockdownRule(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const zoneFirewallAccessRule = result.result;\n", " console.log(JSON.stringify(zoneFirewallAccessRule, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "get": { "tags": [ "Zone Lockdown Rules" ], "summary": "Get lockdown rule", "operationId": "get_lockdown", "description": "For a given service instance, zone ID and lockdown rule ID, get the lockdown rule details.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "lockdown_rule_identifier", "description": "Identifier of lockdown rule for the given zone.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lockdown_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "372e67954025e0ba6aaa6d586b9e0b59", "paused": false, "description": "Restrict access to these endpoints to requests from a known IP address", "urls": [ "api.mysite.com/some/endpoint*" ], "configurations": [ { "target": "ip_range", "value": "2.2.2.0/24" } ] } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/lockdowns/:lockdown_rule_identifier \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import ZoneLockdownV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " lockdown = ZoneLockdownV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " lockdown.set_service_url(endpoint)\n", " resp = lockdown.get_lockdown(\n", " lockdown_rule_identifier=\"6885c7b7899d481e8696579cca03808e\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/zonelockdownv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &zonelockdownv1.ZoneLockdownV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := zonelockdownv1.NewZoneLockdownV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewGetLockdownOptions(\"6885c7b7899d481e8696579cca03808e\")\n", "\tresult, response, err := service.GetLockdown(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetLockdownOptions getLockdownOptions = new GetLockdownOptions.Builder()\n", " .lockdownRuleIdentifier(identifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.getLockdown(getLockdownOptions).execute();\n", " LockdownResp lockdownRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " lockdownRuleIdentifier: ${zoneLockdownId},\n", "};\n", "zoneLockdownV1.getLockdown(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const zoneLockdownRule = result.result;\n", " console.log(JSON.stringify(zoneLockdownRule, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "put": { "tags": [ "Zone Lockdown Rules" ], "summary": "Update lockdown rule", "operationId": "update_lockdown_rule", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.domain-lockdown-rules.update" } ] }, "description": "Update an existing lockdown rule for a given zone under a given service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "lockdown_rule_identifier", "description": "Identifier of lockdown rule", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lockdown_input" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lockdown_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "372e67954025e0ba6aaa6d586b9e0b59", "paused": false, "description": "Restrict access to these endpoints to requests from a known IP address", "urls": [ "api.mysite.com/some/endpoint*" ], "configurations": [ { "target": "ip_range", "value": "2.2.2.0/24" } ] } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/lockdowns/:lockdown_rule_identifier \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "-d '{\n", " \"urls\": [\"api.mysite.com/some/endpoint*\"],\n", " \"configurations\": [\n", " {\n", " \"target\": \"ip_range\",\n", " \"value\": \"2.2.2.0/24\"\n", " }\n", " ]\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import ZoneLockdownV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " lockdown = ZoneLockdownV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " lockdown.set_service_url(endpoint)\n", " url = [\"api.mysite.com/some/endpoint*\"]\n", " config = [{\n", " \"target\": \"ip\",\n", " \"value\": \"198.51.10.4\"\n", " }]\n", " pause = True\n", " resp = lockdown.update_lockdown_rule(\n", " lockdown_rule_identifier=\"6885c7b7899d481e8696579cca03808e\", urls=url, configurations=config, paused=pause)\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/zonelockdownv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &zonelockdownv1.ZoneLockdownV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := zonelockdownv1.NewZoneLockdownV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\tconfig := zonelockdownv1.LockdownInputConfigurationsItem{\n", "\t\tTarget: core.StringPtr(zonelockdownv1.LockdownInputConfigurationsItem_Target_IpRange),\n", "\t\tValue: core.StringPtr(\"192.51.100.4/24\"),\n", "\t}\n", "\tconfigs := []zonelockdownv1.LockdownInputConfigurationsItem{config}\n", "\toptions := service.NewUpdateLockdownRuleOptions(\"6885c7b7899d481e8696579cca03808e\")\n", "\toptions.SetConfigurations(configs)\n", "\toptions.SetDescription(\"Lockdown rule with ip range\")\n", "\toptions.SetPaused(true)\n", "\toptions.SetUrls([]string{\"api.mysite.com/some/endpoint*\", \"api.oursite.com/some/endpoint*\"})\n", "\tresult, response, err := service.UpdateLockdownRule(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " LockdownInputConfigurationsItem lockdownInputConfigurationsItemModel = new LockdownInputConfigurationsItem.Builder()\n", " .target(\"ip\")\n", " .value(\"1.2.3.4\")\n", " .build();\n", "\n", " UpdateLockdownRuleOptions updateLockdownRuleOptions = new UpdateLockdownRuleOptions.Builder()\n", " .lockdownRuleIdentifier(identifier)\n", " .paused(false)\n", " .description(\"Restrict access to these endpoints to requests from a known IP address\")\n", " .urls(new java.util.ArrayList(java.util.Arrays.asList(\"api.mysite.com/some/endpoint*\")))\n", " .configurations(new java.util.ArrayList(java.util.Arrays.asList(lockdownInputConfigurationsItemModel)))\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.updateLockdownRule(updateLockdownRuleOptions).execute();\n", " LockdownResp lockdownRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " configurations: [\n", " {\n", " id: '372e67954025e0ba6aaa6d586b9e0b50',\n", " target: 'ip_range',\n", " value: '2.0.2.0/24',\n", " },\n", " ],\n", " lockdownRuleIdentifier: ${zoneLockdownId},\n", " paused: false,\n", " urls: ['api.mysite.com/some/endpoint*'],\n", "};\n", "zoneLockdownV1.updateLockdownRule(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const zoneFirewallAccessRule = result.result;\n", " console.log(JSON.stringify(zoneFirewallAccessRule, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/firewall/waf/packages": { "get": { "tags": [ "WAF Rule Packages (DEPRECATED)" ], "summary": "List all WAF rule packages", "deprecated": true, "operationId": "list_waf_packages", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.waf-packages.read" } ] }, "description": "Get firewall packages for a zone", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "in": "query", "name": "name", "required": false, "description": "Name of the firewall package", "example": "Wordpress-rules", "schema": { "type": "string" } }, { "in": "query", "name": "page", "required": false, "description": "Page number of paginated results", "example": 1, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "in": "query", "name": "per_page", "required": false, "description": "Number of packages per page", "example": 50, "schema": { "type": "integer", "minimum": 5, "maximum": 100, "default": 50 } }, { "in": "query", "name": "order", "required": false, "description": "Field to order packages by", "example": "status", "schema": { "type": "string" } }, { "in": "query", "name": "direction", "required": false, "description": "Direction to order packages", "example": "desc", "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "match", "required": false, "description": "Whether to match all search requirements or at least one (any)", "example": "all", "schema": { "type": "string", "enum": [ "all", "any" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/waf-packages-response" }, "examples": { "response": { "value": { "result": [ { "id": "c504870194831cd12c3fc0284f294abb", "name": "OWASP ModSecurity Core Rule Set", "description": "Covers OWASP Top 10 vulnerabilities, and more.", "detection_mode": "anomaly", "zone_id": "XXX", "sensitivity": "off", "action_mode": "challenge" }, { "id": "059f5a550fffae09cbb4072edf101bd2", "name": "USER", "description": null, "zone_id": "XXX", "detection_mode": "traditional" } ], "result_info": { "page": 1, "per_page": 20, "count": 2, "total_count": 2 }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal Server Error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/waf/packages \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import WafRulePackagesApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " wafRulePackagesApi = WafRulePackagesApiV1.new_instance(\n", " crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " wafRulePackagesApi.set_service_url(endpoint)\n", " name = None\n", " page = 1\n", " per_page = 50\n", " order = \"status\"\n", " direction = \"desc\"\n", " match = \"all\"\n", " resp = wafRulePackagesApi.list_waf_packages(\n", " name=name, page=page, per_page=per_page,\n", " order=order, direction=direction, match=match).get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/wafrulepackagesapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &wafrulepackagesapiv1.WafRulePackagesApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := wafrulepackagesapiv1.NewWafRulePackagesApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewListWafPackagesOptions()\n", "\tresult, response, err := service.ListWafPackages(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ListWafPackagesOptions listWafPackagesOptions = new ListWafPackagesOptions.Builder()\n", " .page(Long.valueOf(\"1\"))\n", " .perPage(Long.valueOf(\"50\"))\n", " .order(\"status\")\n", " .direction(\"desc\")\n", " .match(\"all\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.listWafPackages(listWafPackagesOptions).execute();\n", " WafPackagesResponse wafPackagesResponseResult = response.getResult();\n", " int i = 0;\n", " while (i < wafPackagesResponseResult.getResult().size()) {\n", " if ( wafPackagesResponseResult.getResult().get(i).getDetectionMode().equals(\"anomaly\") ) {\n", " identifier = wafPackagesResponseResult.getResult().get(i).getId();\n", " break;\n", " }\n", " i++;\n", " }\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const WafRulePackagesApiV1 = require('ibm-networking-services/cis/wafrulepackagesapiv1/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "// Initialize the service client.\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "};\n", "\n", "const wafRulePackagesApiV1 = new WafRulePackagesApiV1(options);\n", "\n", "wafRulePackagesApiV1.listWafPackages()\n", " .then(response => {\n", " const { result } = response || {};\n", " const wafPackages = result.result;\n", " console.log(JSON.stringify(wafPackages, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/firewall/waf/packages/{package_id}": { "get": { "tags": [ "WAF Rule Packages (DEPRECATED)" ], "summary": "Get WAF rule package", "deprecated": true, "operationId": "get_waf_package", "description": "Get information about a single firewall package", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "in": "path", "name": "package_id", "required": true, "description": "Package ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/waf-package-response" }, "examples": { "response": { "value": { "result": { "id": "c504870194831cd12c3fc0284f294abb", "name": "OWASP ModSecurity Core Rule Set", "description": "Covers OWASP Top 10 vulnerabilities, and more.", "detection_mode": "anomaly", "zone_id": "XXX", "sensitivity": "off", "action_mode": "challenge" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal Server Error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/waf/packages/:pkg_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import WafRulePackagesApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " wafRulePackagesApi = WafRulePackagesApiV1.new_instance(\n", " crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " wafRulePackagesApi.set_service_url(endpoint)\n", " # sample package_id\n", " package_id = \"1e334934fd7ae32ad705667f8c1057aa\"\n", " resp = wafRulePackagesApi.get_waf_package(\n", " package_id=package_id).get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/wafrulegroupsapiv1\"\n", "\t\"github.com/IBM/networking-go-sdk/wafrulepackagesapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &wafrulepackagesapiv1.WafRulePackagesApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := wafrulepackagesapiv1.NewWafRulePackagesApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewGetWafPackageOptions(\"4112ba6c2974ec43886f90736968e838\")\n", "\tresult, response, err := service.GetWafPackage(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetWafPackageOptions getWafPackageOptions = new GetWafPackageOptions.Builder()\n", " .packageId(identifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.getWafPackage(getWafPackageOptions).execute();\n", " WafPackageResponse wafPackageResponseResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " packageId: ${wafRulePackageId},\n", "};\n", "wafRulePackagesApiV1.getWafPackage(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const wafRuleGroup = result.result;\n", " console.log(JSON.stringify(wafRuleGroup, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "WAF Rule Packages (DEPRECATED)" ], "summary": "Change WAF rule package package", "deprecated": true, "operationId": "update_waf_package", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.waf-packages.update" } ] }, "description": "Change the sensitivity and action for an anomaly detection type WAF rule package", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "in": "path", "name": "package_id", "required": true, "description": "Package ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "sensitivity", "action_mode" ], "properties": { "sensitivity": { "description": "The sensitivity of the firewall package.", "type": "string", "x-example": "high", "default": "high", "enum": [ "high", "medium", "low", "off" ] }, "action_mode": { "description": "The default action that will be taken for rules under the firewall package.", "type": "string", "x-example": "challenge", "default": "challenge", "enum": [ "simulate", "challenge", "block" ] } } } } }, "description": "Optional body parameters" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/waf-package-response" }, "examples": { "response": { "value": { "result": { "id": "c504870194831cd12c3fc0284f294abb", "name": "OWASP ModSecurity Core Rule Set", "description": "Covers OWASP Top 10 vulnerabilities, and more.", "detection_mode": "anomaly", "zone_id": "XXX", "sensitivity": "off", "action_mode": "challenge" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal Server Error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/waf/packages/:pkg_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{ \\\n", " \"sensitivity\": \"medium\", \\\n", " \"action_mode\": \"block\" \\\n", " }'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import WafRulePackagesApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " wafRulePackagesApi = WafRulePackagesApiV1.new_instance(\n", " crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " wafRulePackagesApi.set_service_url(endpoint)\n", " # sample package_id\n", " package_id = \"c504870194831cd12c3fc0284f294abb\"\n", " sensitivity = \"medium\"\n", " action_mode = \"block\"\n", " resp = wafRulePackagesApi.update_waf_package(\n", " package_id=package_id,\n", " sensitivity=sensitivity, action_mode=action_mode).get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/wafrulepackagesapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &wafrulepackagesapiv1.WafRulePackagesApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := wafrulepackagesapiv1.NewWafRulePackagesApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewUpdateWafPackageOptions(\"4112ba6c2974ec43886f90736968e838\")\n", "\toptions.SetActionMode(wafrulepackagesapiv1.UpdateWafPackageOptions_ActionMode_Block)\n", "\toptions.SetSensitivity(wafrulepackagesapiv1.UpdateWafPackageOptions_Sensitivity_High)\n", "\tresult, response, err := service.UpdateWafPackage(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " UpdateWafPackageOptions updateWafPackageOptions = new UpdateWafPackageOptions.Builder()\n", " .packageId(identifier)\n", " .sensitivity(\"high\")\n", " .actionMode(\"simulate\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.updateWafPackage(updateWafPackageOptions).execute();\n", " WafPackageResponse wafPackageResponseResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " packageId: wafRulePackageId,\n", " sensitivity: 'off', // Example\n", "};\n", "wafRulePackagesApiV1.updateWafPackage(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const updatedWafRuleGroup = result.result;\n", " console.log(JSON.stringify(updatedWafRuleGroup, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/pagerules/{rule_id}": { "get": { "tags": [ "Page Rules" ], "summary": "Get page rule", "operationId": "get_page_rule", "description": "Get a page rule details.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "in": "path", "name": "rule_id", "required": true, "schema": { "type": "string" }, "description": "Rule ID" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pageRules-response-without-result_info" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/pagerules/:rule_id \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import PageRuleApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " rule = PageRuleApiV1.new_instance(\n", " crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " rule.set_service_url(endpoint)\n", " resp = rule.get_page_rule(rule_id=\"70d464c2060203379122a9e44041c8f2\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/pageruleapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &pageruleapiv1.PageRuleApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := pageruleapiv1.NewPageRuleApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\n", "\toptions := service.NewGetPageRuleOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\tresult, response, err := service.GetPageRule(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetPageRuleOptions getPageRuleOptions = new GetPageRuleOptions.Builder().ruleId(identifier).build();\n", "\n", " // Invoke operation\n", " Response response = service.getPageRule(getPageRuleOptions).execute();\n", " System.out.println(response);\n", " // Validate response\n", " assertNotNull(response);\n", " assertEquals(response.getStatusCode(), 200);\n", "\n", " PageRulesResponseWithoutResultInfo pageRuleRespResult = response.getResult();\n", " assertNotNull(pageRuleRespResult);\n", " identifier = pageRuleRespResult.getResult().getId();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\", e.getStatusCode(), e.getMessage(),\n", " e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const PageRuleAPI = require('ibm-networking-services/cis/page-rule-api/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneId: ${CIS_SERVICES_ZONE_ID},\n", "}\n", "\n", "const pageRuleApi = new PageRuleAPI(options);\n", "\n", "pageRuleApi.getPageRule({\n", " ruleId: ${pageRuleId},\n", "})\n", " .then(response => {\n", " const pageRule = response.result.result;\n", " console.log(pageRule);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Page Rules" ], "summary": "Change page rule", "operationId": "change_page_rule", "description": "Change a page rule.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "in": "path", "name": "rule_id", "required": true, "schema": { "type": "string" }, "description": "Rule ID" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pageRules-patch-body" } } }, "description": "Change a page rule." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pageRules-response-without-result_info" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/pagerules/:rule_id \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "-d '{\n", " \"targets\": [\n", " {\n", " \"target\": \"url\",\n", " \"constraint\": {\n", " \"operator\": \"matches\",\n", " \"value\": \"*example.com/images/*\"\n", " }\n", " }\n", " ],\n", " \"actions\": [\n", " {\n", " \"id\": \"disable_security\"\n", " },\n", " {\n", " \"id\": \"browser_check\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"always_use_https\"\n", " },\n", " {\n", " \"id\": \"server_side_exclude\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"ssl\",\n", " \"value\": \"flexible\"\n", " },\n", " {\n", " \"id\": \"browser_cache_ttl\",\n", " \"value\": 1800\n", " },\n", " {\n", " \"id\": \"serve_stale_content\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"security_level\",\n", " \"value\": \"low\"\n", " },\n", " {\n", " \"id\": \"cache_level\",\n", " \"value\": \"basic\"\n", " },\n", " {\n", " \"id\": \"edge_cache_ttl\",\n", " \"value\": 18000\n", " },\n", " {\n", " \"id\": \"ip_geolocation\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"email_obfuscation\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"automatic_https_rewrites\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"opportunistic_encryption\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"forwarding_url\",\n", " \"value\": {\n", " \"url\": \"http://www.example.com\",\n", " \"status_code\": 301\n", " }\n", " },\n", " {\n", " \"id\": \"explicit_cache_control\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"bypass_cache_on_cookie\",\n", " \"value\": \"testCookie\"\n", " },\n", " {\n", " \"id\": \"cache_deception_armor\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"waf\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"cache_on_cookie\",\n", " \"value\": \"cacheCookie\"\n", " },\n", " {\n", " \"id\": \"disable_apps\"\n", " },\n", " {\n", " \"id\": \"disable_performance\"\n", " },\n", " {\n", " \"id\": \"host_header_override\",\n", " \"value\": \"example.com\"\n", " },\n", " {\n", " \"id\": \"minify\",\n", " \"value\": {\n", " \"html\": \"on\",\n", " \"css\": \"on\",\n", " \"js\": \"off\"\n", " }\n", " },\n", " {\n", " \"id\": \"image_load_optimization\",\n", " \"value\": \"on\"\n", " },\n", " {\n", " \"id\": \"origin_error_page_pass_thru\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"image_size_optimization\",\n", " \"value\": \"lossy\"\n", " },\n", " {\n", " \"id\": \"sort_query_string_for_cache\",\n", " \"value\": \"on\"\n", " },\n", " {\n", " \"id\": \"resolve_override\",\n", " \"value\": \"example.com\"\n", " },\n", " {\n", " \"id\": \"response_buffering\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"script_load_optimization\",\n", " \"value\": \"on\"\n", " },\n", " {\n", " \"id\": \"true_client_ip_header\",\n", " \"value\": \"on\"\n", " }\n", " ],\n", " \"priority\": 1,\n", " \"status\": \"active\"\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import PageRuleApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " rule = PageRuleApiV1.new_instance(\n", " crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " rule.set_service_url(endpoint)\n", " target = [\n", " {\n", " \"target\": \"url\",\n", " \"constraint\": {\n", " \"operator\": \"matches\",\n", " \"value\": \"ibm.sdk.example.com\"\n", " }\n", " }\n", " ]\n", " action = [\n", " {\n", " \"id\": \"disable_security\"\n", " },\n", " {\n", " \"id\": \"browser_check\",\n", " \"value\": \"off\"\n", " }\n", " ]\n", " resp = rule.change_page_rule(rule_id=\"70d464c2060203379122a9e44041c8f2\",\n", " targets=target, actions=action, priority=1, status=\"active\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/pageruleapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\turl := os.Getenv(\"URL\")\n", "\tglobalOptions := &pageruleapiv1.PageRuleApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := pageruleapiv1.NewPageRuleApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\n", "\ttargetConstraintOpt := pageruleapiv1.TargetsItemConstraint{\n", "\t\tOperator: core.StringPtr(\"matches\"),\n", "\t\tValue: &url,\n", "\t}\n", "\ttargetOpt := []pageruleapiv1.TargetsItem{\n", "\t\t{\n", "\t\t\tTarget: core.StringPtr(\"url\"),\n", "\t\t\tConstraint: &targetConstraintOpt,\n", "\t\t}}\n", "\n", "\tpageRuleItem1 := pageruleapiv1.PageRulesBodyActionsItem{\n", "\t\tID: core.StringPtr(pageruleapiv1.PageRulesBodyActionsItem_ID_DisableSecurity),\n", "\t}\n", "\tpageRuleItem2 := pageruleapiv1.PageRulesBodyActionsItem{\n", "\t\tID: core.StringPtr(pageruleapiv1.PageRulesBodyActionsItem_ID_BrowserCheck),\n", "\t\tValue: pageruleapiv1.PageRulesBodyActionsItemActionsSecurityOptions_Value_On,\n", "\t}\n", "\n", "\toptions := service.NewChangePageRuleOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\toptions.SetTargets(targetOpt)\n", "\toptions.SetActions([]pageruleapiv1.PageRulesBodyActionsItemIntf{&pageRuleItem1, &pageRuleItem2})\n", "\toptions.SetPriority(1)\n", "\toptions.SetStatus(\"active\")\n", "\tresult, response, err := service.ChangePageRule(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " actions: [\n", " {\n", " id: 'email_obfuscation',\n", " value: 'on',\n", " },\n", " ],\n", " priority: 1,\n", " ruleId: ${pageRuleId},\n", " status: 'active',\n", " targets: [{\n", " target: 'url',\n", " constraint: {\n", " operator: 'matches',\n", " value: 'sdk.example.com',\n", " },\n", " }],\n", "};\n", "\n", "pageRuleApi.changePageRule(params)\n", " .then(response => {\n", " const changedPageRule = response.result.result;\n", " console.log(changedPageRule);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "put": { "tags": [ "Page Rules" ], "summary": "Update page rule", "operationId": "update_page_rule", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.performance.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.pagerules.update" } ] }, "description": "Replace a page rule. The final rule will exactly match the data passed with this request.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "in": "path", "name": "rule_id", "required": true, "schema": { "type": "string" }, "description": "Rule ID" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pageRules-body" } } }, "description": "Replace a page rule. The final rule will exactly match the data passed with this request." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pageRules-response-without-result_info" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/pagerules/:rule_id \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "-d '{\n", " \"targets\": [\n", " {\n", " \"target\": \"url\",\n", " \"constraint\": {\n", " \"operator\": \"matches\",\n", " \"value\": \"*example.com/images/*\"\n", " }\n", " }\n", " ],\n", " \"actions\": [\n", " {\n", " \"id\": \"disable_security\"\n", " },\n", " {\n", " \"id\": \"browser_check\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"always_use_https\"\n", " },\n", " {\n", " \"id\": \"server_side_exclude\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"ssl\",\n", " \"value\": \"flexible\"\n", " },\n", " {\n", " \"id\": \"browser_cache_ttl\",\n", " \"value\": 1800\n", " },\n", " {\n", " \"id\": \"serve_stale_content\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"security_level\",\n", " \"value\": \"low\"\n", " },\n", " {\n", " \"id\": \"cache_level\",\n", " \"value\": \"basic\"\n", " },\n", " {\n", " \"id\": \"edge_cache_ttl\",\n", " \"value\": 18000\n", " },\n", " {\n", " \"id\": \"ip_geolocation\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"email_obfuscation\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"automatic_https_rewrites\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"opportunistic_encryption\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"forwarding_url\",\n", " \"value\": {\n", " \"url\": \"http://www.example.com\",\n", " \"status_code\": 301\n", " }\n", " },\n", " {\n", " \"id\": \"explicit_cache_control\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"bypass_cache_on_cookie\",\n", " \"value\": \"testCookie\"\n", " },\n", " {\n", " \"id\": \"cache_deception_armor\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"waf\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"cache_on_cookie\",\n", " \"value\": \"cacheCookie\"\n", " },\n", " {\n", " \"id\": \"disable_apps\"\n", " },\n", " {\n", " \"id\": \"disable_performance\"\n", " },\n", " {\n", " \"id\": \"host_header_override\",\n", " \"value\": \"example.com\"\n", " },\n", " {\n", " \"id\": \"minify\",\n", " \"value\": {\n", " \"html\": \"on\",\n", " \"css\": \"on\",\n", " \"js\": \"off\"\n", " }\n", " },\n", " {\n", " \"id\": \"image_load_optimization\",\n", " \"value\": \"on\"\n", " },\n", " {\n", " \"id\": \"origin_error_page_pass_thru\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"image_size_optimization\",\n", " \"value\": \"lossy\"\n", " },\n", " {\n", " \"id\": \"sort_query_string_for_cache\",\n", " \"value\": \"on\"\n", " },\n", " {\n", " \"id\": \"resolve_override\",\n", " \"value\": \"example.com\"\n", " },\n", " {\n", " \"id\": \"response_buffering\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"script_load_optimization\",\n", " \"value\": \"on\"\n", " },\n", " {\n", " \"id\": \"true_client_ip_header\",\n", " \"value\": \"on\"\n", " }\n", " ],\n", " \"priority\": 1,\n", " \"status\": \"active\"\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import PageRuleApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " rule = PageRuleApiV1.new_instance(\n", " crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " rule.set_service_url(endpoint)\n", " target = [\n", " {\n", " \"target\": \"url\",\n", " \"constraint\": {\n", " \"operator\": \"matches\",\n", " \"value\": \"sdk.example.com\"\n", " }\n", " }\n", " ]\n", " action = [\n", " {\n", " \"id\": \"disable_security\"\n", " },\n", " {\n", " \"id\": \"browser_check\",\n", " \"value\": \"off\"\n", " }\n", " ]\n", " resp = rule.update_page_rule(rule_id=\"70d464c2060203379122a9e44041c8f2\",\n", " targets=target, actions=action, priority=1, status=\"active\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/pageruleapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\turl := os.Getenv(\"URL\")\n", "\tglobalOptions := &pageruleapiv1.PageRuleApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := pageruleapiv1.NewPageRuleApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\n", "\ttargetConstraintOpt := pageruleapiv1.TargetsItemConstraint{\n", "\t\tOperator: core.StringPtr(\"matches\"),\n", "\t\tValue: &url,\n", "\t}\n", "\ttargetOpt := []pageruleapiv1.TargetsItem{\n", "\t\t{\n", "\t\t\tTarget: core.StringPtr(\"url\"),\n", "\t\t\tConstraint: &targetConstraintOpt,\n", "\t\t}}\n", "\n", "\tpageRuleItem1 := pageruleapiv1.PageRulesBodyActionsItem{\n", "\t\tID: core.StringPtr(pageruleapiv1.PageRulesBodyActionsItem_ID_DisableSecurity),\n", "\t}\n", "\tpageRuleItem2 := pageruleapiv1.PageRulesBodyActionsItem{\n", "\t\tID: core.StringPtr(pageruleapiv1.PageRulesBodyActionsItem_ID_BrowserCheck),\n", "\t\tValue: pageruleapiv1.PageRulesBodyActionsItemActionsSecurityOptions_Value_On,\n", "\t}\n", "\n", "\toptions := service.NewUpdatePageRuleOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\toptions.SetTargets(targetOpt)\n", "\toptions.SetActions([]pageruleapiv1.PageRulesBodyActionsItemIntf{&pageRuleItem1, &pageRuleItem2})\n", "\toptions.SetPriority(1)\n", "\toptions.SetStatus(\"active\")\n", "\tresult, response, err := service.UpdatePageRule(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " TargetsItemConstraint constraintOptions = new TargetsItemConstraint.Builder().operator(\"matches\").value(url)\n", " .build();\n", " TargetsItem targetsOptions = new TargetsItem.Builder().target(\"url\").constraint(constraintOptions).build();\n", "\n", " Map actionDisableSecurity = new HashMap<>();\n", " Map actionBrowserCacheTTL = new HashMap<>();\n", " actionDisableSecurity.put(\"id\", \"disable_security\");\n", " actionBrowserCacheTTL.put(\"id\", \"browser_cache_ttl\");\n", " actionBrowserCacheTTL.put(\"value\", 3600);\n", " UpdatePageRuleOptions updatePageRuleOptions = new UpdatePageRuleOptions.Builder().ruleId(identifier).priority(2)\n", " .status(\"active\").addTargets(targetsOptions).addActions(actionDisableSecurity)\n", " .addActions(actionBrowserCacheTTL).build();\n", "\n", " // Invoke operation\n", " Response response = service.updatePageRule(updatePageRuleOptions).execute();\n", " System.out.println(response);\n", " // Validate response\n", " assertNotNull(response);\n", " assertEquals(response.getStatusCode(), 200);\n", "\n", " PageRulesResponseWithoutResultInfo pageRuleRespResult = response.getResult();\n", " assertNotNull(pageRuleRespResult);\n", " identifier = pageRuleRespResult.getResult().getId();\n", " System.out.println(\"page rule id :\" + identifier);\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\", e.getStatusCode(), e.getMessage(),\n", " e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " actions: [{ id: 'disable_security' }],\n", " priority: 1,\n", " ruleId: ${pageRuleId},\n", " status: 'active',\n", " targets: [{\n", " target: 'url',\n", " constraint: {\n", " operator: 'matches',\n", " value: 'sdk.example.com',\n", " },\n", " }],\n", "};\n", "\n", "pageRuleApi.updatePageRule(params)\n", " .then(response => {\n", " const updatedPageRule = response.result.result;\n", " console.log(updatedPageRule);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "delete": { "tags": [ "Page Rules" ], "summary": "Delete page rule", "operationId": "delete_page_rule", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.performance.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.pagerules.delete" } ] }, "description": "Delete a page rule.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "in": "path", "name": "rule_id", "required": true, "schema": { "type": "string" }, "description": "Rule ID" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pageRules-delete-response" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/pagerules/:rule_id \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import PageRuleApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " rule = PageRuleApiV1.new_instance(\n", " crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " rule.set_service_url(endpoint)\n", " resp = rule.delete_page_rule(rule_id=\"70d464c2060203379122a9e44041c8f2\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/pageruleapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &pageruleapiv1.PageRuleApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := pageruleapiv1.NewPageRuleApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\n", "\toptions := service.NewDeletePageRuleOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\tresult, response, err := service.DeletePageRule(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " DeletePageRuleOptions deletePageRuleOptions = new DeletePageRuleOptions.Builder().ruleId(identifier).build();\n", "\n", " // Invoke operation\n", " Response response = service.deletePageRule(deletePageRuleOptions).execute();\n", " System.out.println(response);\n", " // Validate response\n", " assertNotNull(response);\n", " assertEquals(response.getStatusCode(), 200);\n", "\n", " PageRulesDeleteResponse pageRuleRespResult = response.getResult();\n", " assertNotNull(pageRuleRespResult);\n", " identifier = pageRuleRespResult.getResult().getId();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\", e.getStatusCode(), e.getMessage(),\n", " e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "pageRuleApi.deletePageRule({\n", " ruleId: ${pageRuleId},\n", "})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/pagerules": { "get": { "tags": [ "Page Rules" ], "summary": "List page rules", "operationId": "list_page_rules", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.performance.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.pagerules.read" } ] }, "description": "List page rules.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "in": "query", "name": "status", "required": false, "schema": { "type": "string" }, "example": "active", "description": "default value: disabled. valid values: active, disabled" }, { "in": "query", "name": "order", "required": false, "schema": { "type": "string" }, "example": "status", "description": "default value: priority. valid values: status, priority" }, { "in": "query", "name": "direction", "required": false, "schema": { "type": "string" }, "example": "desc", "description": "default value: desc. valid values: asc, desc" }, { "in": "query", "name": "match", "required": false, "schema": { "type": "string" }, "example": "all", "description": "default value: all. valid values: any, all" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pageRules-response-list-all" } } } }, "400": { "description": "Bad request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/pagerules \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import PageRuleApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " rule = PageRuleApiV1.new_instance(\n", " crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " rule.set_service_url(endpoint)\n", " resp = rule.list_page_rules()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/pageruleapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &pageruleapiv1.PageRuleApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := pageruleapiv1.NewPageRuleApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\n", "\toptions := service.NewListPageRulesOptions()\n", "\tresult, response, err := service.ListPageRules(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ListPageRulesOptions listPageRuleOptions = new ListPageRulesOptions.Builder().build();\n", "\n", " // Invoke operation\n", " Response response = service.listPageRules(listPageRuleOptions).execute();\n", " System.out.println(response);\n", " // Validate response\n", " assertNotNull(response);\n", " assertEquals(response.getStatusCode(), 200);\n", "\n", " PageRulesResponseListAll pageRuleRespResult = response.getResult();\n", " assertNotNull(pageRuleRespResult);\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\", e.getStatusCode(), e.getMessage(),\n", " e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "pageRuleApi.listPageRules({})\n", " .then(response => {\n", " const pageRuleList = response.result.result;\n", " console.log(pageRuleList);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "post": { "tags": [ "Page Rules" ], "summary": "Create page rule", "operationId": "create_page_rule", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.performance.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.pagerules.create" } ] }, "description": "Create a page rule.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pageRules-body" } } }, "description": "Add page rule body data to curl" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pageRules-response-without-result_info" } } } }, "400": { "description": "Bad request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/pagerules \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "-d '{\n", " \"targets\": [\n", " {\n", " \"target\": \"url\",\n", " \"constraint\": {\n", " \"operator\": \"matches\",\n", " \"value\": \"*example.com/images/*\"\n", " }\n", " }\n", " ],\n", " \"actions\": [\n", " {\n", " \"id\": \"disable_security\"\n", " },\n", " {\n", " \"id\": \"browser_check\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"always_use_https\"\n", " },\n", " {\n", " \"id\": \"server_side_exclude\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"ssl\",\n", " \"value\": \"flexible\"\n", " },\n", " {\n", " \"id\": \"browser_cache_ttl\",\n", " \"value\": 1800\n", " },\n", " {\n", " \"id\": \"serve_stale_content\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"security_level\",\n", " \"value\": \"low\"\n", " },\n", " {\n", " \"id\": \"cache_level\",\n", " \"value\": \"basic\"\n", " },\n", " {\n", " \"id\": \"edge_cache_ttl\",\n", " \"value\": 18000\n", " },\n", " {\n", " \"id\": \"ip_geolocation\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"email_obfuscation\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"automatic_https_rewrites\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"opportunistic_encryption\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"forwarding_url\",\n", " \"value\": {\n", " \"url\": \"http://www.example.com\",\n", " \"status_code\": 301\n", " }\n", " },\n", " {\n", " \"id\": \"explicit_cache_control\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"bypass_cache_on_cookie\",\n", " \"value\": \"testCookie\"\n", " },\n", " {\n", " \"id\": \"cache_deception_armor\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"waf\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"cache_on_cookie\",\n", " \"value\": \"cacheCookie\"\n", " },\n", " {\n", " \"id\": \"disable_apps\"\n", " },\n", " {\n", " \"id\": \"disable_performance\"\n", " },\n", " {\n", " \"id\": \"host_header_override\",\n", " \"value\": \"example.com\"\n", " },\n", " {\n", " \"id\": \"minify\",\n", " \"value\": {\n", " \"html\": \"on\",\n", " \"css\": \"on\",\n", " \"js\": \"off\"\n", " }\n", " },\n", " {\n", " \"id\": \"image_load_optimization\",\n", " \"value\": \"on\"\n", " },\n", " {\n", " \"id\": \"origin_error_page_pass_thru\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"image_size_optimization\",\n", " \"value\": \"lossy\"\n", " },\n", " {\n", " \"id\": \"sort_query_string_for_cache\",\n", " \"value\": \"on\"\n", " },\n", " {\n", " \"id\": \"resolve_override\",\n", " \"value\": \"example.com\"\n", " },\n", " {\n", " \"id\": \"response_buffering\",\n", " \"value\": \"off\"\n", " },\n", " {\n", " \"id\": \"script_load_optimization\",\n", " \"value\": \"on\"\n", " },\n", " {\n", " \"id\": \"true_client_ip_header\",\n", " \"value\": \"on\"\n", " }\n", " ],\n", " \"priority\": 1,\n", " \"status\": \"active\"\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import PageRuleApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " rule = PageRuleApiV1.new_instance(\n", " crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " rule.set_service_url(endpoint)\n", " target = [\n", " {\n", " \"target\": \"url\",\n", " \"constraint\": {\n", " \"operator\": \"matches\",\n", " \"value\": \"sdk.example.com\"\n", " }\n", " }\n", " ]\n", " action = [\n", " {\n", " \"id\": \"disable_security\"\n", " },\n", " {\n", " \"id\": \"browser_check\",\n", " \"value\": \"off\"\n", " }\n", " ]\n", " resp = rule.create_page_rule(\n", " targets=target, actions=action, priority=1, status=\"active\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/pageruleapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\turl := os.Getenv(\"URL\")\n", "\tglobalOptions := &pageruleapiv1.PageRuleApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := pageruleapiv1.NewPageRuleApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\n", "\ttargetConstraintOpt := pageruleapiv1.TargetsItemConstraint{\n", "\t\tOperator: core.StringPtr(\"matches\"),\n", "\t\tValue: &url,\n", "\t}\n", "\ttargetOpt := []pageruleapiv1.TargetsItem{\n", "\t\t{\n", "\t\t\tTarget: core.StringPtr(\"url\"),\n", "\t\t\tConstraint: &targetConstraintOpt,\n", "\t\t}}\n", "\n", "\tpageRuleItem1 := pageruleapiv1.PageRulesBodyActionsItem{\n", "\t\tID: core.StringPtr(pageruleapiv1.PageRulesBodyActionsItem_ID_DisableSecurity),\n", "\t}\n", "\tpageRuleItem2 := pageruleapiv1.PageRulesBodyActionsItem{\n", "\t\tID: core.StringPtr(pageruleapiv1.PageRulesBodyActionsItem_ID_BrowserCheck),\n", "\t\tValue: pageruleapiv1.PageRulesBodyActionsItemActionsSecurityOptions_Value_On,\n", "\t}\n", "\n", "\toptions := service.NewCreatePageRuleOptions()\n", "\toptions.SetTargets(targetOpt)\n", "\toptions.SetActions([]pageruleapiv1.PageRulesBodyActionsItemIntf{&pageRuleItem1, &pageRuleItem2})\n", "\toptions.SetPriority(1)\n", "\toptions.SetStatus(\"active\")\n", "\tresult, response, err := service.CreatePageRule(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " TargetsItemConstraint constraintOptions = new TargetsItemConstraint.Builder().operator(\"matches\").value(url)\n", " .build();\n", " TargetsItem targetsOptions = new TargetsItem.Builder().target(\"url\").constraint(constraintOptions).build();\n", "\n", " Map actionDisableSecurity = new HashMap<>();\n", " Map actionBrowserCacheTTL = new HashMap<>();\n", " actionDisableSecurity.put(\"id\", \"disable_security\");\n", " actionBrowserCacheTTL.put(\"id\", \"browser_cache_ttl\");\n", " actionBrowserCacheTTL.put(\"value\", 1800);\n", " CreatePageRuleOptions createPageRuleOptions = new CreatePageRuleOptions.Builder().priority(5).status(\"active\")\n", " .addTargets(targetsOptions).addActions(actionDisableSecurity).addActions(actionBrowserCacheTTL).build();\n", "\n", " // Invoke operation\n", " Response response = service.createPageRule(createPageRuleOptions).execute();\n", " System.out.println(response);\n", " // Validate response\n", " assertNotNull(response);\n", " assertEquals(response.getStatusCode(), 200);\n", "\n", " PageRulesResponseWithoutResultInfo pageRuleRespResult = response.getResult();\n", " assertNotNull(pageRuleRespResult);\n", " identifier = pageRuleRespResult.getResult().getId();\n", " System.out.println(\"page rule id :\" + identifier);\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\", e.getStatusCode(), e.getMessage(),\n", " e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const pageRuleConfig = {\n", " actions: [\n", " {\n", " value: 'on',\n", " id: 'browser_check',\n", " },\n", " ],\n", " priority: 1,\n", " status: 'active',\n", " targets: [{\n", " target: 'url',\n", " constraint: {\n", " operator: 'matches',\n", " value: 'sdk.example.com',\n", " },\n", " }],\n", "};\n", "\n", "pageRuleApi.createPageRule(pageRuleConfig)\n", " .then(response => {\n", " const newPageRule = response.result.result;\n", " console.log(newPageRule);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/load_balancers/monitors": { "get": { "tags": [ "Global Load Balancer Monitor" ], "summary": "List all load balancer monitors", "operationId": "list_all_load_balancer_monitors", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.load-balancer-monitors.read" } ] }, "description": "List configured load balancer monitors for a user.", "parameters": [ { "$ref": "#/components/parameters/crn" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_monitor_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result_info": { "page": 1, "per_page": 10, "count": 1, "total_count": 1 }, "result": [ { "id": "f1aba936b94213e5b8dca0c0dbf1f9cc", "created_on": "2014-01-01T05:20:00.12345Z", "modified_on": "2014-01-01T05:20:00.12345Z", "type": "http", "description": "Login page monitor", "method": "GET", "port": 8080, "path": "/", "timeout": 5, "retries": 2, "interval": 60, "expected_body": "alive", "expected_codes": "2xx", "follow_redirects": true, "allow_insecure": true, "header": { "additionalProp1": [ "test1", "test2" ], "additionalProp2": [ "test" ], "additionalProp3": [ "test" ] } } ] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/load_balancers/monitors \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import GlobalLoadBalancerMonitorV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn nd end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " globalLoadBalancerMonitor = GlobalLoadBalancerMonitorV1.new_instance(\n", " crn=crn, service_name=\"cis_services\")\n", " globalLoadBalancerMonitor.set_service_url(endpoint)\n", " resp = globalLoadBalancerMonitor.list_all_load_balancer_monitors().get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/globalloadbalancermonitorv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tglobalOptions := &globalloadbalancermonitorv1.GlobalLoadBalancerMonitorV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t}\n", "\tservice, serviceErr := globalloadbalancermonitorv1.NewGlobalLoadBalancerMonitorV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewListAllLoadBalancerMonitorsOptions()\n", "\tresult, response, err := service.ListAllLoadBalancerMonitors(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ListAllLoadBalancerMonitorsOptions listAllLoadBalancerMonitorsOptions = new ListAllLoadBalancerMonitorsOptions();\n", "\n", " // Invoke operation\n", " Response response = service.listAllLoadBalancerMonitors(listAllLoadBalancerMonitorsOptions).execute();\n", " ListMonitorResp listMonitorRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const GLBMonitorAPI = require('ibm-networking-services/cis/global-load-balancer-monitor/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "}\n", "\n", "const glbMonitorApi = new GLBMonitorAPI(options);\n", "\n", "glbMonitorApi.listAllLoadBalancerMonitors({})\n", " .then(response => {\n", " const monitorList = response.result.result;\n", " console.log(monitorList);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "post": { "tags": [ "Global Load Balancer Monitor" ], "summary": "Create load balancer monitor", "operationId": "create_load_balancer_monitor", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.load-balancer-monitors.create" } ] }, "description": "Create a load balancer monitor for a given service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/monitor_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "f1aba936b94213e5b8dca0c0dbf1f9cc", "created_on": "2014-01-01T05:20:00.12345Z", "modified_on": "2014-01-01T05:20:00.12345Z", "type": "http", "description": "Login page monitor", "method": "GET", "port": 8080, "path": "/", "timeout": 5, "retries": 2, "interval": 60, "expected_body": "alive", "expected_codes": "2xx", "follow_redirects": true, "allow_insecure": true, "header": { "additionalProp1": [ "test1", "test2" ], "additionalProp2": [ "test" ], "additionalProp3": [ "test" ] } } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/monitor_req" } } }, "description": "Create a monitor." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/load_balancers/monitors \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\n", " \"description\": \"\",\n", " \"type\": \"http\",\n", " \"interval\": 60,\n", " \"retries\": 2,\n", " \"timeout\": 5,\n", " \"expected_body\": \"\",\n", " \"expected_codes\": \"200\",\n", " \"follow_redirects\": true,\n", " \"allow_insecure\": false,\n", " \"path\": \"/status\",\n", " \"header\": {\n", " \t\"Host\": [\"www.example.com\"],\n", " \t\"X-App-ID\": [\"abc123\"]\n", " },\n", " \"method\": \"GET\"\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import GlobalLoadBalancerMonitorV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn nd end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " globalLoadBalancerMonitor = GlobalLoadBalancerMonitorV1.new_instance(\n", " crn=crn, service_name=\"cis_services\")\n", " globalLoadBalancerMonitor.set_service_url(endpoint)\n", " expected_body = \"alive\"\n", " expected_codes = \"2xx\"\n", " type = \"http\"\n", " description = \"Test LB montior1\"\n", " method = \"GET\"\n", " port = 80\n", " path = \"/auto/test\"\n", " header = {\"Host\": [\"example.com\"], \"X-App-ID\": [\"abc123\"]}\n", " timeout = 3\n", " retries = 0\n", " interval = 90\n", " follow_redirects = True\n", " allow_insecure = True\n", " resp = globalLoadBalancerMonitor.create_load_balancer_monitor(\n", " expected_codes=expected_codes, type=type,\n", " description=description, method=method, port=port,\n", " path=path, header=header, timeout=timeout, retries=retries,\n", " interval=interval, follow_redirects=follow_redirects,\n", " expected_body=expected_body, allow_insecure=allow_insecure).get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/globalloadbalancermonitorv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tglobalOptions := &globalloadbalancermonitorv1.GlobalLoadBalancerMonitorV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t}\n", "\tservice, serviceErr := globalloadbalancermonitorv1.NewGlobalLoadBalancerMonitorV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewCreateLoadBalancerMonitorOptions()\n", "\toptions.SetExpectedBody(\"alive\")\n", "\toptions.SetExpectedCodes(\"2xx\")\n", "\toptions.SetType(\"http\")\n", "\toptions.SetDescription(\"Test GLB Monitor 1\")\n", "\toptions.SetMethod(\"GET\")\n", "\toptions.SetPort(80)\n", "\toptions.SetPath(\"/auto/test\")\n", "\toptions.SetTimeout(3)\n", "\toptions.SetRetries(0)\n", "\toptions.SetInterval(90)\n", "\toptions.SetFollowRedirects(true)\n", "\toptions.SetAllowInsecure(true)\n", "\tresult, response, err := service.CreateLoadBalancerMonitor(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " CreateLoadBalancerMonitorOptions createLoadBalancerMonitorOptions = new CreateLoadBalancerMonitorOptions.Builder()\n", " .type(\"http\")\n", " .description(\"Login page monitor\")\n", " .method(\"GET\")\n", " .port(Long.valueOf(\"8080\"))\n", " .path(\"/\")\n", " .timeout(Long.valueOf(\"5\"))\n", " .retries(Long.valueOf(\"2\"))\n", " .interval(Long.valueOf(\"60\"))\n", " .expectedCodes(\"2xx\")\n", " .followRedirects(true)\n", " .expectedBody(\"alive\")\n", " .allowInsecure(true)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.createLoadBalancerMonitor(createLoadBalancerMonitorOptions).execute();\n", " MonitorResp monitorRespResult = response.getResult();\n", " identifier = monitorRespResult.getResult().getId();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "// health check monitor configuration\n", "const monitorParams = {\n", " expectedCodes: '2xx',\n", " type: 'http',\n", " description: 'test monitor creation',\n", " method: 'GET',\n", " port: 8080,\n", " path: '/',\n", " timeout: 5,\n", " retries: 2,\n", " interval: 60,\n", " followRedirects: true,\n", " expectedBody: 'alive',\n", " allowInsecure: true,\n", " header: { 'key1': ['testString'] },\n", "};\n", "\n", "glbMonitorApi.createLoadBalancerMonitor(monitorParams)\n", " .then(response => {\n", " const newHealthCheckMonitor = response.result.result;\n", " console.log(newHealthCheckMonitor);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/load_balancers/monitors/{monitor_identifier}": { "put": { "tags": [ "Global Load Balancer Monitor" ], "summary": "Edit load balancer monitor", "operationId": "edit_load_balancer_monitor", "description": "Edit porperties of an existing load balancer monitor.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "in": "path", "name": "monitor_identifier", "description": "Monitor identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/monitor_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "f1aba936b94213e5b8dca0c0dbf1f9cc", "created_on": "2014-01-01T05:20:00.12345Z", "modified_on": "2014-01-01T05:20:00.12345Z", "type": "http", "description": "Login page monitor", "method": "GET", "port": 8080, "path": "/", "timeout": 5, "retries": 2, "interval": 60, "expected_body": "alive", "expected_codes": "2xx", "follow_redirects": true, "allow_insecure": true, "header": { "additionalProp1": [ "test1", "test2" ], "additionalProp2": [ "test" ], "additionalProp3": [ "test" ] } } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/monitor_req" } } }, "description": "Edit properties" }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/load_balancers/monitors/:monitor_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\n", " \"description\": \"\",\n", " \"type\": \"http\",\n", " \"interval\": 60,\n", " \"retries\": 2,\n", " \"timeout\": 5,\n", " \"expected_body\": \"\",\n", " \"expected_codes\": \"200\",\n", " \"follow_redirects\": true,\n", " \"allow_insecure\": false,\n", " \"path\": \"/status\",\n", " \"header\": {\n", " \t\"Host\": [\"www.example.com\"],\n", " \t\"X-App-ID\": [\"abc123\"]\n", " },\n", " \"method\": \"GET\"\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import GlobalLoadBalancerMonitorV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn nd end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " globalLoadBalancerMonitor = GlobalLoadBalancerMonitorV1.new_instance(\n", " crn=crn, service_name=\"cis_services\")\n", " globalLoadBalancerMonitor.set_service_url(endpoint)\n", " monitor_id = \"1a77a18d60b5a72151503da4bc93aff9\" # sample monitor id\n", " expected_body = \"new page\"\n", " expected_codes = \"2xx\"\n", " type = \"https\"\n", " description = \"Test LB montior3\"\n", " method = \"GET\"\n", " port = 80\n", " path = \"/auto/test\"\n", " header = {\"Host\": [\"example.com\"], \"X-App-ID\": [\"abc123\"]}\n", " timeout = 3\n", " retries = 0\n", " interval = 90\n", " follow_redirects = False\n", " allow_insecure = False\n", " resp = globalLoadBalancerMonitor.edit_load_balancer_monitor(\n", " monitor_identifier=monitor_id,\n", " expected_codes=expected_codes, type=type, description=description,\n", " method=method, port=port, path=path, header=header, timeout=timeout,\n", " retries=retries, interval=interval, follow_redirects=follow_redirects,\n", " expected_body=expected_body, allow_insecure=allow_insecure).get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/globalloadbalancermonitorv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tglobalOptions := &globalloadbalancermonitorv1.GlobalLoadBalancerMonitorV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t}\n", "\tservice, serviceErr := globalloadbalancermonitorv1.NewGlobalLoadBalancerMonitorV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewEditLoadBalancerMonitorOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\toptions.SetExpectedBody(\"alive\")\n", "\toptions.SetExpectedCodes(\"2xx\")\n", "\toptions.SetType(\"http\")\n", "\toptions.SetDescription(\"Test GLB Monitor 1\")\n", "\toptions.SetMethod(\"GET\")\n", "\toptions.SetPort(80)\n", "\toptions.SetPath(\"/auto/test\")\n", "\toptions.SetTimeout(3)\n", "\toptions.SetRetries(0)\n", "\toptions.SetInterval(90)\n", "\toptions.SetFollowRedirects(true)\n", "\toptions.SetAllowInsecure(true)\n", "\tresult, response, err := service.EditLoadBalancerMonitor(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " EditLoadBalancerMonitorOptions editLoadBalancerMonitorOptions = new EditLoadBalancerMonitorOptions.Builder()\n", " .monitorIdentifier(identifier)\n", " .type(\"http\")\n", " .description(\"Login page monitor\")\n", " .method(\"GET\")\n", " .port(Long.valueOf(\"8080\"))\n", " .path(\"/\")\n", " .timeout(Long.valueOf(\"5\"))\n", " .retries(Long.valueOf(\"2\"))\n", " .interval(Long.valueOf(\"60\"))\n", " .expectedCodes(\"2xx\")\n", " .followRedirects(true)\n", " .expectedBody(\"alive\")\n", " .allowInsecure(true)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.editLoadBalancerMonitor(editLoadBalancerMonitorOptions).execute();\n", " MonitorResp monitorRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const monitorParams = {\n", " expectedCodes: '2xx',\n", " type: 'http',\n", " description: 'test monitor creation',\n", " method: 'GET',\n", " port: 8080,\n", " path: '/',\n", " timeout: 5,\n", " retries: 2,\n", " interval: 60,\n", " followRedirects: true,\n", " expectedBody: 'alive',\n", " allowInsecure: true,\n", " header: { 'key1': ['testString'] },\n", " type: 'https',\n", " monitorIdentifier: ${monitorId},\n", "};\n", "\n", "glbMonitorApi.editLoadBalancerMonitor(monitorParams)\n", " .then(response => {\n", " const UpdatedhealthCheck = response.result.result;\n", " console.log(UpdatedhealthCheck);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "delete": { "tags": [ "Global Load Balancer Monitor" ], "summary": "Delete load balancer monitor", "operationId": "delete_load_balancer_monitor", "description": "Delete a load balancer monitor.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "in": "path", "name": "monitor_identifier", "description": "Monitor identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_monitor_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "f1aba936b94213e5b8dca0c0dbf1f9cc" } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/load_balancers/monitors/:monitor_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import GlobalLoadBalancerMonitorV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, monitor id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " monitor_id = \"1a77a18d60b5a72151503da4bc93aff9\" # sample monitor id\n", " # create instance\n", " globalLoadBalancerMonitor = GlobalLoadBalancerMonitorV1.new_instance(\n", " crn=crn, service_name=\"cis_services\")\n", " globalLoadBalancerMonitor.set_service_url(endpoint)\n", " resp = globalLoadBalancerMonitor.delete_load_balancer_monitor(\n", " monitor_identifier=monitor_id).get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/globalloadbalancermonitorv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tglobalOptions := &globalloadbalancermonitorv1.GlobalLoadBalancerMonitorV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t}\n", "\tservice, serviceErr := globalloadbalancermonitorv1.NewGlobalLoadBalancerMonitorV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\tglbOpt := service.NewDeleteLoadBalancerMonitorOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\tresult, response, err := service.DeleteLoadBalancerMonitor(glbOpt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " DeleteLoadBalancerMonitorOptions deleteLoadBalancerMonitorOptions = new DeleteLoadBalancerMonitorOptions.Builder()\n", " .monitorIdentifier(identifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.deleteLoadBalancerMonitor(deleteLoadBalancerMonitorOptions).execute();\n", " DeleteMonitorResp deleteMonitorRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "glbMonitorApi.deleteLoadBalancerMonitor({\n", " monitorIdentifier: ${monitorId},\n", "})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "get": { "tags": [ "Global Load Balancer Monitor" ], "summary": "Get load balancer monitor", "operationId": "get_load_balancer_monitor", "description": "For a given service instance and load balancer monitor ID, get the monitor details.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "in": "path", "name": "monitor_identifier", "description": "Monitor identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/monitor_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "f1aba936b94213e5b8dca0c0dbf1f9cc", "created_on": "2014-01-01T05:20:00.12345Z", "modified_on": "2014-01-01T05:20:00.12345Z", "type": "http", "description": "Login page monitor", "method": "GET", "port": 8080, "path": "/", "timeout": 5, "retries": 2, "interval": 60, "expected_body": "alive", "expected_codes": "2xx", "follow_redirects": true, "allow_insecure": true, "header": { "additionalProp1": [ "test1", "test2" ], "additionalProp2": [ "test" ], "additionalProp3": [ "test" ] } } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/load_balancers/monitors/:monitor_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import GlobalLoadBalancerMonitorV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, monitor id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " monitor_id = \"bbf53e07352ba94da066eedb9be97a2b\" # sample monitor id\n", " # create instance\n", " globalLoadBalancerMonitor = GlobalLoadBalancerMonitorV1.new_instance(\n", " crn=crn, service_name=\"cis_services\")\n", " globalLoadBalancerMonitor.set_service_url(endpoint)\n", " resp = globalLoadBalancerMonitor.get_load_balancer_monitor(\n", " monitor_identifier=monitor_id).get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/globalloadbalancermonitorv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tglobalOptions := &globalloadbalancermonitorv1.GlobalLoadBalancerMonitorV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t}\n", "\tservice, serviceErr := globalloadbalancermonitorv1.NewGlobalLoadBalancerMonitorV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\tglbOpt := service.NewGetLoadBalancerMonitorOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\tresult, response, err := service.GetLoadBalancerMonitor(glbOpt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetLoadBalancerMonitorOptions getLoadBalancerMonitorOptions = new GetLoadBalancerMonitorOptions.Builder()\n", " .monitorIdentifier(identifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.getLoadBalancerMonitor(getLoadBalancerMonitorOptions).execute();\n", " MonitorResp monitorRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "glbMonitorApi.getLoadBalancerMonitor({\n", " monitorIdentifier: ${monitorId},\n", "})\n", " .then(response => {\n", " const healthCheck = response.result.result;\n", " console.log(healthCheck);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/load_balancers/regions": { "get": { "tags": [ "Load balancers regions" ], "summary": "List all load balancer regions.", "operationId": "list_all_load_balancer_regions", "description": "List available load balancer regions for a user.", "parameters": [ { "in": "path", "name": "crn", "x-sdk-global-param": true, "description": "Full CRN of the service instance.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/load_balancer_regions_response" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unathorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/load_balancers/regions \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v1/{crn}/load_balancers/regions/{region_id}": { "get": { "tags": [ "Load balancers regions" ], "summary": "List load balancer region by region id.", "operationId": "list_load_balancer_region_by_id", "description": "List available load balancer regions by id for a user.", "parameters": [ { "in": "path", "name": "crn", "x-sdk-global-param": true, "description": "Full CRN of the service instance.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "region_id", "description": "Region identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/load_balancer_regions_response" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unathorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/load_balancers/regions/:region_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v1/{crn}/zones": { "get": { "tags": [ "Zones" ], "summary": "List all zones", "operationId": "list_zones", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.zones.read" } ] }, "description": "List all zones for a service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "in": "query", "name": "page", "description": "Page number of paginated results.", "required": false, "schema": { "type": "integer", "default": 1 } }, { "in": "query", "name": "per_page", "description": "Maximum number of zones per page.", "required": false, "schema": { "type": "integer", "default": 20, "minimum": 5, "maximum": 1000 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_zones_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result_info": { "page": 1, "per_page": 20, "count": 1, "total_count": 200 }, "result": [ { "id": "f1aba936b94213e5b8dca0c0dbf1f9cc", "created_on": "2014-01-01T05:20:00.12345Z", "modified_on": "2014-01-01T05:20:00.12345Z", "name": "test-example.com", "original_registrar": "GoDaddy", "original_dnshost": "NameCheap", "status": "active", "paused": false, "original_name_servers": [ "ns1.originaldnshost.com" ], "name_servers": [ "ns001.name.cloud.ibm.com" ] } ] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import ZonesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " zones = ZonesV1.new_instance(\n", " crn=crn, service_name=\"cis_services\")\n", " zones.set_service_url(endpoint)\n", " resp = zones.list_zones()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/zonesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tglobalOptions := &zonesv1.ZonesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t}\n", "\tservice, serviceErr := zonesv1.NewZonesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewListZonesOptions()\n", "\tresult, response, err := service.ListZones(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ListZonesOptions listZonesOptions = new ListZonesOptions();\n", "\n", " // Invoke operation\n", " Response response = service.listZones(listZonesOptions).execute();\n", " ListZonesResp listZonesRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const ZonesV1 = require('ibm-networking-services/cis/zonesv1/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "// Initialize the service client.\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "};\n", "\n", "const zonesV1 = new ZonesV1(options);\n", "\n", "zonesV1.listZones()\n", " .then(response => {\n", " const { result } = response || {};\n", " const zones = result.result;\n", " console.log(JSON.stringify(zones, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "post": { "tags": [ "Zones" ], "summary": "Create zone", "operationId": "create_zone", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.zones.create" } ] }, "description": "Add a new zone for a given service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "f1aba936b94213e5b8dca0c0dbf1f9cc", "created_on": "2014-01-01T05:20:00.12345Z", "modified_on": "2014-01-01T05:20:00.12345Z", "name": "test-example.com", "original_registrar": "GoDaddy", "original_dnshost": "NameCheap", "status": "active", "paused": false, "original_name_servers": [ "ns1.originaldnshost.com" ], "name_servers": [ "ns001.name.cloud.ibm.com" ] } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_input" } } }, "description": "Create a zone." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "-d '{\n", " \"name\": \"example.com\"\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import ZonesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " zones = ZonesV1.new_instance(\n", " crn=crn, service_name=\"cis_services\")\n", " zones.set_service_url(endpoint)\n", " name = \"alpha1.example.com\" # A record sample name\n", " resp = zones.create_zone(name=name)\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/zonesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tglobalOptions := &zonesv1.ZonesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t}\n", "\tservice, serviceErr := zonesv1.NewZonesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewCreateZoneOptions()\n", "\toptions.SetName(\"Test zone\")\n", "\tresult, response, err := service.CreateZone(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " CreateZoneOptions createZoneOptions = new CreateZoneOptions.Builder()\n", " .name(\"test-example.com\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.createZone(createZoneOptions).execute();\n", " ZoneResp zoneRespResult = response.getResult();\n", " identifier = zoneRespResult.getResult().getId();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " name: ${zoneName},\n", "};\n", "zonesV1.createZone(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const zoneCreated = result.result;\n", " console.log(JSON.stringify(zoneCreated, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}": { "delete": { "tags": [ "Zones" ], "summary": "Delete zone", "operationId": "delete_zone", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.reliability.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.zones.delete" } ] }, "description": "Delete a zone, given its ID.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_zone_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "f1aba936b94213e5b8dca0c0dbf1f9cc" } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import ZonesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " zones = ZonesV1.new_instance(\n", " crn=crn, service_name=\"cis_services\")\n", " zones.set_service_url(endpoint)\n", " zone_id = \"54sghdhartert2423sfwtgager\"\n", " resp = zones.delete_zone(zone_identifier=zone_id)\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/zonesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tglobalOptions := &zonesv1.ZonesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t}\n", "\tservice, serviceErr := zonesv1.NewZonesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewDeleteZoneOptions(\"54abcdefaabdea56adec\")\n", "\tresult, response, err := service.DeleteZone(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " DeleteZoneOptions deleteZoneOptions = new DeleteZoneOptions.Builder()\n", " .zoneIdentifier(identifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.deleteZone(deleteZoneOptions).execute();\n", " DeleteZoneResp deleteZoneRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " zoneIdentifier: ${zoneId},\n", "};\n", "zonesV1.deleteZone(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const deletedZone = result.result;\n", " console.log(JSON.stringify(deletedZone, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "get": { "tags": [ "Zones" ], "summary": "Get zone", "operationId": "get_zone", "description": "Get the details of a zone for a given service instance and given zone ID.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "f1aba936b94213e5b8dca0c0dbf1f9cc", "created_on": "2014-01-01T05:20:00.12345Z", "modified_on": "2014-01-01T05:20:00.12345Z", "name": "test-example.com", "original_registrar": "GoDaddy", "original_dnshost": "NameCheap", "status": "active", "paused": false, "original_name_servers": [ "ns1.originaldnshost.com" ], "name_servers": [ "ns001.name.cloud.ibm.com" ] } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import ZonesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " zones = ZonesV1.new_instance(\n", " crn=crn, service_name=\"cis_services\")\n", " zones.set_service_url(endpoint)\n", " zone_id = \"54abcdefaabdea56adec\"\n", " resp = zones.get_zone(zone_identifier=zone_id)\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/zonesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tglobalOptions := &zonesv1.ZonesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t}\n", "\tservice, serviceErr := zonesv1.NewZonesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewGetZoneOptions(\"54abcdefaabdea56adec\")\n", "\tresult, response, err := service.GetZone(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetZoneOptions getZoneOptions = new GetZoneOptions.Builder()\n", " .zoneIdentifier(identifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.getZone(getZoneOptions).execute();\n", " ZoneResp zoneRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " zoneIdentifier: ${zoneId},\n", "};\n", "zonesV1.getZone(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const zone = result.result;\n", " console.log(JSON.stringify(zone, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "patch": { "tags": [ "Zones" ], "summary": "Update zone", "operationId": "update_zone", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.reliability.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.zones.update" } ] }, "description": "Update the paused field of the zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "f1aba936b94213e5b8dca0c0dbf1f9cc", "created_on": "2014-01-01T05:20:00.12345Z", "modified_on": "2014-01-01T05:20:00.12345Z", "name": "test-example.com", "original_registrar": "GoDaddy", "original_dnshost": "NameCheap", "status": "active", "paused": false, "original_name_servers": [ "ns1.originaldnshost.com" ], "name_servers": [ "ns001.name.cloud.ibm.com" ] } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_update_input" } } }, "description": "Update a zone's paused field." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "-d '{\n", " \"paused\":true\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import ZonesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " zones = ZonesV1.new_instance(\n", " crn=crn, service_name=\"cis_services\")\n", " zones.set_service_url(endpoint)\n", " zone_id = \"5abcd34fabcdaeaf\"\n", " resp = zones.update_zone(zone_identifier=zone_id, paused=True)\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/zonesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tglobalOptions := &zonesv1.ZonesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t}\n", "\tservice, serviceErr := zonesv1.NewZonesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewUpdateZoneOptions(\"54abcdefaabdea56adec\")\n", "\toptions.SetPaused(true)\n", "\toptions.SetZoneIdentifier(os.Getenv(\"ZONE_ID\"))\n", "\tresult, response, err := service.UpdateZone(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " UpdateZoneOptions updateZoneOptions = new UpdateZoneOptions.Builder()\n", " .zoneIdentifier(identifier)\n", " .paused(true)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.updateZone(updateZoneOptions).execute();\n", " ZoneResp zoneRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " paused: true,\n", " zoneIdentifier: ${zoneId},\n", "};\n", "zonesV1.updateZone(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const updatedZone = result.result;\n", " console.log(JSON.stringify(updatedZone, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/activation_check": { "put": { "tags": [ "Zones" ], "summary": "Check zone", "operationId": "zone_activation_check", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.reliability.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.zones-activation-check.update" } ] }, "description": "Perform activation check on zone for status", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_activationcheck_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/activation_check \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import ZonesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " zones = ZonesV1.new_instance(\n", " crn=crn, service_name=\"cis_services\")\n", " zones.set_service_url(endpoint)\n", " resp = zones.zone_activation_check(zone_identifier=\"54abcdefaabdea56adec\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/zonesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tglobalOptions := &zonesv1.ZonesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t}\n", "\tservice, serviceErr := zonesv1.NewZonesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewZoneActivationCheckOptions(\"54abcdefaabdea56adec\")\n", "\tresult, response, err := service.ZoneActivationCheck(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ZoneActivationCheckOptions zoneActivationCheckOptions = new ZoneActivationCheckOptions.Builder()\n", " .zoneIdentifier(identifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.zoneActivationCheck(zoneActivationCheckOptions).execute();\n", " ZoneActivationcheckResp zoneActivationcheckRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " zoneIdentifier: ${zoneId},\n", "};\n", "zonesV1.zoneActivationCheck(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const zoneActivationCheck = result.result;\n", " console.log(JSON.stringify(zoneActivationCheck, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/firewall/access_rules/rules": { "get": { "tags": [ "Instance Level Firewall Access Rules" ], "summary": "List instance level firewall access rules", "operationId": "list_all_account_access_rules", "description": "List all instance level firewall access rules.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "in": "query", "name": "notes", "description": "Search access rules by note.(Not case sensitive)", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "mode", "description": "Search access rules by mode.", "required": false, "example": "block", "schema": { "type": "string", "enum": [ "block", "challenge", "whitelist", "js_challenge" ] } }, { "in": "query", "name": "configuration.target", "description": "Search access rules by configuration target", "required": false, "example": "ip", "schema": { "type": "string", "enum": [ "ip", "ip_range", "asn", "country" ] } }, { "in": "query", "name": "configuration.value", "description": "Search access rules by configuration value which can be IP, IPrange, or country code", "required": false, "example": "1.2.3.4", "schema": { "type": "string" } }, { "in": "query", "name": "page", "description": "Page number of paginated results.", "required": false, "schema": { "type": "integer", "default": 1 } }, { "in": "query", "name": "per_page", "description": "Maximum number of access rules per page.", "required": false, "schema": { "type": "integer", "minimum": 5, "default": 20 } }, { "in": "query", "name": "order", "description": "Field by which to order list of access rules.", "required": false, "schema": { "type": "string", "enum": [ "target", "value", "mode" ] } }, { "in": "query", "name": "direction", "description": "Direction in which to order results [ascending/descending order].", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "in": "query", "name": "match", "description": "Whether to match all (all) or atleast one search parameter (any).", "required": false, "schema": { "type": "string", "enum": [ "any", "all" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_account_access_rules_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": [ { "id": "92f17202ed8bd63d69a66b86a49a8f6b", "notes": "This rule is set because of an event that occurred and caused X.", "allowed_modes": [ "whitelist", "block", "challenge", "js_challenge" ], "mode": "block", "scope": { "type": "organization" }, "created_on": "2018-10-10T23:30:36.667Z", "modified_on": "2018-10-10T23:30:36.662Z", "configuration": { "target": "ip", "value": "192.168.1.100" } } ], "result_info": { "page": 1, "per_page": 25, "total_pages": 1, "count": 1, "total_count": 1 } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/firewall/access_rules/rules \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import FirewallAccessRulesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " rule = FirewallAccessRulesV1.new_instance(crn=crn, service_name=\"cis_services\")\n", " rule.set_service_url(endpoint)\n", " resp = rule.list_all_account_access_rules()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/firewallaccessrulesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tglobalOptions := &firewallaccessrulesv1.FirewallAccessRulesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t}\n", "\tservice, serviceErr := firewallaccessrulesv1.NewFirewallAccessRulesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\tresult, response, err := service.ListAllAccountAccessRules(service.NewListAllAccountAccessRulesOptions())\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " ListAllAccountAccessRulesOptions listAllAccountAccessRulesOptions = new ListAllAccountAccessRulesOptions.Builder()\n", " .notes(\"testString\")\n", " .mode(\"block\")\n", " .configurationTarget(\"ip\")\n", " .configurationValue(\"1.2.3.4\")\n", " .page(Long.valueOf(\"26\"))\n", " .perPage(Long.valueOf(\"5\"))\n", " .order(\"target\")\n", " .direction(\"asc\")\n", " .match(\"any\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.listAllAccountAccessRules(listAllAccountAccessRulesOptions).execute();'\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const FirewallAccessRulesV1 = require('ibm-networking-services/cis/firewallaccessrulesv1/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "// Initialize the service client.\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "};\n", "\n", "const firewallAccessRulesV1 = new FirewallAccessRulesV1(options);\n", "\n", "firewallAccessRulesV1.listAllAccountAccessRules()\n", " .then(response => {\n", " const acccountAccessRules = result.result;\n", " console.log(acccountAccessRules);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "post": { "tags": [ "Instance Level Firewall Access Rules" ], "summary": "Create instance level firewall access rule", "operationId": "create_account_access_rule", "description": "Create a new instance level firewall access rule for a given service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_access_rule_input" } } }, "description": "Access rule parameters." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_access_rule_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "92f17202ed8bd63d69a66b86a49a8f6b", "notes": "This rule is added because of event X that occurred on date xyz", "allowed_modes": [ "whitelist", "block", "challenge", "js_challenge" ], "mode": "block", "scope": { "type": "organization" }, "created_on": "2018-10-10T23:30:36.667Z", "modified_on": "2018-10-10T23:30:36.662Z", "configuration": { "target": "ip", "value": "192.168.1.100" } } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/firewall/access_rules/rules \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " --data '{ \\\n", " \"mode\": \"block\", \\\n", " \"notes\": \"This rule is added because of event X that occurred on date xyz\", \\\n", " \"configuration\": { \\\n", " \"target\": \"ip\", \\\n", " \"value\": \"192.168.1.100\" \\\n", " } \\\n", " }'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import FirewallAccessRulesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # input variables\n", " notes = \"This rule is added because of event X that occurred on date xyz\"\n", " mode = \"block\"\n", " configuration = {\n", " \"target\": \"ip\",\n", " \"value\": \"192.168.1.45\"\n", " }\n", " # create instance\n", " rule = FirewallAccessRulesV1.new_instance(crn=crn, service_name=\"cis_services\")\n", " rule.set_service_url(endpoint)\n", " resp = rule.create_account_access_rule(mode=mode, configuration=configuration, notes=notes)\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/firewallaccessrulesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tglobalOptions := &firewallaccessrulesv1.FirewallAccessRulesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t}\n", "\tservice, serviceErr := firewallaccessrulesv1.NewFirewallAccessRulesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewCreateAccountAccessRuleOptions()\n", "\toptions.SetMode(firewallaccessrulesv1.AccountAccessRuleObject_AllowedModes_Block)\n", "\tconfigOpt, err := service.NewAccountAccessRuleInputConfiguration(firewallaccessrulesv1.AccountAccessRuleInputConfiguration_Target_Ip, \"172.168.1.1\")\n", "\toptions.SetConfiguration(configOpt)\n", "\toptions.SetNotes(\"This rule is added because of event X that occurred on date xyz\")\n", "\t// create account access rule\n", "\tresult, response, err := service.CreateAccountAccessRule(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " AccountAccessRuleInputConfiguration accountAccessRuleInputConfigurationModel = new AccountAccessRuleInputConfiguration.Builder()\n", " .target(\"ip\")\n", " .value(\"198.51.100.4\")\n", " .build();\n", "\n", " CreateAccountAccessRuleOptions createAccountAccessRuleOptions = new CreateAccountAccessRuleOptions.Builder()\n", " .mode(\"block\")\n", " .notes(\"This rule is added because of event X that occurred on date xyz\")\n", " .configuration(accountAccessRuleInputConfigurationModel)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.createAccountAccessRule(createAccountAccessRuleOptions).execute();'\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " mode: 'block',\n", " notes: 'This rule is added because of event X that occurred on date xyz',\n", " configuration: {\n", " target: 'ip',\n", " value: '192.169.1.100',\n", " },\n", "};\n", "\n", "firewallAccessRulesV1.createAccountAccessRule(params)\n", " .then(response => {\n", " const accountAccessRule = result.result;\n", " console.log(JSON.stringify(accountAccessRule, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/firewall/access_rules/rules/{accessrule_identifier}": { "delete": { "tags": [ "Instance Level Firewall Access Rules" ], "summary": "Delete instance level access rule", "operationId": "delete_account_access_rule", "description": "Delete an instance level access rule, given its ID.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "in": "path", "name": "accessrule_identifier", "description": "Identifier of the access rule to be deleted.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_account_access_rule_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "f1aba936b94213e5b8dca0c0dbf1f9cc" } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/firewall/access_rules/rules/:rule_id \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import FirewallAccessRulesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " rule = FirewallAccessRulesV1.new_instance(crn=crn, service_name=\"cis_services\")\n", " rule.set_service_url(endpoint)\n", " resp = rule.delete_account_access_rule(accessrule_identifier=\"99469d78a1024d7cb95209fa151537d3\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/firewallaccessrulesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tglobalOptions := &firewallaccessrulesv1.FirewallAccessRulesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t}\n", "\tservice, serviceErr := firewallaccessrulesv1.NewFirewallAccessRulesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\tfmt.Println(serviceErr)\n", "\t\treturn\n", "\t}\n", "\n", "\t// delete zone access rule\n", "\tdeleteOpt := service.NewDeleteAccountAccessRuleOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\tdelResult, response, err := service.DeleteAccountAccessRule(deleteOpt)\n", "\tif err != nil {\n", "\t\tfmt.Println(\"Error!\")\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*delResult.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " DeleteAccountAccessRuleOptions deleteAccountAccessRuleOptions = new DeleteAccountAccessRuleOptions.Builder()\n", " .accessruleIdentifier(identifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.deleteAccountAccessRule(deleteAccountAccessRuleOptions).execute();\n", "\n", " DeleteAccountAccessRuleResp deleteAccountAccessRuleRespResult = response.getResult();\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " accessruleIdentifier: ${firewallAccessRuleId},\n", "};\n", "\n", "firewallAccessRulesV1.deleteAccountAccessRule(params)\n", " .then(response => {\n", " console.log(JSON.stringify(result, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "get": { "tags": [ "Instance Level Firewall Access Rules" ], "summary": "Get instance level firewall access rule", "operationId": "get_account_access_rule", "description": "Get the details of an instance level firewall access rule for a given service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "in": "path", "name": "accessrule_identifier", "description": "Identifier of firewall access rule for the given zone.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_access_rule_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "92f17202ed8bd63d69a66b86a49a8f6b", "notes": "This rule is set because of an event that occurred and caused X.", "allowed_modes": [ "whitelist", "block", "challenge", "js_challenge" ], "mode": "block", "scope": { "type": "organization" }, "created_on": "2018-10-10T23:30:36.667Z", "modified_on": "2018-10-10T23:30:36.662Z", "configuration": { "target": "ip", "value": "192.168.1.100" } } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/firewall/access_rules/rules/:rule_id \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import FirewallAccessRulesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " rule = FirewallAccessRulesV1.new_instance(crn=crn, service_name=\"cis_services\")\n", " rule.set_service_url(endpoint)\n", " resp = rule.get_account_access_rule(accessrule_identifier=\"99469d78a1024d7cb95209fa151537d3\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/firewallaccessrulesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tglobalOptions := &firewallaccessrulesv1.FirewallAccessRulesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t}\n", "\tservice, serviceErr := firewallaccessrulesv1.NewFirewallAccessRulesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\tfmt.Println(serviceErr)\n", "\t\treturn\n", "\t}\n", "\t// get account access rule\n", "\tgetOption := service.NewGetAccountAccessRuleOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\tresult, response, err := service.GetAccountAccessRule(getOption)\n", "\tif err != nil {\n", "\t\tfmt.Println(\"Error!\")\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " GetAccountAccessRuleOptions getAccountAccessRuleOptions = new GetAccountAccessRuleOptions.Builder()\n", " .accessruleIdentifier(identifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.getAccountAccessRule(getAccountAccessRuleOptions).execute();\n", "\n", " AccountAccessRuleResp accountAccessRuleRespResult = response.getResult();\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " accessruleIdentifier: ${firewallAccessRuleId},\n", "};\n", "\n", "firewallAccessRulesV1.deleteAccountAccessRule(params)\n", " .then(response => {\n", " console.log(JSON.stringify(result, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Instance Level Firewall Access Rules" ], "summary": "Update instance level firewall access rule", "operationId": "update_account_access_rule", "description": "Update an existing instance level firewall access rule for a given service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "in": "path", "name": "accessrule_identifier", "description": "Identifier of firewall access rule", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_access_rule_update_input" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_access_rule_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "92f17202ed8bd63d69a66b86a49a8f6b", "notes": "This rule is added because of event X that occurred on date xy", "allowed_modes": [ "whitelist", "block", "challenge", "js_challenge" ], "mode": "block", "scope": { "type": "organization" }, "created_on": "2018-10-10T23:30:36.667Z", "modified_on": "2018-10-10T23:30:36.662Z", "configuration": { "target": "ip", "value": "192.168.1.100" } } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/firewall/access_rules/rules/:rule_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " --data '{ \\\n", " \"mode\": \"block\", \\\n", " \"notes\": \"This rule is added because of event X that occurred on date xyz\" \\\n", " }'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import FirewallAccessRulesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # input variables\n", " notes = \"This rule is added because of event X that occurred on date xyz\"\n", " mode = \"challenge\"\n", " configuration = {\n", " \"target\": \"ip\",\n", " \"value\": \"192.168.2.44\"\n", " }\n", " # create instance\n", " rule = FirewallAccessRulesV1.new_instance(crn=crn, service_name=\"cis_services\")\n", " rule.set_service_url(endpoint)\n", " resp = rule.update_account_access_rule(accessrule_identifier=\"99469d78a1024d7cb95209fa151537d3\", mode=mode, configuration=configuration, notes=notes)\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/firewallaccessrulesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tglobalOptions := &firewallaccessrulesv1.FirewallAccessRulesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t}\n", "\tservice, serviceErr := firewallaccessrulesv1.NewFirewallAccessRulesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\t// update account access rule\n", "\toptions := service.NewUpdateAccountAccessRuleOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\toptions.SetMode(firewallaccessrulesv1.UpdateAccountAccessRuleOptions_Mode_Challenge)\n", "\toptions.SetNotes(\"This rule is added because of event X that occurred on date xyz\")\n", "\tresult, response, err := service.UpdateAccountAccessRule(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " UpdateAccountAccessRuleOptions updateAccountAccessRuleOptions = new UpdateAccountAccessRuleOptions.Builder()\n", " .accessruleIdentifier(identifier)\n", " .mode(\"whitelist\")\n", " .notes(\"This rule is added because of event X that occurred on date xyz, updated\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.updateAccountAccessRule(updateAccountAccessRuleOptions).execute();\n", " AccountAccessRuleResp accountAccessRuleRespResult = response.getResult();\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " accessruleIdentifier: ${firewallAccessRuleId,\n", " mode: 'block',\n", " notes:\n", " 'after update api, This rule is added because of event X that occurred on date xyz',\n", " configuration: {\n", " target: 'ip',\n", " value: '192.169.1.100',\n", " },\n", "};\n", "\n", "firewallAccessRulesV1.updateAccountAccessRule(params)\n", " .then(response => {\n", " const updatedAccountAccessRule = result.result;\n", " console.log(JSON.stringify(updatedAccountAccessRule, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/firewall/waf/packages/{package_id}/rules": { "get": { "tags": [ "WAF Rules" ], "summary": "List all WAF rules", "deprecated": true, "operationId": "list_waf_rules", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.waf-rules.read" } ] }, "description": "List all Web Application Firewall (WAF) rules.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "in": "path", "name": "package_id", "required": true, "description": "Package ID", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "required": false, "description": "The Rule Mode", "example": "on", "schema": { "type": "string", "enum": [ "on", "off" ] } }, { "in": "query", "name": "priority", "required": false, "description": "The order in which the individual rule is executed within the related group", "example": 5, "schema": { "type": "string" } }, { "in": "query", "name": "match", "required": false, "description": "Whether to match all search requirements or at least one. default value: all. valid values: any, all", "example": "all", "schema": { "type": "string" } }, { "in": "query", "name": "order", "required": false, "description": "Field to order rules by. valid values: priority, group_id, description.", "example": "status", "schema": { "type": "string" } }, { "in": "query", "name": "group_id", "required": false, "description": "WAF group identifier tag. max length: 32; Read-only", "example": "de677e5818985db1285d0e80225f06e5", "schema": { "type": "string" } }, { "in": "query", "name": "description", "required": false, "description": "Public description of the rule", "example": "SQL-injection-prevention-for-SELECT-statements", "schema": { "type": "string" } }, { "in": "query", "name": "direction", "required": false, "description": "Direction to order rules. valid values: asc, desc", "example": "desc", "schema": { "type": "string" } }, { "in": "query", "name": "page", "required": false, "description": "Page number of paginated results. default value: 1; min value:1", "example": 1, "schema": { "type": "integer" } }, { "in": "query", "name": "per_page", "required": false, "description": "Number of rules per page. default value: 50; min value:5; max value:100", "example": 50, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/waf-rules-response" }, "examples": { "response": { "value": { "result": [ { "id": "100000356", "description": "SLR: GPL WEB_SPECIFIC_APPS BASE base_qry_common.php remote file include", "priority": "442", "package_id": "c504870194831cd12c3fc0284f294abb", "group": { "id": "6035463b92082256c0c4cf5ce5028a98", "name": "OWASP Slr Et RFI Attacks" }, "mode": "on", "allowed_modes": [ "on", "off" ] }, { "id": "100000357", "description": "SLR: GPL WEB_SPECIFIC_APPS BASE base_stat_common.php remote file include", "priority": "443", "package_id": "c504870194831cd12c3fc0284f294abb", "group": { "id": "6035463b92082256c0c4cf5ce5028a98", "name": "OWASP Slr Et RFI Attacks" }, "mode": "on", "allowed_modes": [ "on", "off" ] } ], "result_info": { "page": 1, "per_page": 20, "count": 2, "total_count": 2 }, "success": true, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal Server Error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/waf/packages/:pkg_id/rules \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import WafRulesApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " wafRulesApi = WafRulesApiV1.new_instance(\n", " crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " wafRulesApi.set_service_url(endpoint)\n", " package_id = \"c504870194831cd12c3fc0284f294abb\"\n", " resp = wafRulesApi.list_waf_rules(\n", " package_id=package_id).get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/wafrulesapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &wafrulesapiv1.WafRulesApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := wafrulesapiv1.NewWafRulesApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewListWafRulesOptions(\"c504870194831cd12c3fc0284f294abb\")\n", "\tresult, response, err := service.ListWafRules(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ListWafRulesOptions listWafRulesOptions = new ListWafRulesOptions.Builder()\n", " .packageId(pIdentifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.listWafRules(listWafRulesOptions).execute();\n", " WafRulesResponse wafRulesResponseResult = response.getResult();\n", " int i = 0;\n", " while (i < wafRulesResponseResult.getResult().size()) {\n", " rIdentifier = wafRulesResponseResult.getResult().get(i).getId();\n", " break;\n", " }\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const WafRulesApiV1 = require('ibm-networking-services/cis/wafrulesapiv1/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "// Initialize the service client.\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "};\n", "\n", "const wafRulesApiV1 = new WafRulesApiV1(options);\n", "\n", "const params = {\n", " packageId: ${wafRulePackageId},\n", "};\n", "wafRulesApiV1.listWafRules(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const wafRules = result.result;\n", " console.log(JSON.stringify(wafRules, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/firewall/waf/packages/{package_id}/rules/{identifier}": { "get": { "tags": [ "WAF Rules" ], "summary": "Get WAF rule", "deprecated": true, "operationId": "get_waf_rule", "description": "Get individual information about a rule.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "in": "path", "name": "package_id", "required": true, "description": "Package ID", "schema": { "type": "string" } }, { "in": "path", "name": "identifier", "required": true, "description": "Rule ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/waf-rule-response" }, "examples": { "response": { "value": { "result": { "id": "100000356", "description": "SLR: GPL WEB_SPECIFIC_APPS BASE base_qry_common.php remote file include", "priority": 442, "package_id": "c504870194831cd12c3fc0284f294abb", "group": { "id": "6035463b92082256c0c4cf5ce5028a98", "name": "OWASP Slr Et RFI Attacks" }, "mode": "on", "allowed_modes": [ "on", "off" ] }, "success": true, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal Server Error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/waf/packages/:pkg_id/rules/:rule_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import WafRulesApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " wafRulesApi = WafRulesApiV1.new_instance(\n", " crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " wafRulesApi.set_service_url(endpoint)\n", " package_id = \"c504870194831cd12c3fc0284f294abb\"\n", " identifier = \"100000356\"\n", " resp = wafRulesApi.get_waf_rule(\n", " package_id=package_id, identifier=identifier).get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/wafrulesapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &wafrulesapiv1.WafRulesApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := wafrulesapiv1.NewWafRulesApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewGetWafRuleOptions(\"4112ba6c2974ec43886f90736968e838\", \"6563ebae141638f92ebbdc4a821bef8c\")\n", "\tresult, response, err := service.GetWafRule(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " identifier: ${wafRuleId},\n", " packageId: ${wafRulePackageId},\n", "};\n", "wafRulesApiV1.getWafRule(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const wafRule = result.result;\n", " console.log(JSON.stringify(wafRule, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "WAF Rules" ], "summary": "Update WAF rule", "deprecated": true, "operationId": "update_waf_rule", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.waf-rules.update" } ] }, "description": "Update the action the rule will perform if triggered on the zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "in": "path", "name": "package_id", "required": true, "description": "Package ID", "schema": { "type": "string" } }, { "in": "path", "name": "identifier", "required": true, "description": "Rule ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/waf-rule-body" } } }, "description": "The mode to use when the rule is triggered. Value is restricted based on the allowed_modes of the rule" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/waf-rule-response" }, "examples": { "response": { "value": { "result": { "id": "100000356", "description": "SLR: GPL WEB_SPECIFIC_APPS BASE base_qry_common.php remote file include", "priority": 442, "package_id": "c504870194831cd12c3fc0284f294abb", "group": { "id": "6035463b92082256c0c4cf5ce5028a98", "name": "OWASP Slr Et RFI Attacks" }, "mode": "on", "allowed_modes": [ "on", "off" ] }, "success": true, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal Server Error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/waf/packages/:pkg_id/rules/:rule_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"mode\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import WafRulesApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " wafRulesApi = WafRulesApiV1.new_instance(\n", " crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " wafRulesApi.set_service_url(endpoint)\n", " package_id = \"c504870194831cd12c3fc0284f294abb\"\n", " identifier = \"100000356\"\n", " cis = {\n", " \"mode\": \"block\"\n", " }\n", " owasp = {\n", " \"mode\": \"on\"\n", " }\n", " resp = wafRulesApi.update_waf_rule(\n", " package_id=package_id, identifier=identifier,\n", " cis=cis, owasp=owasp).get_result()\n", " print(resp)\n", "\n", " mode_name = \"owasp\"\n", " else:\n", " mode_list = cis_modes\n", " mode_name = \"cis\"\n", "\n", " for m in mode_list:\n", " if m != mode:\n", " new_mode = m\n", " break\n", " \n", " if mode_name == \"cis\":\n", " cis = {\"mode\": new_mode}\n", " owasp = None\n", " else:\n", " owasp = {\"mode\": new_mode}\n", " cis = None\n", " \n", " resp = wafRulesApi.update_waf_rule(\n", " crn=crn, zone_id=zone_id, package_id=package_id, identifier=identifier, \n", " cis=cis, owasp=owasp).get_result()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/wafrulesapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &wafrulesapiv1.WafRulesApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := wafrulesapiv1.NewWafRulesApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewUpdateWafRuleOptions(\"4112ba6c2974ec43886f90736968e838\", \"6563ebae141638f92ebbdc4a821bef8c\")\n", "\towaspOpt, owaspErr := service.NewWafRuleBodyOwasp(wafrulesapiv1.WafRuleBodyOwasp_Mode_On)\n", "\tif owaspErr != nil {\n", "\t\treturn\n", "\t}\n", "\tcisOpt, cisErr := service.NewWafRuleBodyCis(wafrulesapiv1.WafRuleBodyCis_Mode_Simulate)\n", "\tif cisErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions.SetCis(cisOpt)\n", "\toptions.SetOwasp(owaspOpt)\n", "\n", "\tresult, response, err := service.UpdateWafRule(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " WafRuleBodyCis wafRuleBodyCisModel = new WafRuleBodyCis.Builder()\n", " .mode(\"default\")\n", " .build();\n", "\n", " WafRuleBodyOwasp wafRuleBodyOwaspModel = new WafRuleBodyOwasp.Builder()\n", " .mode(\"off\")\n", " .build();\n", "\n", " UpdateWafRuleOptions updateWafRuleOptions = new UpdateWafRuleOptions.Builder()\n", " .packageId(pIdentifier)\n", " .identifier(rIdentifier)\n", " .owasp(wafRuleBodyOwaspModel)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.updateWafRule(updateWafRuleOptions).execute();\n", " WafRuleResponse wafRuleResponseResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " identifier: ${wafRuleId},\n", " packageId: ${wafRulePackageId},\n", " cis: { mode: 'on' },\n", " owsap: { mode: 'off' },\n", "};\n", "wafRulesApiV1.updateWafRule(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const updatedWafRule = result.result;\n", " console.log(JSON.stringify(updatedWafRule, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/purge_cache/purge_all": { "put": { "tags": [ "Cache Settings" ], "operationId": "purge_all", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.performance.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.purge-cache-all.update" } ] }, "summary": "Purge all", "description": "All resources in CDN edge servers' cache should be removed. This can have dramatic affects on your origin server load after performing this action.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purgeAll-response" } } } }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" }, "504": { "description": "Gateway Timeout! Backend API endpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/purge_cache/purge_all \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import CachingApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cache = CachingApiV1.new_instance(crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " cache.set_service_url(endpoint)\n", " resp = cache.purge_all()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/cachingapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &cachingapiv1.CachingApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := cachingapiv1.NewCachingApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewPurgeAllOptions()\n", "\tresult, response, err := service.PurgeAll(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " PurgeAllOptions purgeAllOptions = new PurgeAllOptions();\n", "\n", " // Invoke operation\n", " Response response = service.purgeAll(purgeAllOptions).execute();\n", " PurgeAllResponse purgeAllResponseResult = response.getResult();\n", "\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const CachingApiV1 = require('ibm-networking-services/cis/cachingapiv1/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "// Initialize the service client.\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "};\n", "\n", "const cachingApiV1 = new CachingApiV1(options);\n", "cachingApiV1.purgeAll()\n", " .then(response => {\n", " const { result } = response || {};\n", " const purgeAll = result.result;\n", " console.log(JSON.stringify(purgeAll, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/purge_cache/purge_by_urls": { "put": { "tags": [ "Cache Settings" ], "operationId": "purge_by_urls", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.performance.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.purge-cache-by-urls.update" } ] }, "summary": "Purge URLs", "description": "Granularly remove one or more files from CDN edge servers' cache either by specifying URLs.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purge_urls_body" } } }, "description": "An array of URLs that should be removed from cache" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purgeAll-response" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "62d26b178b67c0eda0613891f3f51b0a" } } } } } } }, "400": { "description": "Bad request" }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/purge_cache/purge_by_urls \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "-d '{\n", " \"files\": [\n", " \"http://www.example.com/example_01.jpg\",\n", " \"http://www.example.com/example_02.jpg\"\n", " ]\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import CachingApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cache = CachingApiV1.new_instance(\n", " crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " cache.set_service_url(endpoint)\n", " resp = cache.purge_by_urls(\n", " files=[\"http://www.example.com/cat_picture.jpg\"])\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/cachingapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &cachingapiv1.CachingApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := cachingapiv1.NewCachingApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewPurgeByUrlsOptions()\n", "\topt.SetFiles([]string{\"http://www.example.com/cat_picture.jpg\"})\n", "\tresult, response, err := service.PurgeByUrls(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " PurgeByUrlsOptions purgeByUrlsOptions = new PurgeByUrlsOptions.Builder()\n", " .files(new java.util.ArrayList(java.util.Arrays.asList(\"http://www.example.com/cat_picture.jpg\")))\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.purgeByUrls(purgeByUrlsOptions).execute();\n", " PurgeAllResponse purgeAllResponseResult = response.getResult();\n", "\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " 'files': [\n", " 'http://www.example.com/example_01.jpg',\n", " 'http://www.example.com/example_02.jpg',\n", " ],\n", "};\n", "cachingApiV1.purgeByUrls(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const purgeByUrls = result.result;\n", " console.log(JSON.stringify(purgeByUrls, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/purge_cache/purge_by_cache_tags": { "put": { "tags": [ "Cache Settings" ], "operationId": "purge_by_cache_tags", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.performance.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.purge-cache-by-cache-tags.update" } ] }, "summary": "Purge Cache-Tags", "description": "Granularly remove one or more files from CDN edge servers' cache either by specifying the associated Cache-Tags.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purge_tags_body" } } }, "description": "Any assets served with a Cache-Tag header that matches one of the provided values will be purged from the CDN edge servers' cache." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purgeAll-response" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "62d26b178b67c0eda0613891f3f51b0a" } } } } } } }, "400": { "description": "Bad request" }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/purge_cache/purge_by_cache_tags \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "-d '{\n", " \"tags\": [\n", " \"cache-tag-01\",\n", " \"cache-tag-02\"\n", " ]\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import CachingApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cache = CachingApiV1.new_instance(crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " cache.set_service_url(endpoint)\n", " resp = cache.purge_by_cache_tags(tags=[\"some-tags\"])\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/cachingapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &cachingapiv1.CachingApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := cachingapiv1.NewCachingApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewPurgeByCacheTagsOptions()\n", "\topt.SetTags([]string{\"some-tags\"})\n", "\tresult, response, err := service.PurgeByCacheTags(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " PurgeByCacheTagsOptions purgeByCacheTagsOptions = new PurgeByCacheTagsOptions.Builder()\n", " .tags(new java.util.ArrayList(java.util.Arrays.asList(\"some-tag\")))\n", " .build();\n", " // Invoke operation\n", " Response response = service.purgeByCacheTags(purgeByCacheTagsOptions).execute();\n", " PurgeAllResponse purgeAllResponseResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " 'tags': ['cache-tag-01', 'cache-tag-02'],\n", "};\n", "cachingApiV1.purgeByCacheTags(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const purgeByCacheTags = result.result;\n", " console.log(JSON.stringify(purgeByCacheTags, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/purge_cache/purge_by_hosts": { "put": { "tags": [ "Cache Settings" ], "operationId": "purge_by_hosts", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.performance.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.purge-cache-by-hosts.update" } ] }, "summary": "Purge host names", "description": "Granularly remove one or more files from CDN edge servers' cache either by specifying the hostnames.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purge_hosts_body" } } }, "description": "Any assets at URLs with a host that matches one of the provided values will be purged from the CDN edge servers' cache." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purgeAll-response" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "62d26b178b67c0eda0613891f3f51b0a" } } } } } } }, "400": { "description": "Bad request" }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/purge_cache/purge_by_hosts \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "-d '{\n", " \"hosts\": [\n", " \"one.example.com,\n", " \"two.example.com\"\n", " ]\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import CachingApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cache = CachingApiV1.new_instance(\n", " crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " cache.set_service_url(endpoint)\n", " resp = cache.purge_by_hosts(hosts=[\"www.example-host.com\"])\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/cachingapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &cachingapiv1.CachingApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := cachingapiv1.NewCachingApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewPurgeByHostsOptions()\n", "\topt.SetHosts([]string{\"www.example-host.com\"})\n", "\tresult, response, err := service.PurgeByHosts(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " PurgeByHostsOptions purgeByHostsOptions = new PurgeByHostsOptions.Builder()\n", " .hosts(new java.util.ArrayList(java.util.Arrays.asList(\"www.example.com\")))\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.purgeByHosts(purgeByHostsOptions).execute();\n", " PurgeAllResponse purgeAllResponseResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " 'hosts': ['one.example.com', 'two.example.com'],\n", "};\n", "cachingApiV1.purgeByHosts(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const purgeByHosts = result.result;\n", " console.log(JSON.stringify(purgeByHosts, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/purge_cache/purge_by_prefixes": { "put": { "tags": [ "Cache Settings" ], "operationId": "purge_by_prefixes", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.performance.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.purge-cache-by-prefixes.update" } ] }, "summary": "Purge individual files by prefixes", "description": "Granularly remove one or more files from CDN edge servers' cache by specifying the prefixes.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purge_prefixes_body" } } }, "description": "Any assets at URLs that match the prefix will be purged from the CDN edge servers' cache." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purgeAll-response" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "62d26b178b67c0eda0613891f3f51b0a" } } } } } } }, "400": { "description": "Bad request" }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/purge_cache/purge_by_prefixes \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "-d '{\n", " \"prefixes\": [\n", " \"one.example.com/foo,\n", " \"two.example.com/foo/baz\"\n", " ]\n", "}'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/settings/cache_level": { "get": { "tags": [ "Zones Settings" ], "operationId": "get_cache_level", "summary": "Get cache level setting", "description": "Get cache level setting of a specific zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cacheLevel-response" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "cache_level", "value": "aggressive", "editable": true, "modified_on": "2014-01-01T05:20:00.12345Z" } } } } } } }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/cache_level \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import CachingApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cache = CachingApiV1.new_instance(crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " cache.set_service_url(endpoint)\n", " resp = cache.get_cache_level()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/cachingapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &cachingapiv1.CachingApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := cachingapiv1.NewCachingApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\tgetOpt := service.NewGetCacheLevelOptions()\n", "\tresult, response, err := service.GetCacheLevel(getOpt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetCacheLevelOptions getCacheLevelOptions = new GetCacheLevelOptions();\n", " // Invoke operation\n", " Response response = service.getCacheLevel(getCacheLevelOptions).execute();\n", " CacheLevelResponse cacheLevelResponseResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "cachingApiV1.getCacheLevel()\n", " .then(response => {\n", " const { result } = response || {};\n", " const cacheLevel = result.result;\n", " console.log(JSON.stringify(cacheLevel, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "operationId": "update_cache_level", "summary": "Set cache level setting", "description": "The `basic` setting will cache most static resources (i.e., css, images, and JavaScript). The `simplified` setting will ignore the query string when delivering a cached resource. The `aggressive` setting will cache all static resources, including ones with a query string.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cacheLevel-body" } } }, "description": "The `basic` setting will cache most static resources (i.e., css, images, and JavaScript). The `simplified` setting will ignore the query string when delivering a cached resource. The `aggressive` setting will cache all static resources, including ones with a query string." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cacheLevel-response" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "cache_level", "value": "aggressive", "editable": true, "modified_on": "2014-01-01T05:20:00.12345Z" } } } } } } }, "400": { "description": "Bad request" }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/cache_level \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "-d '{\n", " \"value\": \"aggressive\"\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import CachingApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cache = CachingApiV1.new_instance(crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " cache.set_service_url(endpoint)\n", " resp = cache.update_cache_level(value=\"basic\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/cachingapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &cachingapiv1.CachingApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := cachingapiv1.NewCachingApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewUpdateCacheLevelOptions()\n", "\topt.SetValue(cachingapiv1.UpdateCacheLevelOptions_Value_Basic)\n", "\tresult, response, err := service.UpdateCacheLevel(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " UpdateCacheLevelOptions updateCacheLevelOptions = new UpdateCacheLevelOptions.Builder()\n", " .value(\"aggressive\")\n", " .build();\n", " // Invoke operation\n", " Response response = service.updateCacheLevel(updateCacheLevelOptions).execute();\n", " CacheLevelResponse cacheLevelResponseResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " value: 'basic', // Example of Cache Level\n", "};\n", "cachingApiV1.updateCacheLevel(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const updatedCacheLevel = result.result;\n", " console.log(JSON.stringify(updatedCacheLevel, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/settings/browser_cache_ttl": { "get": { "tags": [ "Cache Settings" ], "operationId": "get_browser_cache_ttl", "summary": "Get browser cache TTL setting", "description": "Browser Cache TTL (in seconds) specifies how long CDN edge servers cached resources will remain on your visitors' computers.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/browserTTL-response" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "browser_cache_ttl", "value": 14400, "editable": true, "modified_on": "2014-01-01T05:20:00.12345Z" } } } } } } }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/browser_cache_ttl \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import CachingApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cache = CachingApiV1.new_instance(crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " cache.set_service_url(endpoint)\n", " resp = cache.get_browser_cache_ttl()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/cachingapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &cachingapiv1.CachingApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := cachingapiv1.NewCachingApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\tgetOpt := service.NewGetBrowserCacheTtlOptions()\n", "\tresult, response, err := service.GetBrowserCacheTTL(getOpt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetBrowserCacheTtlOptions getBrowserCacheTtlOptions = new GetBrowserCacheTtlOptions();\n", " // Invoke operation\n", " Response response = service.getBrowserCacheTtl(getBrowserCacheTtlOptions).execute();\n", " BrowserTTLResponse browserTtlResponseResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "cachingApiV1.getBrowserCacheTtl()\n", " .then(response => {\n", " const { result } = response || {};\n", " const browserCacheTtl = result.result;\n", " console.log(JSON.stringify(browserCacheTtl, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "Cache Settings" ], "operationId": "update_browser_cache_ttl", "summary": "Change browser cache TTL setting", "description": "Browser Cache TTL (in seconds) specifies how long CDN edge servers cached resources will remain on your visitors' computers.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/browserTTL-body" } } }, "description": "Default value is 14400. valid values are 0, 30, 60, 300, 1200, 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800, 259200, 345600, 432000, 691200, 1382400, 2073600, 2678400, 5356800, 16070400, 31536000. notes! The minimum TTL available depends on the plan level of the zone. Enterprise is 30, Business is 1800, Pro is 1800, Free is 1800, 0 is special value meaning to respect origin header." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/browserTTL-response" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "browser_cache_ttl", "value": 14400, "editable": true, "modified_on": "2014-01-01T05:20:00.12345Z" } } } } } } }, "400": { "description": "Bad request" }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/browser_cache_ttl \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "-d '{\n", " \"value\": 1800\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import CachingApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cache = CachingApiV1.new_instance(crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " cache.set_service_url(endpoint)\n", " resp = cache.update_browser_cache_ttl(crn=crn, zone_id=zone_id, value=14400)\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/cachingapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &cachingapiv1.CachingApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := cachingapiv1.NewCachingApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewUpdateBrowserCacheTtlOptions()\n", "\topt.SetValue(14400)\n", "\tresult, response, err := service.UpdateBrowserCacheTTL(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " UpdateBrowserCacheTtlOptions updateBrowserCacheTtlOptions = new UpdateBrowserCacheTtlOptions.Builder()\n", " .value(Long.valueOf(\"14400\"))\n", " .build();\n", " // Invoke operation\n", " Response response = service.updateBrowserCacheTtl(updateBrowserCacheTtlOptions).execute();\n", " BrowserTTLResponse browserTtlResponseResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " value: ${currentTtlValue},\n", "};\n", "cachingApiV1.updateBrowserCacheTtl(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const updatedBrowserCacheTtl = result.result;\n", " console.log(JSON.stringify(updatedBrowserCacheTtl, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/settings/always_online": { "get": { "tags": [ "Cache Settings" ], "operationId": "get_serve_stale_content", "summary": "Get Serve Stale Content setting", "description": "When enabled, Serve Stale Content will serve pages from CDN edge servers' cache if your server is offline.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serveStaleContent-response" } } } }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/always_online \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " resp = cache.get_serve_stale_content(crn=crn, zone_id=zone_id)\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/cachingapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: \"{api key}\",\n", "\t}\n", "\tcrn := \"{Crn}\"\n", "\tzoneID := \"{zoneid}\"\n", "\tglobalOptions := &cachingapiv1.CachingApiV1Options{\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := cachingapiv1.NewCachingApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\tgetOpt := service.NewGetServeStaleContentOptions()\n", "\tresult, response, err := service.GetServeStaleContent(getOpt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "cachingApiV1.GetServeStaleContent()\n", " .then(response => {\n", " const { result } = response || {};\n", " const getssc = result.result;\n", " console.log(JSON.stringify(getssc, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", " " ] } ] } ] } } }, "patch": { "tags": [ "Cache Settings" ], "operationId": "update_serve_stale_content", "summary": "Change Serve Stale Content setting", "description": "When enabled, Serve Stale Content will serve pages from CDN edge servers' cache if your server is offline.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serveStaleContent-body" } } }, "description": "Default value is `on`, valid values are `on` and `off`." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serveStaleContent-response" } } } }, "400": { "description": "Bad request" }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/always_online \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx' \\\n", "-d '{\n", " \"value\": 1800\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " resp = cache.update_serve_stale_content(\n", " crn=crn, zone_id=zone_id, value=\"off\")\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/cachingapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: \"{api key}\",\n", "\t}\n", "\tcrn := \"{Crn}\"\n", "\tzoneID := \"{zoneid}\"\n", "\tglobalOptions := &cachingapiv1.CachingApiV1Options{\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := cachingapiv1.NewCachingApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewUpdateServeStaleContentOptions()\n", "\topt.SetValue(cachingapiv1.UpdateServeStaleContentOptions_Value_On)\n", "\tresult, response, err := service.UpdateServeStaleContent(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " 'value': true,\n", "};\n", "cachingApiV1.UpdateServeStaleContent(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const updatedssc = result.result;\n", " console.log(JSON.stringify(updatedssc, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", " " ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/settings/development_mode": { "get": { "tags": [ "Cache Settings" ], "operationId": "get_development_mode", "summary": "Get development mode setting", "description": "Get development mode setting.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deveopmentMode-response" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "development_mode", "value": "off", "editable": true, "modified_on": "2014-01-01T05:20:00.12345Z" } } } } } } }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/development_mode \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import CachingApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cache = CachingApiV1.new_instance(crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " cache.set_service_url(endpoint)\n", " resp = cache.get_development_mode()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/cachingapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &cachingapiv1.CachingApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := cachingapiv1.NewCachingApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\tgetOpt := service.NewGetDevelopmentModeOptions()\n", "\tresult, response, err := service.GetDevelopmentMode(getOpt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetDevelopmentModeOptions getDevelopmentModeOptions = new GetDevelopmentModeOptions();\n", " // Invoke operation\n", " Response response = service.getDevelopmentMode(getDevelopmentModeOptions).execute();\n", " DeveopmentModeResponse deveopmentModeResponseResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "cachingApiV1.getDevelopmentMode()\n", " .then(response => {\n", " const { result } = response || {};\n", " const developmentMode = result.result;\n", " console.log(JSON.stringify(developmentMode, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", " " ] } ] } ] } } }, "patch": { "tags": [ "Cache Settings" ], "operationId": "update_development_mode", "summary": "Change development mode setting", "description": "Change development mode setting.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/developmentMode-body" } } }, "description": "Default value is `off`, valid values are `on` and `off`." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deveopmentMode-response" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "development_mode", "value": "off", "editable": true, "modified_on": "2014-01-01T05:20:00.12345Z" } } } } } } }, "400": { "description": "Bad request" }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/development_mode \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "-d '{\n", " \"value\": \"on\"\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import CachingApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cache = CachingApiV1.new_instance(crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " cache.set_service_url(endpoint)\n", " resp = cache.update_development_mode(value=\"on\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/cachingapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &cachingapiv1.CachingApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := cachingapiv1.NewCachingApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewUpdateDevelopmentModeOptions()\n", "\topt.SetValue(cachingapiv1.UpdateDevelopmentModeOptions_Value_On)\n", "\tresult, response, err := service.UpdateDevelopmentMode(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " UpdateDevelopmentModeOptions updateDevelopmentModeOptions = new UpdateDevelopmentModeOptions.Builder()\n", " .value(\"off\")\n", " .build();\n", " // Invoke operation\n", " Response response = service.updateDevelopmentMode(updateDevelopmentModeOptions).execute();\n", " DeveopmentModeResponse deveopmentModeResponseResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " 'value': true,\n", "};\n", "cachingApiV1.updateDevelopmentMode(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const updatedDevelopmentMode = result.result;\n", " console.log(JSON.stringify(updatedDevelopmentMode, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", " " ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/settings/sort_query_string_for_cache": { "get": { "tags": [ "Cache Settings" ], "operationId": "get_query_string_sort", "summary": "Get Enable Query String Sort setting", "description": "Get Enable Query String Sort setting.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/enableQueryStringSort-response" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "sort_query_string_for_cache", "value": "off", "editable": true, "modified_on": "2014-01-01T05:20:00.12345Z" } } } } } } }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/sort_query_string_for_cache \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import CachingApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cache = CachingApiV1.new_instance(crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " cache.set_service_url(endpoint)\n", " resp = cache.get_query_string_sort()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/cachingapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &cachingapiv1.CachingApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := cachingapiv1.NewCachingApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\tgetOpt := service.NewGetQueryStringSortOptions()\n", "\tresult, response, err := service.GetQueryStringSort(getOpt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetQueryStringSortOptions getQueryStringSortOptions = new GetQueryStringSortOptions();\n", " // Invoke operation\n", " Response response = service.getQueryStringSort(getQueryStringSortOptions).execute();\n", " EnableQueryStringSortResponse enableQueryStringSortResponseResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "cachingApiV1.getQueryStringSort()\n", " .then(response => {\n", " const { result } = response || {};\n", " const queryStringSort = result.result;\n", " console.log(JSON.stringify(queryStringSort, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", " " ] } ] } ] } } }, "patch": { "tags": [ "Cache Settings" ], "operationId": "update_query_string_sort", "summary": "Change Enable Query String Sort setting", "description": "Change Enable Query String Sort setting.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/enableQueryStringSort-body" } } }, "description": "Default value is `off`, valid values are `on` and `off`." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/enableQueryStringSort-response" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "sort_query_string_for_cache", "value": "off", "editable": true, "modified_on": "2014-01-01T05:20:00.12345Z" } } } } } } }, "400": { "description": "Bad request" }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/sort_query_string_for_cache \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "-d '{\n", " \"value\": \"on\"\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import CachingApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cache = CachingApiV1.new_instance(crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " cache.set_service_url(endpoint)\n", " resp = cache.update_query_string_sort(value=\"on\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/cachingapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &cachingapiv1.CachingApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := cachingapiv1.NewCachingApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewUpdateQueryStringSortOptions()\n", "\topt.SetValue(cachingapiv1.UpdateQueryStringSortOptions_Value_On)\n", "\tresult, response, err := service.UpdateQueryStringSort(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " UpdateQueryStringSortOptions updateQueryStringSortOptions = new UpdateQueryStringSortOptions.Builder()\n", " .value(\"off\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.updateQueryStringSort(updateQueryStringSortOptions).execute();\n", " // Validate response\n", " assertNotNull(response);\n", " assertEquals(response.getStatusCode(), 200);\n", "\n", " EnableQueryStringSortResponse enableQueryStringSortResponseResult = response.getResult();\n", "\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " 'value': 'on',\n", "};\n", "cachingApiV1.updateQueryStringSort(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const updatedDevelopmentMode = result.result;\n", " console.log(JSON.stringify(updatedDevelopmentMode, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", " " ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/dns_records": { "get": { "tags": [ "DNS Records" ], "summary": "List all DNS records", "operationId": "list_all_dns_records", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.reliability.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.dns-records.read" } ] }, "description": "List all DNS records for a given zone of a service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "query", "name": "type", "description": "Type of DNS records to display.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "name", "description": "Value of name field to filter by.", "required": false, "schema": { "type": "string", "example": "host1.test-example.com" } }, { "in": "query", "name": "content", "description": "Value of content field to filter by.", "required": false, "schema": { "type": "string", "example": "1.2.3.4" } }, { "in": "query", "name": "page", "description": "Page number of paginated results.", "required": false, "schema": { "type": "integer", "default": 1 } }, { "in": "query", "name": "per_page", "description": "Maximum number of DNS records per page.", "required": false, "schema": { "type": "integer", "default": 20, "minimum": 5 } }, { "in": "query", "name": "order", "description": "Field by which to order list of DNS records.", "required": false, "schema": { "type": "string", "enum": [ "type", "name", "content", "ttl", "proxied" ] } }, { "in": "query", "name": "direction", "description": "Direction in which to order results [ascending/descending order].", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "in": "query", "name": "match", "description": "Whether to match all (all) or atleast one search parameter (any).", "required": false, "schema": { "type": "string", "enum": [ "any", "all" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_dnsrecords_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result_info": { "page": 1, "per_page": 20, "count": 1, "total_count": 2000 }, "result": [ { "id": "f1aba936b94213e5b8dca0c0dbf1f9cc", "created_on": "2014-01-01T05:20:00.123Z", "modified_on": "2014-01-01T05:20:00.123Z", "name": "host-1.test-example.com", "type": "A", "content": "169.154.10.10", "zone_id": "023e105f4ecef8ad9ca31a8372d0c353", "zone_name": "test-example.com", "proxiable": true, "proxied": false, "ttl": 120, "priority": 5, "data": {} } ] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/dns_records \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import DnsRecordsV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " record = DnsRecordsV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " record.set_service_url(endpoint)\n", " resp = record.list_all_dns_records()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/dnsrecordsv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &dnsrecordsv1.DnsRecordsV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := dnsrecordsv1.NewDnsRecordsV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewListAllDnsRecordsOptions()\n", "\tresult, response, err := service.ListAllDnsRecords(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ListAllDnsRecordsOptions listAllDnsRecordsOptions = new ListAllDnsRecordsOptions.Builder()\n", " .type(\"testString\")\n", " .name(\"host1.test-example.com\")\n", " .content(\"1.2.3.4\")\n", " .page(Long.valueOf(\"26\"))\n", " .perPage(Long.valueOf(\"5\"))\n", " .order(\"type\")\n", " .direction(\"asc\")\n", " .match(\"any\")\n", " .build();\n", " \n", " // Invoke operation\n", " Response response = service.listAllDnsRecords(listAllDnsRecordsOptions).execute(); \n", " ListDnsrecordsResp listDnsrecordsRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const DnsRecordsV1 = require('ibm-networking-services/cis/dnsrecordsv1/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "// Initialize the service client.\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "};\n", "\n", "const dnsRecordsV1 = new DnsRecordsV1(options);\n", "dnsRecordsV1.listAllDnsRecords()\n", " .then(response => {\n", " const { result } = response || {};\n", " const dnsRecords = result.result;\n", " console.log(dnsRecords);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "post": { "tags": [ "DNS Records" ], "summary": "Create DNS record", "operationId": "create_dns_record", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.reliability.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.dns-records.create" } ] }, "description": "Add a new DNS record for a given zone for a given service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnsrecord_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "f1aba936b94213e5b8dca0c0dbf1f9cc", "created_on": "2014-01-01T05:20:00.123Z", "modified_on": "2014-01-01T05:20:00.123Z", "name": "host-1.test-example.com", "type": "A", "content": "169.154.10.10", "zone_id": "023e105f4ecef8ad9ca31a8372d0c353", "zone_name": "test-example.com", "proxiable": true, "proxied": false, "ttl": 120, "priority": 5, "data": {} } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnsrecord_input" } } }, "description": "DNS record parameters." }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/dns_records \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "-d '{\n", " \"name\": \"www\",\n", " \"type\": \"A\",\n", " \"content\": \"192.168.127.127\"\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import DnsRecordsV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " record = DnsRecordsV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " record.set_service_url(endpoint)\n", " record_type = 'A'\n", " name = 'example_ip'\n", " content = '1.1.1.1'\n", " resp = record.create_dns_record(\n", " type=record_type, name=name, content=content)\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/dnsrecordsv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &dnsrecordsv1.DnsRecordsV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := dnsrecordsv1.NewDnsRecordsV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewCreateDnsRecordOptions()\n", "\topt.SetName(\"host-1.test-example.com\")\n", "\topt.SetType(dnsrecordsv1.CreateDnsRecordOptions_Type_A)\n", "\topt.SetContent(\"1.2.3.4\")\n", "\tresult, response, err := service.CreateDnsRecord(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " CreateDnsRecordOptions createDnsRecordOptions = new CreateDnsRecordOptions.Builder()\n", " .name(\"host-1.test-example.com\")\n", " .type(\"A\")\n", " .ttl(Long.valueOf(\"120\"))\n", " .content(\"1.2.3.4\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.createDnsRecord(createDnsRecordOptions).execute();\n", " DnsrecordResp dnsrecordRespResult = response.getResult();\n", " identifier = dnsrecordRespResult.getResult().getId();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " name: 'www',\n", " type: 'A',\n", " content: '192.168.117.112',\n", "};\n", "dnsRecordsV1.createDnsRecord(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const dnsRecord = result.result;\n", " console.log(JSON.stringify(dnsRecord, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/dns_records/{dnsrecord_identifier}": { "delete": { "tags": [ "DNS Records" ], "summary": "Delete DNS record", "operationId": "delete_dns_record", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.reliability.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.dns-records.delete" } ] }, "description": "Delete a DNS record, given its ID.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "dnsrecord_identifier", "description": "Identifier of DNS record", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_dnsrecord_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "f1aba936b94213e5b8dca0c0dbf1f9cc" } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/dns_records/:record_id \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import DnsRecordsV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " record = DnsRecordsV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " record.set_service_url(endpoint)\n", " resp = record.delete_dns_record(\n", " dnsrecord_identifier=\"aaf17ad8008aea8d5f114d4917887ee4\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/dnsrecordsv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &dnsrecordsv1.DnsRecordsV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := dnsrecordsv1.NewDnsRecordsV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewDeleteDnsRecordOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\tresult, response, err := service.DeleteDnsRecord(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " DeleteDnsRecordOptions deleteDnsRecordOptions = new DeleteDnsRecordOptions.Builder()\n", " .dnsrecordIdentifier(identifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.deleteDnsRecord(deleteDnsRecordOptions).execute();\n", " DeleteDnsrecordResp deleteDnsrecordRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " dnsrecordIdentifier: ${DNS_RECORD_ID},\n", "};\n", "dnsRecordsV1.deleteDnsRecord(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const dnsRecordDeleted = result.result;\n", " console.log(JSON.stringify(dnsRecordDeleted, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", " " ] } ] } ] } } }, "get": { "tags": [ "DNS Records" ], "summary": "Get DNS record", "operationId": "get_dns_record", "description": "Get the details of a DNS record for a given zone under a given service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "dnsrecord_identifier", "description": "Identifier of DNS record", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnsrecord_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "f1aba936b94213e5b8dca0c0dbf1f9cc", "created_on": "2014-01-01T05:20:00.123Z", "modified_on": "2014-01-01T05:20:00.123Z", "name": "host-1.test-example.com", "type": "A", "content": "169.154.10.10", "zone_id": "023e105f4ecef8ad9ca31a8372d0c353", "zone_name": "test-example.com", "proxiable": true, "proxied": false, "ttl": 120, "priority": 5, "data": {} } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/dns_records/:record_id \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import DnsRecordsV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " record = DnsRecordsV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " record.set_service_url(endpoint)\n", " resp = record.get_dns_record(\n", " dnsrecord_identifier=\"aaf17ad8008aea8d5f114d4917887ee4\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/dnsrecordsv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &dnsrecordsv1.DnsRecordsV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := dnsrecordsv1.NewDnsRecordsV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewGetDnsRecordOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\tresult, response, err := service.GetDnsRecord(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetDnsRecordOptions getDnsRecordOptions = new GetDnsRecordOptions.Builder()\n", " .dnsrecordIdentifier(identifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.getDnsRecord(getDnsRecordOptions).execute();\n", " DnsrecordResp dnsrecordRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " dnsrecordIdentifier: ${DNS_RECORD_ID},\n", "};\n", "dnsRecordsV1.getDnsRecord(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const dnsRecord = result.result;\n", " console.log(JSON.stringify(dnsRecord, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "put": { "tags": [ "DNS Records" ], "summary": "Update DNS record", "operationId": "update_dns_record", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.reliability.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.dns-records.update" } ] }, "description": "Update an existing DNS record for a given zone under a given service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "dnsrecord_identifier", "description": "Identifier of DNS record", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnsrecord_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "f1aba936b94213e5b8dca0c0dbf1f9cc", "created_on": "2014-01-01T05:20:00.123Z", "modified_on": "2014-01-01T05:20:00.123Z", "name": "host-1.test-example.com", "type": "A", "content": "169.154.10.10", "zone_id": "023e105f4ecef8ad9ca31a8372d0c353", "zone_name": "test-example.com", "proxiable": true, "proxied": false, "ttl": 120, "priority": 5, "data": {} } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnsrecord_update_input" } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/dns_records/:record_id \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "-d '{\n", " \"name\": \"www\",\n", " \"type\": \"A\",\n", " \"content\": \"192.168.127.128\"\n", "}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import DnsRecordsV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " record = DnsRecordsV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " record.set_service_url(endpoint)\n", " record_type = 'A'\n", " name = 'example_ip'\n", " content = '5.5.5.5'\n", " resp = record.update_dns_record(\n", " dnsrecord_identifier=\"aaf17ad8008aea8d5f114d4917887ee4\", type=record_type, name=name, content=content)\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/dnsrecordsv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &dnsrecordsv1.DnsRecordsV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := dnsrecordsv1.NewDnsRecordsV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewUpdateDnsRecordOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\topt.SetContent(\"12.1.1.1\")\n", "\topt.SetType(dnsrecordsv1.UpdateDnsRecordOptions_Type_A)\n", "\topt.SetName(\"host-1.testexample.com\")\n", "\tresult, response, err := service.UpdateDnsRecord(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " UpdateDnsRecordOptions updateDnsRecordOptions = new UpdateDnsRecordOptions.Builder()\n", " .dnsrecordIdentifier(identifier)\n", " .name(\"host-1.test-example.com\")\n", " .type(\"A\")\n", " .ttl(Long.valueOf(\"120\"))\n", " .content(\"1.2.3.4\")\n", " .proxied(false)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.updateDnsRecord(updateDnsRecordOptions).execute();\n", " DnsrecordResp dnsrecordRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " dnsrecordIdentifier: ${DNS_RECORD_ID},\n", " name: 'www-sandbox',\n", " type: 'A',\n", " content: '192.168.117.102',\n", "};\n", "dnsRecordsV1.updateDnsRecord(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const updatedDnsRecord = result.result;\n", " console.log(JSON.stringify(updatedDnsRecord, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/dns_records/batch": { "post": { "tags": [ "DNS Records" ], "summary": "Batch DNS records", "operationId": "batch_dns_records", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.reliability.create" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.dns-records.create" } ] }, "description": "Send a Batch of DNS Record API calls to be executed together. The operations you specify within the /batch request body are always executed in the following order: deletes, patches, puts, posts", "parameters": [ { "in": "path", "name": "crn", "x-sdk-global-param": true, "description": "Full CRN of the service instance", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "zone_identifier", "x-sdk-global-param": true, "description": "Zone identifier (zone id)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch_dns_records_response" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "deletes": [ { "comment": "Domain verification record", "name": "example.com", "proxied": true, "settings": {}, "tags": [], "ttl": 3600, "content": "198.51.100.4", "type": "A", "comment_modified_on": "2024-01-01T05:20:00.12345Z", "created_on": "2014-01-01T05:20:00.12345Z", "id": "023e105f4ecef8ad9ca31a8372d0c353", "meta": {}, "modified_on": "2014-01-01T05:20:00.12345Z", "proxiable": true, "tags_modified_on": "2025-01-01T05:20:00.12345Z" } ], "patches": [ { "comment": "Domain verification record", "name": "example.com", "proxied": true, "settings": {}, "tags": [], "ttl": 3600, "content": "198.51.100.4", "type": "A", "comment_modified_on": "2024-01-01T05:20:00.12345Z", "created_on": "2014-01-01T05:20:00.12345Z", "id": "023e105f4ecef8ad9ca31a8372d0c353", "meta": {}, "modified_on": "2014-01-01T05:20:00.12345Z", "proxiable": true, "tags_modified_on": "2025-01-01T05:20:00.12345Z" } ], "posts": [ { "comment": "Domain verification record", "name": "example.com", "proxied": true, "settings": {}, "tags": [], "ttl": 3600, "content": "198.51.100.4", "type": "A", "comment_modified_on": "2024-01-01T05:20:00.12345Z", "created_on": "2014-01-01T05:20:00.12345Z", "id": "023e105f4ecef8ad9ca31a8372d0c353", "meta": {}, "modified_on": "2014-01-01T05:20:00.12345Z", "proxiable": true, "tags_modified_on": "2025-01-01T05:20:00.12345Z" } ], "puts": [ { "comment": "Domain verification record", "name": "example.com", "proxied": true, "settings": {}, "tags": [], "ttl": 3600, "content": "198.51.100.4", "type": "A", "comment_modified_on": "2024-01-01T05:20:00.12345Z", "created_on": "2014-01-01T05:20:00.12345Z", "id": "023e105f4ecef8ad9ca31a8372d0c353", "meta": {}, "modified_on": "2014-01-01T05:20:00.12345Z", "proxiable": true, "tags_modified_on": "2025-01-01T05:20:00.12345Z" } ] } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \"https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/dns_records/batch\" \\\n", " -H \"x-auth-user-token: Bearer xxxxxx\" \\\n", " -H \"Content-Type: application/json\" \\\n", " -d '{\"posts\": [{\"name\": \"example.com\", \"type\": \"A\", \"content\": \"192.168.1.1\"}]}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import DnsRecordsV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " records = DnsRecordsV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " records.set_service_url(endpoint)\n", " # batch create records\n", " batch_data = {\n", " \"posts\": [\n", " {\n", " \"name\": \"test.example.com\",\n", " \"type\": \"A\",\n", " \"content\": \"192.168.1.1\"\n", " }\n", " ]\n", " }\n", " resp = records.batch_dns_records(batch_data)\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ] } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/batch_dns_records_request" } } } } } }, "/v1/{crn}/zones/{zone_id}/firewall/waf/packages/{pkg_id}/groups": { "get": { "tags": [ "WAF Rule Groups (DEPRECATED)" ], "summary": "List all WAF rule groups", "deprecated": true, "operationId": "list_waf_rule_groups", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.waf-groups.read" } ] }, "description": "List all WAF rule groups contained within a package.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "in": "path", "name": "pkg_id", "required": true, "description": "Package ID", "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": false, "description": "Name of the firewall package", "example": "Wordpress-rules", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "required": false, "description": "Whether or not the rules contained within this group are configurable/usable", "example": "on", "schema": { "type": "string", "enum": [ "on", "off" ], "default": "on" } }, { "in": "query", "name": "rules_count", "required": false, "description": "How many rules are contained within this group", "example": "10", "schema": { "type": "string", "default": "0" } }, { "in": "query", "name": "page", "required": false, "description": "Page number of paginated results", "example": 1, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "in": "query", "name": "per_page", "required": false, "description": "Number of packages per page", "example": 50, "schema": { "type": "integer", "minimum": 5, "maximum": 100, "default": 50 } }, { "in": "query", "name": "order", "required": false, "description": "Field to order packages by", "example": "status", "schema": { "type": "string" } }, { "in": "query", "name": "direction", "required": false, "description": "Direction to order packages", "example": "desc", "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "match", "required": false, "description": "Whether to match all search requirements or at least one (any)", "example": "all", "schema": { "type": "string", "enum": [ "all", "any" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/waf-groups-response" }, "examples": { "response": { "value": { "result": [ { "id": "07d700cf30fda7548be94ff01087d0c4", "name": "OWASP Bad Robots", "description": "Detection of bad web robots that are not from search engines but perform malicious searching and spidering of web sites.", "mode": "on", "package_id": "c504870194831cd12c3fc0284f294abb", "rules_count": 4, "modified_rules_count": 0 }, { "id": "6293bbf04711b8511fc68dfd85d254b3", "name": "OWASP Common Exceptions", "description": "Special rules to reduce false positives.", "mode": "on", "package_id": "c504870194831cd12c3fc0284f294abb", "rules_count": 3, "modified_rules_count": 0 } ], "result_info": { "page": 1, "per_page": 20, "count": 2, "total_count": 2 }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal Server Error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/waf/packages/:pkg_id/groups \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import WafRuleGroupsApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " wafRuleGroupsApi = WafRuleGroupsApiV1.new_instance(\n", " crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " wafRuleGroupsApi.set_service_url(endpoint)\n", " pkg_id = \"c504870194831cd12c3fc0284f294abb\"\n", " resp = wafRuleGroupsApi.list_waf_rule_groups(\n", " pkg_id=pkg_id).get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/wafrulegroupsapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &wafrulegroupsapiv1.WafRuleGroupsApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := wafrulegroupsapiv1.NewWafRuleGroupsApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewListWafRuleGroupsOptions(\"4112ba6c2974ec43886f90736968e838\")\n", "\tresult, response, err := service.ListWafRuleGroups(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ListWafRuleGroupsOptions listWafRuleGroupsOptions = new ListWafRuleGroupsOptions.Builder()\n", " .pkgId(pIdentifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.listWafRuleGroups(listWafRuleGroupsOptions).execute();\n", " WafGroupsResponse wafGroupsResponseResult = response.getResult();\n", " int i = 0;\n", " while (i < wafGroupsResponseResult.getResult().size()) {\n", " gIdentifier = wafGroupsResponseResult.getResult().get(i).getId();\n", " break;\n", " }\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const WafRuleGroupsApiV1 = require('ibm-networking-services/cis/wafrulegroupsapiv1/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "// Initialize the service client.\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "};\n", "\n", "const wafRuleGroupsApiV1 = new WafRuleGroupsApiV1(options);\n", "\n", "const params = {\n", " pkgId: ${wafRulePackageId},\n", "};\n", "wafRuleGroupsApiV1.listWafRuleGroups(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const wafRuleGroups = result.result;\n", " console.log(JSON.stringify(wafRuleGroups, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/firewall/waf/packages/{pkg_id}/groups/{group_id}": { "get": { "tags": [ "WAF Rule Groups (DEPRECATED)" ], "summary": "Get WAF rule group", "deprecated": true, "operationId": "get_waf_rule_group", "description": "Get a single WAF rule group.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "in": "path", "name": "pkg_id", "required": true, "description": "Package ID", "schema": { "type": "string" } }, { "in": "path", "name": "group_id", "required": true, "description": "Group ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/waf-group-response" }, "examples": { "response": { "value": { "result": { "id": "07d700cf30fda7548be94ff01087d0c4", "name": "OWASP Bad Robots", "description": "Detection of bad web robots that are not from search engines but perform malicious searching and spidering of web sites.", "mode": "on", "package_id": "c504870194831cd12c3fc0284f294abb", "rules_count": 4, "modified_rules_count": 0 }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal Server Error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/waf/packages/:pkg_id/groups/:group_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import WafRuleGroupsApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " wafRuleGroupsApi = WafRuleGroupsApiV1.new_instance(\n", " crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " wafRuleGroupsApi.set_service_url(endpoint)\n", " pkg_id = \"c504870194831cd12c3fc0284f294abb\"\n", " group_id = \"07d700cf30fda7548be94ff01087d0c4\"\n", " resp = wafRuleGroupsApi.get_waf_rule_group(\n", " pkg_id=pkg_id, group_id=group_id).get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/wafrulegroupsapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &wafrulegroupsapiv1.WafRuleGroupsApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := wafrulegroupsapiv1.NewWafRuleGroupsApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewGetWafRuleGroupOptions(\"4112ba6c2974ec43886f90736968e838\")\n", "\tresult, response, err := service.GetWafRuleGroup(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetWafRuleGroupOptions getWafRuleGroupOptions = new GetWafRuleGroupOptions.Builder()\n", " .pkgId(pIdentifier)\n", " .groupId(gIdentifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.getWafRuleGroup(getWafRuleGroupOptions).execute();\n", " WafGroupResponse wafGroupResponseResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " pkgId: wafRulePackageId,\n", " groupId: wafRuleGroupId,\n", "};\n", "wafRuleGroupsApiV1.getWafRuleGroup(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const wafRuleGroup = result.result;\n", " console.log(JSON.stringify(wafRuleGroup, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "patch": { "tags": [ "WAF Rule Groups (DEPRECATED)" ], "summary": "Update WAF rule group", "deprecated": true, "operationId": "update_waf_rule_group", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.waf-groups.update" } ] }, "description": "Update the state of a WAF rule group.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "in": "path", "name": "pkg_id", "required": true, "description": "Package ID", "schema": { "type": "string" } }, { "in": "path", "name": "group_id", "required": true, "description": "Group ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/waf-groups-request" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/waf-group-response" }, "examples": { "response": { "value": { "result": { "id": "07d700cf30fda7548be94ff01087d0c4", "name": "OWASP Bad Robots", "description": "Detection of bad web robots that are not from search engines but perform malicious searching and spidering of web sites.", "mode": "on", "package_id": "c504870194831cd12c3fc0284f294abb", "rules_count": 4, "modified_rules_count": 0 }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege to use IBM Cloud Internet Services" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal Server Error" }, "504": { "description": "Gateway Timeout! Backendendpoint did not respond on time" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/waf/packages/:pkg_id/groups/:group_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"mode\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import WafRuleGroupsApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " wafRuleGroupsApi = WafRuleGroupsApiV1.new_instance(\n", " crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " wafRuleGroupsApi.set_service_url(endpoint)\n", " pkg_id = \"c504870194831cd12c3fc0284f294abb\"\n", " group_id = \"07d700cf30fda7548be94ff01087d0c4\"\n", " mode = \"off\"\n", " resp = wafRuleGroupsApi.update_waf_rule_group(\n", " pkg_id=pkg_id, group_id=group_id, mode=mode).get_result()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/wafrulegroupsapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &wafrulegroupsapiv1.WafRuleGroupsApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := wafrulegroupsapiv1.NewWafRuleGroupsApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewUpdateWafRuleGroupOptions(\"4112ba6c2974ec43886f90736968e838\", \"6563ebae141638f92ebbdc4a821bef8c\")\n", "\toptions.SetMode(wafrulegroupsapiv1.UpdateWafRuleGroupOptions_Mode_On)\n", "\tresult, response, err := service.UpdateWafRuleGroup(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " UpdateWafRuleGroupOptions updateWafRuleGroupOptions = new UpdateWafRuleGroupOptions.Builder()\n", " .pkgId(pIdentifier)\n", " .groupId(gIdentifier)\n", " .mode(\"off\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.updateWafRuleGroup(updateWafRuleGroupOptions).execute();\n", " WafGroupResponse wafGroupResponseResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " pkgId: wafRulePackageId,\n", " groupId: wafRuleGroupId,\n", " mode: 'on', // Example\n", "};\n", "wafRuleGroupsApiV1.updateWafRuleGroup(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const updatedWafRuleGroup = result.result;\n", " console.log(JSON.stringify(updatedWafRuleGroup, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/custom_pages": { "get": { "tags": [ "Custom Pages" ], "summary": "List all custom pages for a given instance", "operationId": "list_instance_custom_pages", "description": "List all custom pages for a given instance", "parameters": [ { "$ref": "#/components/parameters/crn" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_custom_pages_resp" }, "examples": { "response": { "value": { "result": [ { "id": "basic_challenge", "description": "Basic Challenge", "required_tokens": [ "::CAPTCHA_BOX::" ], "preview_target": "block:basic-sec-captcha", "created_on": null, "modified_on": null, "url": null, "state": "default" }, { "id": "waf_challenge", "description": "WAF Challenge", "required_tokens": [ "::CAPTCHA_BOX::" ], "preview_target": "block:adv-sec-captcha", "created_on": null, "modified_on": null, "url": null, "state": "default" }, { "id": "waf_block", "description": "WAF Block", "required_tokens": [], "preview_target": "block:waf", "created_on": "2018-05-04T19:05:30.525Z", "modified_on": "2018-05-04T19:06:00.174Z", "url": null, "state": "default" }, { "id": "ratelimit_block", "description": "Rate limit Block", "required_tokens": [], "preview_target": "block:rate-limit", "created_on": null, "modified_on": null, "url": null, "state": "default" }, { "id": "country_challenge", "description": "Country Challenge", "required_tokens": [ "::CAPTCHA_BOX::" ], "preview_target": "block:country-captcha", "created_on": null, "modified_on": null, "url": null, "state": "default" }, { "id": "ip_block", "description": "IP or IP range block", "required_tokens": [], "preview_target": "block:ip-ban", "created_on": "2018-05-15T18:29:51.358Z", "modified_on": "2018-05-15T18:31:19.634Z", "url": null, "state": "default" }, { "id": "under_attack", "description": "I'm Under Attack Mode", "required_tokens": [ "::IM_UNDER_ATTACK_BOX::" ], "preview_target": "block:iuam-basic", "created_on": null, "modified_on": null, "url": null, "state": "default" }, { "id": "500_errors", "description": "5XX Errors", "required_tokens": [ "::CLOUDFLARE_ERROR_500S_BOX::" ], "preview_target": "cf-error:500s", "created_on": "2018-05-04T18:32:58.247Z", "modified_on": "2018-05-04T18:33:03.545Z", "url": null, "state": "default" }, { "id": "1000_errors", "description": "10XX Errors", "required_tokens": [ "::CLOUDFLARE_ERROR_1000S_BOX::" ], "preview_target": "cf-error:1000s", "created_on": null, "modified_on": null, "url": null, "state": "default" }, { "id": "always_online", "description": "Always online", "required_tokens": [ "::ALWAYS_ONLINE_NO_COPY_BOX::" ], "preview_target": "always-online:no-copy", "created_on": null, "modified_on": null, "url": null, "state": "default" } ], "result_info": { "page": 1, "per_page": 20, "total_pages": 1, "count": 10, "total_count": 10 }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/custom_pages \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import CustomPagesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " page = CustomPagesV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " page.set_service_url(endpoint)\n", " resp = page.list_instance_custom_pages()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/custompagesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &custompagesv1.CustomPagesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := custompagesv1.NewCustomPagesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewListInstanceCustomPagesOptions()\n", "\tresult, response, err := service.ListInstanceCustomPages(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ListInstanceCustomPagesOptions listInstanceCustomPagesOptions = new ListInstanceCustomPagesOptions();\n", " // Invoke operation\n", " Response response = service.listInstanceCustomPages(listInstanceCustomPagesOptions).execute();\n", " ListCustomPagesResp listCustomPagesRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const CustomPagesV1 = require('ibm-networking-services/cis/custompagesv1/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "// Initialize the service client.\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "};\n", "\n", "const customPagesV1 = new CustomPagesV1(options);\n", "customPagesV1.listInstanceCustomPages()\n", " .then(response => {\n", " const { result } = response || {};\n", " const instanceCustomPages = result.result;\n", " console.log(JSON.stringify(instanceCustomPages, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/custom_pages/{page_identifier}": { "get": { "tags": [ "Custom Pages" ], "summary": "Get a custom page for a given instance", "operationId": "get_instance_custom_page", "description": "Get a specific custom page for a given instance", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "in": "path", "name": "page_identifier", "description": "Custom page identifier", "required": true, "schema": { "type": "string", "enum": [ "basic_challenge", "waf_challenge", "waf_block", "ratelimit_block", "country_challenge", "ip_block", "under_attack", "500_errors", "1000_errors", "always_online" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_page_specific_resp" }, "examples": { "response": { "value": { "result": { "id": "basic_challenge", "description": "Basic Challenge", "required_tokens": [ "::CAPTCHA_BOX::" ], "preview_target": "block:basic-sec-captcha", "created_on": "2019-03-28T02:39:06.656Z", "modified_on": "2019-04-01T07:17:18.358Z", "url": "https://www.example.com/basic_challenge_error.html", "state": "customized" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/custom_pages/basic_challenge \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import CustomPagesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " page = CustomPagesV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " page.set_service_url(endpoint)\n", " resp = page.get_instance_custom_page(page_identifier=\"basic_challenge\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/custompagesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &custompagesv1.CustomPagesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := custompagesv1.NewCustomPagesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewGetInstanceCustomPageOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\tresult, response, err := service.GetInstanceCustomPage(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetInstanceCustomPageOptions getInstanceCustomPageOptions = new GetInstanceCustomPageOptions.Builder()\n", " .pageIdentifier(\"basic_challenge\")\n", " .build();\n", " // Invoke operation\n", " Response response = service.getInstanceCustomPage(getInstanceCustomPageOptions).execute();\n", " CustomPageSpecificResp customPageSpecificRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " pageIdentifier: ${instanceCustomPageId},\n", "};\n", "customPagesV1.getInstanceCustomPage(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const instanceCustomPage = result.result;\n", " console.log(JSON.stringify(instanceCustomPage, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "put": { "tags": [ "Custom Pages" ], "summary": "Update a custom page for a given instance", "operationId": "update_instance_custom_page", "description": "Update a specific custom page for a given instance", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "in": "path", "name": "page_identifier", "description": "Custom page identifier", "required": true, "schema": { "type": "string", "enum": [ "basic_challenge", "waf_challenge", "waf_block", "ratelimit_block", "country_challenge", "ip_block", "under_attack", "500_errors", "1000_errors", "always_online" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_page_request" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_page_specific_resp" }, "examples": { "response": { "value": { "result": { "id": "basic_challenge", "description": "Basic Challenge", "required_tokens": [ "::CAPTCHA_BOX::" ], "preview_target": "block:basic-sec-captcha", "created_on": "2019-03-28T02:39:06.656Z", "modified_on": "2019-04-01T07:17:18.358Z", "url": "https://www.example.com/basic_challenge_error.html", "state": "customized" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/custom_pages/basic_challenge \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "--data '{ \\\n", " \"url\": \"https://www.example.com/basic_challenge_error.html\", \\\n", " \"state\": \"customized\" \\\n", " }'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import CustomPagesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " page = CustomPagesV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " page.set_service_url(endpoint)\n", " resp = page.update_instance_custom_page(\n", " page_identifier=\"basic_challenge\", url=\"https://example.com/index.html\", state=\"customized\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/custompagesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &custompagesv1.CustomPagesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := custompagesv1.NewCustomPagesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewUpdateInstanceCustomPageOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\topt.SetState(custompagesv1.UpdateInstanceCustomPageOptions_State_Customized)\n", "\topt.SetURL(os.Getenv(\"URL\"))\n", "\tresult, response, err := service.UpdateInstanceCustomPage(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " UpdateInstanceCustomPageOptions updateInstanceCustomPageOptions = new UpdateInstanceCustomPageOptions.Builder()\n", " .pageIdentifier(\"basic_challenge\")\n", " .url(\"http://beta.travis-kuganes1.sdk.cistest-load.com/\")\n", " .state(\"customized\")\n", " .build();\n", " // Invoke operation\n", " Response response = service.updateInstanceCustomPage(updateInstanceCustomPageOptions).execute();\n", " CustomPageSpecificResp customPageSpecificRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " pageIdentifier: ${instanceCustomPageId},\n", " url: ${CUSTOM_PAGE_URL},\n", " state: 'customized',\n", "};\n", "customPagesV1.updateInstanceCustomPage(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const updatedInstanceCustomPage = result.result;\n", " console.log(JSON.stringify(updatedInstanceCustomPage, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/custom_pages": { "get": { "tags": [ "Custom Pages" ], "summary": "List all custom pages for a given zone", "operationId": "list_zone_custom_pages", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.custom-pages.read" } ] }, "description": "List all custom pages for a given zone", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_custom_pages_resp" }, "examples": { "response": { "value": { "result": [ { "id": "basic_challenge", "description": "Basic Challenge", "required_tokens": [ "::CAPTCHA_BOX::" ], "preview_target": "block:basic-sec-captcha", "created_on": null, "modified_on": null, "url": null, "state": "default" }, { "id": "waf_challenge", "description": "WAF Challenge", "required_tokens": [ "::CAPTCHA_BOX::" ], "preview_target": "block:adv-sec-captcha", "created_on": null, "modified_on": null, "url": null, "state": "default" }, { "id": "waf_block", "description": "WAF Block", "required_tokens": [], "preview_target": "block:waf", "created_on": "2018-05-04T19:05:30.525Z", "modified_on": "2018-05-04T19:06:00.174Z", "url": null, "state": "default" }, { "id": "ratelimit_block", "description": "Rate limit Block", "required_tokens": [], "preview_target": "block:rate-limit", "created_on": null, "modified_on": null, "url": null, "state": "default" }, { "id": "country_challenge", "description": "Country Challenge", "required_tokens": [ "::CAPTCHA_BOX::" ], "preview_target": "block:country-captcha", "created_on": null, "modified_on": null, "url": null, "state": "default" }, { "id": "ip_block", "description": "IP or IP range block", "required_tokens": [], "preview_target": "block:ip-ban", "created_on": "2018-05-15T18:29:51.358Z", "modified_on": "2018-05-15T18:31:19.634Z", "url": null, "state": "default" }, { "id": "under_attack", "description": "I'm Under Attack Mode", "required_tokens": [ "::IM_UNDER_ATTACK_BOX::" ], "preview_target": "block:iuam-basic", "created_on": null, "modified_on": null, "url": null, "state": "default" }, { "id": "500_errors", "description": "5XX Errors", "required_tokens": [ "::CLOUDFLARE_ERROR_500S_BOX::" ], "preview_target": "cf-error:500s", "created_on": "2018-05-04T18:32:58.247Z", "modified_on": "2018-05-04T18:33:03.545Z", "url": null, "state": "default" }, { "id": "1000_errors", "description": "10XX Errors", "required_tokens": [ "::CLOUDFLARE_ERROR_1000S_BOX::" ], "preview_target": "cf-error:1000s", "created_on": null, "modified_on": null, "url": null, "state": "default" }, { "id": "always_online", "description": "Always online", "required_tokens": [ "::ALWAYS_ONLINE_NO_COPY_BOX::" ], "preview_target": "always-online:no-copy", "created_on": null, "modified_on": null, "url": null, "state": "default" } ], "result_info": { "page": 1, "per_page": 20, "total_pages": 1, "count": 10, "total_count": 10 }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_identifier/custom_pages \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import CustomPagesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " page = CustomPagesV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " page.set_service_url(endpoint)\n", " resp = page.list_zone_custom_pages()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/custompagesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &custompagesv1.CustomPagesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := custompagesv1.NewCustomPagesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewListZoneCustomPagesOptions()\n", "\tresult, response, err := service.ListZoneCustomPages(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ListZoneCustomPagesOptions listZoneCustomPagesOptions = new ListZoneCustomPagesOptions();\n", " // Invoke operation\n", " Response response = service.listZoneCustomPages(listZoneCustomPagesOptions).execute();\n", " ListCustomPagesResp listCustomPagesRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "customPagesV1.listZoneCustomPages()\n", " .then(response => {\n", " const { result } = response || {};\n", " const zoneCustomPages = result.result;\n", " console.log(JSON.stringify(zoneCustomPages, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/custom_pages/{page_identifier}": { "get": { "tags": [ "Custom Pages" ], "summary": "Get a custom page for a given zone", "operationId": "get_zone_custom_page", "description": "Get a specific custom page for a given zone", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "page_identifier", "description": "Custom page identifier", "required": true, "schema": { "type": "string", "enum": [ "basic_challenge", "waf_challenge", "waf_block", "ratelimit_block", "country_challenge", "ip_block", "under_attack", "500_errors", "1000_errors", "always_online" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_page_specific_resp" }, "examples": { "response": { "value": { "result": { "id": "basic_challenge", "description": "Basic Challenge", "required_tokens": [ "::CAPTCHA_BOX::" ], "preview_target": "block:basic-sec-captcha", "created_on": "2019-03-28T02:39:06.656Z", "modified_on": "2019-04-01T07:17:18.358Z", "url": "https://www.example.com/basic_challenge_error.html", "state": "customized" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_identifier/custom_pages/basic_challenge \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import CustomPagesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " page = CustomPagesV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " page.set_service_url(endpoint)\n", " resp = page.get_zone_custom_page(page_identifier=\"basic_challenge\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/custompagesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &custompagesv1.CustomPagesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := custompagesv1.NewCustomPagesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewGetZoneCustomPageOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\tresult, response, err := service.GetZoneCustomPage(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetZoneCustomPageOptions getZoneCustomPageOptions = new GetZoneCustomPageOptions.Builder()\n", " .pageIdentifier(\"basic_challenge\")\n", " .build();\n", " // Invoke operation\n", " Response response = service.getZoneCustomPage(getZoneCustomPageOptions).execute();\n", " CustomPageSpecificResp customPageSpecificRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " pageIdentifier: ${zoneCustomPageId},\n", "};\n", "customPagesV1.getZoneCustomPage(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const zoneCustomPage = result.result;\n", " console.log(JSON.stringify(zoneCustomPage, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "put": { "tags": [ "Custom Pages" ], "summary": "Update a custom page for a given zone", "operationId": "update_zone_custom_page", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.custom-pages.update" } ] }, "description": "Update a specific custom page for a given zone", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "page_identifier", "description": "Custom page identifier", "required": true, "schema": { "type": "string", "enum": [ "basic_challenge", "waf_challenge", "waf_block", "ratelimit_block", "country_challenge", "ip_block", "under_attack", "500_errors", "1000_errors", "always_online" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_page_request" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_page_specific_resp" }, "examples": { "response": { "value": { "result": { "id": "basic_challenge", "description": "Basic Challenge", "required_tokens": [ "::CAPTCHA_BOX::" ], "preview_target": "block:basic-sec-captcha", "created_on": "2019-03-28T02:39:06.656Z", "modified_on": "2019-04-01T07:17:18.358Z", "url": "https://www.example.com/basic_challenge_error.html", "state": "customized" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_identifier/custom_pages/basic_challenge \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "--data '{ \\\n", " \"url\": \"https://www.example.com/basic_challenge_error.html\", \\\n", " \"state\": \"customized\" \\\n", " }'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import CustomPagesV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " url = \"https://example.com/index.html\"\n", " state = \"default\"\n", " page = CustomPagesV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " page.set_service_url(endpoint)\n", " resp = page.update_zone_custom_page(\n", " page_identifier=\"basic_challenge\", url=url, state=state)\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/custompagesv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &custompagesv1.CustomPagesV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := custompagesv1.NewCustomPagesV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewUpdateZoneCustomPageOptions(custompagesv1.UpdateInstanceCustomPageOptions_PageIdentifier_IpBlock)\n", "\topt.SetState(custompagesv1.UpdateZoneCustomPageOptions_State_Customized)\n", "\topt.SetURL(os.Getenv(\"URL\"))\n", "\tresult, response, err := service.UpdateZoneCustomPage(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " UpdateZoneCustomPageOptions updateZoneCustomPageOptions = new UpdateZoneCustomPageOptions.Builder()\n", " .pageIdentifier(\"basic_challenge\")\n", " .url(\"http://beta.travis-kuganes1.sdk.cistest-load.com/\")\n", " .state(\"customized\")\n", " .build();\n", " // Invoke operation\n", " Response response = service.updateZoneCustomPage(updateZoneCustomPageOptions).execute();\n", " CustomPageSpecificResp customPageSpecificRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " pageIdentifier: ${zoneCustomPageId},\n", " url: ${CUSTOM_PAGE_URL},\n", " state: 'customized',\n", "};\n", "customPagesV1.updateZoneCustomPage(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const updatedZoneCustomPage = result.result;\n", " console.log(JSON.stringify(updatedZoneCustomPage, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/security/events": { "get": { "tags": [ "Security Events (DEPRECATED)" ], "summary": "Logs of the mitigations performed by Firewall features", "deprecated": true, "operationId": "security_events", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.security-events.read" } ] }, "description": "Provides a full log of the mitigations performed by the CIS Firewall features including; Firewall Rules, Rate Limiting, Security Level, Access Rules (IP, IP Range, ASN, and Country), WAF (Web Application Firewall), User Agent Blocking, Zone Lockdown, and Advanced DDoS Protection. (DEPRECATED: use Firewall Event Analytics API instead)", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "in": "query", "name": "ip_class", "description": "IP class is a map of client IP to visitor classification.", "required": false, "schema": { "type": "string", "enum": [ "unknown", "clean", "badHost", "searchEngine", "whitelist", "greylist", "monitoringService", "securityScanner", "noRecord", "scan", "backupService", "mobilePlatform", "tor" ] } }, { "in": "query", "name": "method", "description": "The HTTP method of the request.", "required": false, "schema": { "type": "string", "enum": [ "GET", "POST", "DELETE", "PUT", "HEAD", "PURGE", "OPTIONS", "PROPFIND", "MKCOL", "PATCH", "ACL", "BCOPY", "BDELETE", "BMOVE", "BPROPFIND", "BPROPPATCH", "CHECKIN", "CHECKOUT", "CONNECT", "COPY", "LABEL", "LOCK", "MERGE", "MKACTIVITY", "MKWORKSPACE", "MOVE", "NOTIFY", "ORDERPATCH", "POLL", "PROPPATCH", "REPORT", "SEARCH", "SUBSCRIBE", "TRACE", "UNCHECKOUT", "UNLOCK", "UNSUBSCRIBE", "UPDATE", "VERSION-CONTROL", "BASELINE-CONTROL", "X-MS-ENUMATTS", "RPC_OUT_DATA", "RPC_IN_DATA", "JSON", "COOK", "TRACK" ] } }, { "in": "query", "name": "scheme", "description": "The scheme of the uri", "required": false, "schema": { "type": "string", "enum": [ "unknown", "http", "https" ] } }, { "in": "query", "name": "ip", "description": "The IPv4 or IPv6 address from which the request originated", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "host", "description": "The hostname the request attempted to access", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "proto", "description": "The protocol of the request", "required": false, "schema": { "type": "string", "enum": [ "UNK", "HTTP/1.0", "HTTP/1.1", "HTTP/1.2", "HTTP/2", "SPDY/3.1" ] } }, { "in": "query", "name": "uri", "description": "The URI requested from the hostname", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "ua", "description": "The client user agent that initiated the request", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "colo", "description": "The 3-letter CF PoP code", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "ray_id", "description": "Ray ID of the request", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "kind", "description": "Kind of events. Now it is only firewall.", "required": false, "schema": { "type": "string", "enum": [ "firewall" ] } }, { "in": "query", "name": "action", "description": "What type of action was taken", "required": false, "schema": { "type": "string", "enum": [ "unknown", "allow", "drop", "challenge", "jschallenge", "simulate", "connectionClose", "log" ] } }, { "in": "query", "name": "cursor", "description": "Cursor position and direction for requesting next set of records when amount of results was limited by the limit parameter. A valid value for the cursor can be obtained from the cursors object in the result_info structure.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "country", "description": "The 2-digit country code in which the request originated", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "since", "description": "Start date and time of requesting data period in the ISO8601 format. Can't go back more than a year.", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "source", "description": "Source of the event", "required": false, "schema": { "type": "string", "enum": [ "unknown", "asn", "country", "ip", "ipRange", "securityLevel", "zoneLockdown", "waf", "uaBlock", "rateLimit", "firewallRules", "bic", "hot", "l7ddos" ] } }, { "in": "query", "name": "limit", "description": "The number of events to return", "required": false, "schema": { "type": "integer", "minimum": 10, "maximum": 1000, "default": 50 } }, { "in": "query", "name": "rule_id", "description": "The ID of the rule that triggered the event, should be considered in the context of source.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "until", "description": "End date and time of requesting data period in the ISO8601 format", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/security_events" }, "examples": { "response": { "value": { "result": [ { "ray_id": "4c6392789858b224", "kind": "firewall", "source": "rateLimit", "action": "drop", "rule_id": "fe38bd35ca284de69b5ecbaa6db87dc3", "ip": "192.168.1.1", "ip_class": "noRecord", "country": "CN", "colo": "HKG", "host": "www.example.com", "method": "GET", "proto": "HTTP/2", "scheme": "https", "ua": "curl/7.61.1", "uri": "/", "matches": [ { "rule_id": "fe38bd35ca284de69b5ecbaa6db87dc3", "source": "rateLimit", "action": "drop", "metadata": { "ruleSrc": "user" } } ], "occurred_at": "2019-04-12T07:43:56.000Z" } ], "result_info": { "cursors": { "after": "bnRIiaU-14b2YBxIefX28h7Zqw50XXPA4Vu4Sa-DPa4qaGH-z47uwtOR0Hm2Y3cSh56raQb1POqaBwGXD44", "before": "dmmGxcD665xj3RiQ8eRqclts94GF3M4KpHEJ7AVekLtOUsHLHssfGaV_d8nZgLszk_iElB9LckPhFgmkTXHX" }, "scanned_range": { "since": "2019-04-12T07:44:18.000Z", "until": "2019-04-12T07:44:18.000Z" } }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad input parameter" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/security/events?source=rateLimit \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import SecurityEventsApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " event = SecurityEventsApiV1.new_instance(crn=crn, zone_id=zone_id, service_name=\"cis_services\")\n", " event.set_service_url(endpoint)\n", " resp = event.security_events()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/securityeventsapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &securityeventsapiv1.SecurityEventsApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneID: &zoneID,\n", "\t}\n", "\tservice, serviceErr := securityeventsapiv1.NewSecurityEventsApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewSecurityEventsOptions()\n", "\tresult, response, err := service.SecurityEvents(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " SecurityEventsOptions securityEventsOptions = new SecurityEventsOptions.Builder()\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.securityEvents(securityEventsOptions).execute();\n", " SecurityEvents securityEventsResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const SecurityEventsApiV1 = require('ibm-networking-services/cis/securityeventsapiv1/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "// Initialize the service client.\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "};\n", "\n", "const securityEventsApiV1 = new SecurityEventsApiV1(options);\n", "\n", "securityEventsApiV1.securityEvents()\n", " .then(response => {\n", " const { result } = response || {};\n", " const securityEvents = result.result;\n", " console.log(JSON.stringify(securityEvents, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/workers/scripts": { "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/X-Correlation-ID" } ], "get": { "tags": [ "Edge Functions Actions" ], "summary": "Get all edge functions scripts", "operationId": "list_edge_functions_actions", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.performance.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.edge-functions-scripts.read" } ] }, "description": "Get all edge functions scripts for a given instance.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_edge_functions_actions_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": [ { "script": "addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })", "etag": "ea95132c15732412d22c1476fa83f27a", "handlers": [ "fetch" ], "modified_on": "2100-01-01T05:20:00Z", "created_on": "2100-01-01T05:20:00Z", "routes": [ { "id": "9a7806061c88ada191ed06f989cc3dac", "pattern": "example.net/*", "script": "this-is_my_script-01", "request_limit_fail_open": false } ] } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/workers/scripts \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/v4/core\"\n", "\t\"github.com/IBM/networking-go-sdk/edgefunctionsapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &edgefunctionsapiv1.EdgeFunctionsApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := edgefunctionsapiv1.NewEdgeFunctionsApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewListEdgeFunctionsActionsOptions()\n", "\tresult, response, err := service.ListEdgeFunctionsActions(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result, response)\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const EdgeFunctionsAPI = require('ibm-networking-services/cis/edgefunctionsapiv1/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "}\n", "\n", "const edgeFunctionApi = new EdgeFunctionsAPI(options);\n", "\n", "edgeFunctionApi.listEdgeFunctionsActions({})\n", " .then(response => {\n", " const edgeFunctionList = response.result.result;\n", " console.log(edgeFunctionList);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/workers/scripts/{script_name}": { "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/script_name" }, { "$ref": "#/components/parameters/X-Correlation-ID" } ], "put": { "tags": [ "Edge Functions Actions" ], "summary": "Upload or replace an edge functions action", "operationId": "update_edge_functions_action", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.performance.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.edge-functions-scripts.update" } ] }, "x-codegen-request-body-name": "edge_functions_action", "description": "Upload or replace an exitsing edge functions action for a given instance.", "requestBody": { "content": { "application/javascript": { "schema": { "type": "string", "example": "addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })" } } }, "description": "Upload or replace an edge functions action." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_edge_functions_action_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "script": "addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })", "etag": "ea95132c15732412d22c1476fa83f27a", "handlers": [ "fetch" ], "modified_on": "2100-01-01T05:20:00Z", "created_on": "2100-01-01T05:20:00Z", "routes": [ { "id": "9a7806061c88ada191ed06f989cc3dac", "pattern": "example.net/*", "script": "this-is_my_script-01", "request_limit_fail_open": false } ] } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/workers/scripts/:script_name \\\n", "-H 'content-type: application/javascript' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "--data 'addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })'" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/v4/core\"\n", "\t\"github.com/IBM/networking-go-sdk/edgefunctionsapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &edgefunctionsapiv1.EdgeFunctionsApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := edgefunctionsapiv1.NewEdgeFunctionsApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewUpdateEdgeFunctionsActionOptions(\"script-sample\")\n", "\tresult, response, err := service.UpdateEdgeFunctionsAction(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result.Script, response)\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " scriptName: 'test-script',\n", " edgeFunctionsAction: `addEventListener('fetch', (event) => {\n", " event.respondWith(handleRequest(event.request))})`\n", "};\n", "\n", "edgeFunctionApi.updateEdgeFunctionsAction(params)\n", " .then(response => {\n", " const updatedScript = response.result.result;\n", " console.log(updatedScript);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "get": { "tags": [ "Edge Functions Actions" ], "summary": "Download a edge functions action", "operationId": "get_edge_functions_action", "description": "Fetch raw script content for your worker. Note this is the original script content, not JSON encoded.", "responses": { "200": { "description": "Success", "content": { "application/javascript": { "schema": { "type": "string", "format": "binary", "example": "addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })", "description": "Download a new edge functions action." }, "examples": { "response": { "value": "addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/workers/scripts/:script_name \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/v4/core\"\n", "\t\"github.com/IBM/networking-go-sdk/edgefunctionsapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &edgefunctionsapiv1.EdgeFunctionsApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := edgefunctionsapiv1.NewEdgeFunctionsApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewGetEdgeFunctionsActionOptions(\"script-sample\")\n", "\tresult, response, err := service.GetEdgeFunctionsAction(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result, response)\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "edgeFunctionApi.getEdgeFunctionsAction({\n", " scriptName: ${scriptName},\n", "})\n", " .then(response => {\n", " const edgeFunctionConfig = response.result.result;\n", " console.log(edgeFunctionConfig);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "delete": { "tags": [ "Edge Functions Actions" ], "summary": "Delete a edge functions action", "operationId": "delete_edge_functions_action", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.performance.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.edge-functions-scripts.delete" } ] }, "description": "Delete an edge functions action for a given instance.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_edge_functions_action_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "9a7806061c88ada191ed06f989cc3dac" } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/workers/scripts/:script_name \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/v4/core\"\n", "\t\"github.com/IBM/networking-go-sdk/edgefunctionsapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &edgefunctionsapiv1.EdgeFunctionsApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := edgefunctionsapiv1.NewEdgeFunctionsApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewDeleteEdgeFunctionsActionOptions(\"script-sample\")\n", "\tresult, response, err := service.DeleteEdgeFunctionsAction(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response)\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "edgeFunctionApi.deleteEdgeFunctionsAction({\n", " scriptName: ${scriptName},\n", "})\n", " .then(response => {\n", " console.log(response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/workers/routes": { "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "$ref": "#/components/parameters/X-Correlation-ID" } ], "post": { "tags": [ "Edge Functions Triggers" ], "summary": "Create an edge functions trigger", "operationId": "create_edge_functions_trigger", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.performance.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.edge-functions-routes.create" } ] }, "description": "Create an edge functions trigger on a given zone", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edge_functions_trigger_req" } } }, "description": "Create an edge functions trigger request." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_edge_functions_trigger_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "9a7806061c88ada191ed06f989cc3dac" } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/workers/routes \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n", " --data '{\"pattern\":\"example.net/*\",\"script\":\"this-is_my_script-01\"}'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/v4/core\"\n", "\t\"github.com/IBM/networking-go-sdk/edgefunctionsapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &edgefunctionsapiv1.EdgeFunctionsApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := edgefunctionsapiv1.NewEdgeFunctionsApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewCreateEdgeFunctionsTriggerOptions()\n", "\topt.SetScript(\"addEventListener('fetch', (event) => {\\nevent.respondWith(handleRequest(event.request))\\n})\")\n", "\topt.SetPattern(\"example.com/*\")\n", "\topt.SetScript(\"script-sample\")\n", "\tresult, response, err := service.CreateEdgeFunctionsTrigger(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response)\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const triggerParams = {\n", " script: 'test-script',\n", " pattern: 'sdk.example.com',\n", "}\n", "\n", "edgeFunctionApi.createEdgeFunctionsTrigger(triggerParams)\n", " .then(response => {\n", " const newTrigger = response.result.result;\n", " console.log(newTrigger);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "get": { "tags": [ "Edge Functions Triggers" ], "summary": "List all edge functions triggers", "operationId": "list_edge_functions_triggers", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.performance.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.edge-functions-routes.read" } ] }, "description": "List all edge functions triggers on a given zone", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_edge_functions_triggers_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": [ { "id": "9a7806061c88ada191ed06f989cc3dac", "pattern": "example.net/*", "script": "this-is_my_script-01", "request_limit_fail_open": false } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/workers/routes \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/v4/core\"\n", "\t\"github.com/IBM/networking-go-sdk/edgefunctionsapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &edgefunctionsapiv1.EdgeFunctionsApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := edgefunctionsapiv1.NewEdgeFunctionsApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewListEdgeFunctionsTriggersOptions()\n", "\tresult, response, err := service.ListEdgeFunctionsTriggers(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result, response)\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "edgeFunctionApi.listEdgeFunctionsTriggers({})\n", " .then(response => {\n", " const triggerList = response.result.result;\n", " console.log(triggerList);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/workers/routes/{route_id}": { "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "$ref": "#/components/parameters/route_id" }, { "$ref": "#/components/parameters/X-Correlation-ID" } ], "get": { "tags": [ "Edge Functions Triggers" ], "summary": "Get an edge functions trigger", "operationId": "get_edge_functions_trigger", "description": "Get an edge functions trigger on a given zone.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_edge_functions_trigger_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "9a7806061c88ada191ed06f989cc3dac", "pattern": "example.net/*", "script": "this-is_my_script-01", "request_limit_fail_open": false } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/workers/routes/:route_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/v4/core\"\n", "\t\"github.com/IBM/networking-go-sdk/edgefunctionsapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &edgefunctionsapiv1.EdgeFunctionsApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := edgefunctionsapiv1.NewEdgeFunctionsApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewGetEdgeFunctionsTriggerOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\tresult, response, err := service.GetEdgeFunctionsTrigger(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response)\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "edgeFunctionApi.getEdgeFunctionsTrigger({\n", " routeId: ${triggerId},\n", "})\n", " .then(response => {\n", " const trigger = response.result.result;\n", " console.log(trigger);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "put": { "tags": [ "Edge Functions Triggers" ], "summary": "Update an edge functions trigger", "operationId": "update_edge_functions_trigger", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.performance.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.edge-functions-routes.update" } ] }, "description": "Update an edge functions trigger on a given zone.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/edge_functions_trigger_req" } } }, "description": "Update an edge functions trigger request." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_edge_functions_trigger_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "9a7806061c88ada191ed06f989cc3dac", "pattern": "example.net/*", "script": "this-is_my_script-01", "request_limit_fail_open": false } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/workers/routes/:route_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n", " --data '{\"pattern\":\"example.net/*\",\"script\":\"this-is_my_script-01\"}'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/v4/core\"\n", "\t\"github.com/IBM/networking-go-sdk/edgefunctionsapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &edgefunctionsapiv1.EdgeFunctionsApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := edgefunctionsapiv1.NewEdgeFunctionsApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewUpdateEdgeFunctionsTriggerOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\topt.SetScript(\"addEventListener('fetch', (event) => {\\nevent.respondWith(handleRequest(event.request))\\n})\")\n", "\topt.SetPattern(\"example.com/*\")\n", "\topt.SetScript(\"script-sample\")\n", "\tresult, response, err := service.UpdateEdgeFunctionsTrigger(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response)\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const triggerParams = {\n", " pattern: 'sdk.example.com',\n", " routeId: ${triggerId},\n", "}\n", "\n", "edgeFunctionApi.updateEdgeFunctionsTrigger(triggerParams)\n", " .then(response => {\n", " const updatedTrigger = response.result.result;\n", " console.log(updatedTrigger);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "delete": { "tags": [ "Edge Functions Triggers" ], "summary": "Delete an edge functions trigger", "operationId": "delete_edge_functions_trigger", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.performance.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.edge-functions-routes.delete" } ] }, "description": "Delete an edge functions trigger on a given zone.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_edge_functions_trigger_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "9a7806061c88ada191ed06f989cc3dac" } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/workers/routes/:route_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/v4/core\"\n", "\t\"github.com/IBM/networking-go-sdk/edgefunctionsapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &edgefunctionsapiv1.EdgeFunctionsApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := edgefunctionsapiv1.NewEdgeFunctionsApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\topt := service.NewDeleteEdgeFunctionsTriggerOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\tresult, response, err := service.DeleteEdgeFunctionsTrigger(opt)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response)\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "edgeFunctionApi.deleteEdgeFunctionsTrigger({\n", " routeId: ${triggerId},\n", "})\n", " .then(response => {\n", " console.log( response.result.result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/range/apps": { "get": { "tags": [ "Range Applications" ], "summary": "List range applications", "description": "Get a list of currently existing Range Applications inside a zone.", "operationId": "list_range_apps", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.range-apps.read" } ] }, "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "name": "page", "in": "query", "description": "Page number of paginated results.", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Maximum number of Range applications per page.", "required": false, "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 100 } }, { "name": "order", "in": "query", "description": "Field by which to order the list of Range applications.", "required": false, "schema": { "type": "string", "enum": [ "protocol", "app_id", "created_on", "modified_on", "dns" ], "default": "dns" } }, { "name": "direction", "in": "query", "description": "Direction in which to order results [ascending/descending order].", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/range_applications" }, "example": { "success": true, "errors": [], "messages": [], "result": [ { "id": "ea95132c15732412d22c1476fa83f27a", "protocol": "tcp/22", "dns": { "type": "CNAME", "name": "ssh.example.com" }, "origin_direct": [ "tcp://192.0.2.1:22" ], "proxy_protocol": "v1", "ip_firewall": true, "traffic_type": "direct", "edge_ips": { "type": "dynamic", "connectivity": "ipv4" }, "tls": "full", "created_on": "2014-01-02T02:20:00.000Z", "modified_on": "2014-01-02T02:20:00.000Z" } ] } } } }, "400": { "description": "Bad Request", "content": {} }, "403": { "description": "Forbidden! User has no privilege", "content": {} }, "404": { "description": "Resource not found", "content": {} }, "500": { "description": "Internal server error", "content": {} } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \"https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/range/apps\" \\\n", " -H \"x-auth-user-token: Bearer xxxxxx\" \\\n", " -H \"Content-Type: application/json\"\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import RangeApplicationsV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " app = RangeApplicationsV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " app.set_service_url(endpoint)\n", " resp = app.list_range_apps(page=2, per_page=5, order=\"created_on\", direction=\"asc\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/rangeapplicationsv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &rangeapplicationsv1.RangeApplicationsV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := rangeapplicationsv1.NewRangeApplicationsV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\n", "\toptions := service.NewListRangeAppsOptions()\n", "\tresult, response, err := service.ListRangeApps(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ListRangeAppsOptions listRangeAppsOptions = new ListRangeAppsOptions.Builder()\n", " .page(Long.valueOf(\"26\"))\n", " .perPage(Long.valueOf(\"1\"))\n", " .order(\"protocol\")\n", " .direction(\"asc\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.listRangeApps(listRangeAppsOptions).execute();\n", " RangeApplications rangeApplicationsResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const RangeApplicationsV1 = require('ibm-networking-services/cis/rangeapplicationsv1/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "// Initialize the service client.\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "};\n", "\n", "const rangeApplicationsV1 = new RangeApplicationsV1(options);\n", "rangeApplicationsV1.listRangeApps()\n", " .then(response => {\n", " const { result } = response || {};\n", " const rangeApps = result.result;\n", " console.log(JSON.stringify(rangeApps, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "post": { "tags": [ "Range Applications" ], "summary": "Create Range Application", "description": "Create a Range Applications inside a zone.", "operationId": "create_range_app", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.range-apps.create" } ] }, "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "description": "Create a range app", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/range_app_req" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/range_application_resp" }, "example": { "success": true, "errors": [], "messages": [], "result": { "id": "ea95132c15732412d22c1476fa83f27a", "protocol": "tcp/22", "dns": { "type": "CNAME", "name": "ssh.example.com" }, "origin_direct": [ "tcp://192.0.2.1:22" ], "proxy_protocol": true, "ip_firewall": true, "traffic_type": "direct", "edge_ips": { "type": "dynamic", "conectivity": "ipv4" }, "created_on": "2014-01-02T02:20:00.000Z", "modified_on": "2014-01-02T02:20:00.000Z" } } } } }, "400": { "description": "Bad Request", "content": {} }, "403": { "description": "Forbidden! User has no privilege", "content": {} }, "404": { "description": "Resource not found", "content": {} }, "500": { "description": "Internal server error", "content": {} } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/range/apps", " -H 'content-type: application/json'", " -H 'x-auth-user-token: Bearer xxxxxx'", " -d '{\"protocol\":\"tcp/22\",\"dns\":{\"type\":\"CNAME\",\"name\":\"origin.example.com\"},\"origin_direct\":[\"tcp://192.0.2.1:22\"],\"proxy_protocol\":true,\"ip_firewall\":true}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import RangeApplicationsV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " app = RangeApplicationsV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " app.set_service_url(endpoint)\n", " protocol = \"tcp/22\"\n", " dns = {\n", " \"type\": \"CNAME\",\n", " \"name\": \"example.com\"\n", " }\n", " origin_direct = [\"tcp://12.1.1.1:22\"]\n", " origin_port = 22\n", " ip_firewall = True\n", " proxy_protocol = \"off\"\n", " edge_ips = {\n", " \"type\": \"dynamic\",\n", " \"connectivity\": \"all\"\n", " }\n", " traffic_type = \"direct\"\n", " tls = \"off\"\n", " resp = app.create_range_app(protocol=protocol, dns=dns, origin_direct=origin_direct, origin_port=origin_port,\n", " ip_firewall=ip_firewall, proxy_protocol=proxy_protocol, edge_ips=edge_ips, traffic_type=traffic_type, tls=tls)\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/rangeapplicationsv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &rangeapplicationsv1.RangeApplicationsV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := rangeapplicationsv1.NewRangeApplicationsV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\n", "\toriginDirect := []string{\"tcp://12.12.12.12:25\"}\n", "\tprotocol := \"tcp/22\"\n", "\tdnsName := \"example.test.com\"\n", "\tdnsOpt := &rangeapplicationsv1.RangeAppReqDns{\n", "\t\tType: core.StringPtr(rangeapplicationsv1.RangeApplicationObjectDns_Type_Cname),\n", "\t\tName: core.StringPtr(dnsName),\n", "\t}\n", "\tedgeIPs := &rangeapplicationsv1.RangeAppReqEdgeIps{\n", "\t\tType: core.StringPtr(rangeapplicationsv1.RangeAppReqEdgeIps_Type_Dynamic),\n", "\t\tConnectivity: core.StringPtr(rangeapplicationsv1.RangeAppReqEdgeIps_Connectivity_All),\n", "\t}\n", "\toptions := service.NewCreateRangeAppOptions(protocol, dnsOpt)\n", "\toptions.SetEdgeIps(edgeIPs)\n", "\toptions.SetIpFirewall(true)\n", "\toptions.SetOriginDirect(originDirect)\n", "\toptions.SetOriginPort(22)\n", "\toptions.SetProxyProtocol(rangeapplicationsv1.CreateRangeAppOptions_ProxyProtocol_Off)\n", "\toptions.SetTls(rangeapplicationsv1.CreateRangeAppOptions_Tls_Off)\n", "\toptions.SetTrafficType(rangeapplicationsv1.CreateRangeAppOptions_TrafficType_Direct)\n", "\tresult, response, err := service.CreateRangeApp(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " RangeAppReqDns rangeAppReqDnsModel = new RangeAppReqDns.Builder()\n", " .type(\"CNAME\")\n", " .name(\"ssh.example.com\")\n", " .build();\n", "\n", " RangeAppReqEdgeIps rangeAppReqEdgeIpsModel = new RangeAppReqEdgeIps.Builder()\n", " .type(\"dynamic\")\n", " .connectivity(\"all\")\n", " .build();\n", "\n", " CreateRangeAppOptions createRangeAppOptions = new CreateRangeAppOptions.Builder()\n", " .protocol(\"tcp/22\")\n", " .dns(rangeAppReqDnsModel)\n", " .originDirect(new java.util.ArrayList(java.util.Arrays.asList(\"tcp://12.1.1.1:22\")))\n", " .originPort(Long.valueOf(\"22\"))\n", " .ipFirewall(true)\n", " .proxyProtocol(\"off\")\n", " .edgeIps(rangeAppReqEdgeIpsModel)\n", " .trafficType(\"direct\")\n", " .tls(\"off\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.createRangeApp(createRangeAppOptions).execute();\n", " RangeApplicationResp rangeApplicationRespResult = response.getResult();\n", " identifier = rangeApplicationRespResult.getResult().getId();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " protocol: 'tcp/32',\n", " dns: { type: 'CNAME', name: 'origin.example.com' },\n", " originDirect: ['tcp://2.5.6.7:32'],\n", " proxyProtocol: 'off',\n", " ipFirewall: true,\n", " tls: 'off',\n", " trafficType: 'direct',\n", " edgeIps: { connectivity: 'all', type: 'dynamic' },\n", "};\n", "rangeApplicationsV1.createRangeApp(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const createdRangeApp = result.result;\n", " console.log(JSON.stringify(createdRangeApp, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } }, "x-codegen-request-body-name": "range app" } }, "/v1/{crn}/zones/{zone_identifier}/range/apps/{app_identifier}": { "get": { "tags": [ "Range Applications" ], "summary": "Get range application a zone", "description": "Get the application configuration of a specific application inside a zone.", "operationId": "get_range_app", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "name": "app_identifier", "in": "path", "description": "Application identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/range_application_resp" }, "example": { "success": true, "errors": [], "messages": [], "result": { "id": "ea95132c15732412d22c1476fa83f27a", "protocol": "tcp/22", "dns": { "type": "CNAME", "name": "ssh.example.com" }, "origin_direct": [ "tcp://192.0.2.1:22" ], "proxy_protocol": "v1", "ip_firewall": true, "traffic_type": "direct", "edge_ips": { "type": "dynamic", "connectivity": "ipv4" }, "tls": "full", "created_on": "2014-01-02T02:20:00.000Z", "modified_on": "2014-01-02T02:20:00.000Z" } } } } }, "400": { "description": "Bad Request", "content": {} }, "403": { "description": "Forbidden! User has no privilege", "content": {} }, "404": { "description": "Resource not found", "content": {} }, "500": { "description": "Internal server error", "content": {} } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \"https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/range/apps/:app_id\" \\\n", " -H \"x-auth-user-token: Bearer xxxxxx\" \\\n", " -H \"Content-Type: application/json\"\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import RangeApplicationsV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " app = RangeApplicationsV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " app.set_service_url(endpoint)\n", " resp = app.get_range_app(app_identifier=\"c9f4bdf4fed24bc6b47bfca7e6246a2a\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/rangeapplicationsv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &rangeapplicationsv1.RangeApplicationsV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := rangeapplicationsv1.NewRangeApplicationsV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\n", "\toptions := service.NewGetRangeAppOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\tresult, response, err := service.GetRangeApp(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetRangeAppOptions getRangeAppOptions = new GetRangeAppOptions.Builder()\n", " .appIdentifier(identifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.getRangeApp(getRangeAppOptions).execute();\n", " RangeApplicationResp rangeApplicationRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " appIdentifier: ${rangeAppId},\n", "};\n", "rangeApplicationsV1.getRangeApp(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const rangeApp = result.result;\n", " console.log(JSON.stringify(rangeApp, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } }, "put": { "tags": [ "Range Applications" ], "summary": "Update range application", "description": "Update a Range Application inside a zone.", "operationId": "update_range_app", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.range-apps.update" } ] }, "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "name": "app_identifier", "in": "path", "description": "Application identifier", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Update a range app", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/range_app_req" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/range_application_resp" }, "example": { "success": true, "errors": [], "messages": [], "result": { "id": "ea95132c15732412d22c1476fa83f27a", "protocol": "tcp/22", "dns": { "type": "CNAME", "name": "ssh.example.com" }, "origin_direct": [ "tcp://192.0.2.1:22" ], "proxy_protocol": true, "ip_firewall": true, "tls": "flexible", "created_on": "2014-01-02T02:20:00.000Z", "modified_on": "2014-01-02T02:20:00.000Z" } } } } }, "400": { "description": "Bad Request", "content": {} }, "403": { "description": "Forbidden! User has no privilege", "content": {} }, "404": { "description": "Resource not found", "content": {} }, "500": { "description": "Internal server error", "content": {} } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/range/apps/app_id", " -H 'content-type: application/json'", " -H 'x-auth-user-token: Bearer xxxxxx'", " -d '{\"protocol\":\"tcp/22\",\"dns\":{\"type\":\"CNAME\",\"name\":\"origin.example.com\"},\"origin_direct\":[\"tcp://192.0.2.1:22\"],\"proxy_protocol\":true,\"ip_firewall\":true}" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import RangeApplicationsV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " app = RangeApplicationsV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " app.set_service_url(endpoint)\n", " protocol = \"tcp/22\"\n", " dns = {\n", " \"type\": \"CNAME\",\n", " \"name\": \"origin-example.net\"\n", " }\n", " origin_direct = [\"tcp://12.1.1.1:22\"]\n", " origin_port = 22\n", " ip_firewall = True\n", " proxy_protocol = \"off\"\n", " edge_ips = {\n", " \"type\": \"dynamic\",\n", " \"connectivity\": \"all\"\n", " }\n", " traffic_type = \"direct\"\n", " tls = \"off\"\n", " resp = app.update_range_app(app_identifier=\"c9f4bdf4fed24bc6b47bfca7e6246a2a\", protocol=protocol, dns=dns, origin_direct=origin_direct,\n", " origin_port=origin_port, ip_firewall=ip_firewall, proxy_protocol=proxy_protocol, edge_ips=edge_ips, traffic_type=traffic_type, tls=tls)\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/rangeapplicationsv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &rangeapplicationsv1.RangeApplicationsV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := rangeapplicationsv1.NewRangeApplicationsV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\n", "\toriginDirect := []string{\"tcp://12.12.12.12:25\"}\n", "\tprotocol := \"tcp/22\"\n", "\tdnsName := \"example.test.com\"\n", "\tdnsOpt := &rangeapplicationsv1.RangeAppReqDns{\n", "\t\tType: core.StringPtr(rangeapplicationsv1.RangeApplicationObjectDns_Type_Cname),\n", "\t\tName: core.StringPtr(dnsName),\n", "\t}\n", "\tedgeIPs := &rangeapplicationsv1.RangeAppReqEdgeIps{\n", "\t\tType: core.StringPtr(rangeapplicationsv1.RangeAppReqEdgeIps_Type_Dynamic),\n", "\t\tConnectivity: core.StringPtr(rangeapplicationsv1.RangeAppReqEdgeIps_Connectivity_All),\n", "\t}\n", "\toptions := service.NewUpdateRangeAppOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\", protocol, dnsOpt)\n", "\toptions.SetEdgeIps(edgeIPs)\n", "\toptions.SetIpFirewall(true)\n", "\toptions.SetOriginDirect(originDirect)\n", "\toptions.SetOriginPort(22)\n", "\toptions.SetProxyProtocol(rangeapplicationsv1.UpdateRangeAppOptions_ProxyProtocol_Off)\n", "\toptions.SetTls(rangeapplicationsv1.UpdateRangeAppOptions_Tls_Off)\n", "\toptions.SetTrafficType(rangeapplicationsv1.UpdateRangeAppOptions_TrafficType_Direct)\n", "\tresult, response, err := service.UpdateRangeApp(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " RangeAppReqDns rangeAppReqDnsModel = new RangeAppReqDns.Builder()\n", " .type(\"CNAME\")\n", " .name(\"ssh.example.com\")\n", " .build();\n", "\n", " RangeAppReqEdgeIps rangeAppReqEdgeIpsModel = new RangeAppReqEdgeIps.Builder()\n", " .type(\"dynamic\")\n", " .connectivity(\"all\")\n", " .build();\n", "\n", " UpdateRangeAppOptions updateRangeAppOptions = new UpdateRangeAppOptions.Builder()\n", " .appIdentifier(identifier)\n", " .protocol(\"tcp/22\")\n", " .dns(rangeAppReqDnsModel)\n", " .originDirect(new java.util.ArrayList(java.util.Arrays.asList(\"tcp://12.1.1.1:22\")))\n", " .originPort(Long.valueOf(\"22\"))\n", " .ipFirewall(true)\n", " .proxyProtocol(\"off\")\n", " .edgeIps(rangeAppReqEdgeIpsModel)\n", " .trafficType(\"direct\")\n", " .tls(\"off\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.updateRangeApp(updateRangeAppOptions).execute();\n", " RangeApplicationResp rangeApplicationRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " appIdentifier: ${rangeAppId},\n", " protocol: 'tcp/32',\n", " dns: { type: 'CNAME', name: 'origin.example.com' },\n", " originDirect: ['tcp://2.5.6.7:32'],\n", " proxyProtocol: 'v1',\n", " ipFirewall: true,\n", " tls: 'flexible',\n", " trafficType: 'direct',\n", " edgeIps: { connectivity: 'all', type: 'dynamic' },\n", "};\n", "rangeApplicationsV1.updateRangeApp(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const updatedRangeApp = result.result;\n", " console.log(JSON.stringify(updatedRangeApp, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } }, "x-codegen-request-body-name": "range app" }, "delete": { "tags": [ "Range Applications" ], "summary": "Delete range application", "description": "Delete a specific application configuration.", "operationId": "delete_range_app", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.range-apps.delete" } ] }, "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "name": "app_identifier", "in": "path", "description": "Application identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/range_application_resp" }, "example": { "success": true, "errors": [], "messages": [], "result": { "id": "ea95132c15732412d22c1476fa83f27a" } } } } }, "400": { "description": "Bad Request", "content": {} }, "403": { "description": "Forbidden! User has no privilege", "content": {} }, "404": { "description": "Resource not found", "content": {} }, "500": { "description": "Internal server error", "content": {} } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \"https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/range/apps/:app_id\" \\\n", " -H \"x-auth-user-token: Bearer xxxxxx\" \\\n", " -H \"Content-Type: application/json\"\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import RangeApplicationsV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " app = RangeApplicationsV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " app.set_service_url(endpoint)\n", " resp = app.delete_range_app(app_identifier=\"c9f4bdf4fed24bc6b47bfca7e6246a2a\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/rangeapplicationsv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &rangeapplicationsv1.RangeApplicationsV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := rangeapplicationsv1.NewRangeApplicationsV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\n", "\toptions := service.NewDeleteRangeAppOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\tresult, response, err := service.DeleteRangeApp(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " DeleteRangeAppOptions deleteRangeAppOptions = new DeleteRangeAppOptions.Builder()\n", " .appIdentifier(identifier)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.deleteRangeApp(deleteRangeAppOptions).execute();\n", " RangeApplicationResp rangeApplicationRespResult = response.getResult();\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " appIdentifier: ${rangeAppId},\n", "};\n", "rangeApplicationsV1.deleteRangeApp(params)\n", " .then(response => {\n", " const { result } = response || {};\n", " const deletedRangeApp = result.result;\n", " console.log(JSON.stringify(deletedRangeApp, null, 2));\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/ssl/certificate_packs": { "get": { "tags": [ "Edge Certificate" ], "summary": "List all certificates", "operationId": "list_certificates", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.certificate-packs.read" } ] }, "description": "CIS automatically adds an active DNS zone to a universal SSL certificate, shared among multiple customers. Customers can order dedicated certificates for the owning zones. This API lists all certificates for a zone, including shared and dedicated certificates.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "header", "name": "X-Correlation-ID", "description": "UUID, identify a session", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_certificate_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/ssl/certificate_packs \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import SslCertificateApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cert = SslCertificateApiV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " cert.set_service_url(endpoint)\n", " resp = cert.list_certificates()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/sslcertificateapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &sslcertificateapiv1.SslCertificateApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := sslcertificateapiv1.NewSslCertificateApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewListCertificatesOptions()\n", "\tresult, response, err := service.ListCertificates(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ListCertificatesOptions listCertificatesOptions = new ListCertificatesOptions.Builder()\n", " .xCorrelationId(\"testString\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.listCertificates(listCertificatesOptions).execute();\n", " // Validate response\n", " assertNotNull(response);\n", " assertEquals(response.getStatusCode(), 200);\n", "\n", " ListCertificateResp listCertificateRespResult = response.getResult();\n", "\n", " assertNotNull(listCertificateRespResult);\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "const SSLCertificateAPI = require('ibm-networking-services/cis/ssl-certificate-api/v1');\n", "const { IamAuthenticator } = require('ibm-cloud-sdk-core');\n", "\n", "const options = {\n", " authenticator: new IamAuthenticator({\n", " apikey: ${CIS_SERVICES_APIKEY},\n", " url: ${CIS_SERVICES_AUTH_URL},\n", " }),\n", " crn: ${CIS_SERVICES_CRN},\n", " serviceUrl: ${CIS_SERVICES_URL},\n", " version: ${CIS_SERVICES_API_VERSION},\n", " zoneIdentifier: ${CIS_SERVICES_ZONE_ID},\n", "}\n", "\n", "const sslCertApi = new SSLCertificateAPI(options);\n", "\n", "sslCertApi.listCertificates({})\n", " .then(response => {\n", " const certificateList = response.result.result;\n", " console.log(certificateList);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/acm/total_tls": { "get": { "tags": [ "Total TLS" ], "summary": "Fetch Total TLS configuration", "operationId": "get_total_tls", "description": "For a given zone identifier, get the Total TLS configuration.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/total_tls_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/acm/total_tls \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "post": { "tags": [ "Total TLS" ], "summary": "Update Total TLS configuration", "operationId": "post_total_tls", "description": "For a given zone identifier, update the Total TLS configuration.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/total_tls_req" } } }, "description": "Change Total TLS configuration" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/total_tls_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/acm/total_tls \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "-d '{\"enabled\": true, \"certificate_authority\": \"google\"}'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/ssl": { "get": { "tags": [ "Zones Settings" ], "summary": "Get SSL setting", "operationId": "get_ssl_setting", "description": "For a given zone identifier, get SSL setting.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ssl_setting_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/ssl \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import SslCertificateApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cert = SslCertificateApiV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " cert.set_service_url(endpoint)\n", " resp = cert.get_ssl_setting()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/sslcertificateapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &sslcertificateapiv1.SslCertificateApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := sslcertificateapiv1.NewSslCertificateApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewGetSslSettingOptions()\n", "\tresult, response, err := service.GetSslSetting(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " DeleteCertificateOptions deleteCertificateOptions = new DeleteCertificateOptions.Builder()\n", " .certIdentifier(\"testString\")\n", " .xCorrelationId(\"testString\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.deleteCertificate(deleteCertificateOptions).execute();\n", " // Validate response\n", " assertNotNull(response);\n", " assertEquals(response.getStatusCode(), 200);\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "sslCertApi.getSslSetting({})\n", " .then(response => {\n", " const sslSetting = response.result.result;\n", " console.log(sslSetting);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "patch": { "tags": [ "Zones Settings" ], "summary": "Change SSL setting", "operationId": "change_ssl_setting", "description": "For a given zone identifier, change SSL setting.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ssl_setting_req" } } }, "description": "Change SSL setting" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ssl_setting_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/ssl \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"off\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import SslCertificateApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cert = SslCertificateApiV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " cert.set_service_url(endpoint)\n", " resp = cert.change_ssl_setting(value=\"full\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/sslcertificateapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &sslcertificateapiv1.SslCertificateApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := sslcertificateapiv1.NewSslCertificateApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewChangeSslSettingOptions()\n", "\toptions.SetValue(sslcertificateapiv1.ChangeSslSettingOptions_Value_Full)\n", "\tresult, response, err := service.ChangeSslSetting(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ChangeSslSettingOptions changeSslSettingOptions = new ChangeSslSettingOptions.Builder()\n", " .value(\"flexible\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.changeSslSetting(changeSslSettingOptions).execute();\n", " // Validate response\n", " assertNotNull(response);\n", " assertEquals(response.getStatusCode(), 200);\n", "\n", " SslSettingResp sslSettingRespResult = response.getResult();\n", "\n", " assertNotNull(sslSettingRespResult);\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "sslCertApi.changeSslSetting({\n", " value: 'strict' // valid values { 'off', 'flexible', 'full', 'strict' }\n", "})\n", " .then(response => {\n", " const changedSetting = response.result.result;\n", " console.log(changedSetting);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/custom_certificates": { "get": { "tags": [ "Edge Certificate" ], "summary": "List all custom certificates", "operationId": "list_custom_certificates", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.custom-certificates.read" } ] }, "description": "For a given zone identifier, list all custom certificates.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_custom_certs_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/custom_certificates \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import SslCertificateApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cert = SslCertificateApiV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " cert.set_service_url(endpoint)\n", " resp = cert.get_custom_certificate(\n", " custom_cert_id=\"6898d249785e6e5eab1d3700a9da0bf9\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/sslcertificateapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &sslcertificateapiv1.SslCertificateApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := sslcertificateapiv1.NewSslCertificateApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewListCustomCertificatesOptions()\n", "\tresult, response, err := service.ListCustomCertificates(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(result.Result, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ListCustomCertificatesOptions listCustomCertificatesOptions = new ListCustomCertificatesOptions();\n", "\n", " // Invoke operation\n", " Response response = service.listCustomCertificates(listCustomCertificatesOptions).execute();\n", " // Validate response\n", " assertNotNull(response);\n", " assertEquals(response.getStatusCode(), 200);\n", "\n", " ListCustomCertsResp listCustomCertsRespResult = response.getResult();\n", "\n", " assertNotNull(listCustomCertsRespResult);\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "sslCertApi.listCustomCertificates({})\n", " .then(response => {\n", " const customCertList = response.result.result;\n", " console.log(customCertList);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "post": { "tags": [ "Edge Certificate" ], "summary": "Upload a custom certificate", "operationId": "upload_custom_certificate", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.custom-certificates.create" } ] }, "description": "For a given zone identifier, upload a custom certificates.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_cert_req" } } }, "description": "Upload a custom certificate." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_cert_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/custom_certificates \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " --data '{\"private_key\": \"-----BEGIN RSA PRIVATE KEY-----\\n......\\n-----END RSA PRIVATE KEY-----\\n\", \"certificate\": \"-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n\", \"bundle_method\": \"ubiquitous\", \"geo_restrictions\": {\"label\":\"us\"}}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import SslCertificateApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " certificate = os.getenv(\"CERTIFICATE\")\n", " private_key = os.getenv(\"PRIVATE_KEY\")\n", " # create instance\n", " cert = SslCertificateApiV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " cert.set_service_url(endpoint)\n", " custom_cert_req_geo_restrictions_model = {\n", " 'label': 'us'\n", " }\n", "\n", " resp = cert.upload_custom_certificate(certificate=certificate, private_key=private_key,\n", " bundle_method=\"optimal\", geo_restrictions=custom_cert_req_geo_restrictions_model)\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/sslcertificateapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tcertificate := os.Getenv(\"CERTIFICATE\")\n", "\tprivateKey := os.Getenv(\"PRIVATE_KEY\")\n", "\tglobalOptions := &sslcertificateapiv1.SslCertificateApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := sslcertificateapiv1.NewSslCertificateApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\tgeoOpt, geoErr := service.NewCustomCertReqGeoRestrictions(\"us\")\n", "\tif geoErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewUploadCustomCertificateOptions()\n", "\toptions.SetCertificate(certificate)\n", "\toptions.SetPrivateKey(privateKey)\n", "\toptions.SetGeoRestrictions(geoOpt)\n", "\tresult, response, err := service.UploadCustomCertificate(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " CustomCertReqGeoRestrictions customCertReqGeoRestrictionsModel = new CustomCertReqGeoRestrictions.Builder()\n", " .label(\"us\")\n", " .build();\n", "\n", " System.out.println(certs);\n", " System.out.println(privates);\n", " UploadCustomCertificateOptions uploadCustomCertificateOptions = new UploadCustomCertificateOptions.Builder()\n", " .certificate(certs)\n", " .privateKey(privates)\n", " .bundleMethod(\"ubiquitous\")\n", " .geoRestrictions(customCertReqGeoRestrictionsModel)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.uploadCustomCertificate(uploadCustomCertificateOptions).execute();\n", " // Validate response\n", " assertNotNull(response);\n", " assertEquals(response.getStatusCode(), 200);\n", "\n", " CustomCertResp customCertRespResult = response.getResult();\n", "\n", " assertNotNull(customCertRespResult);\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " bundle_method: 'ubiquitous',\n", " certificate: ${CERTIFICATE}, // custom tls certificate\n", " privateKey: ${PRIVATE_KEY}, // private key\n", "};\n", "\n", "sslCertApi.uploadCustomCertificate(params)\n", " .then(response => {\n", " const uploadedCert = response.result.result;\n", " console.log(uploadedCert);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/custom_certificates/{custom_cert_id}": { "get": { "tags": [ "Edge Certificate" ], "summary": "Get custom certificate", "operationId": "get_custom_certificate", "description": "For a given zone identifier, get a custom certificates.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "custom_cert_id", "description": "Custom certificate ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_cert_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/custom_certificates/:custom_cert_id \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import SslCertificateApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cert = SslCertificateApiV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " cert.set_service_url(endpoint)\n", " resp = cert.get_custom_certificate(\n", " custom_cert_id=\"6898d249785e6e5eab1d3700a9da0bf9\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/sslcertificateapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &sslcertificateapiv1.SslCertificateApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := sslcertificateapiv1.NewSslCertificateApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewGetCustomCertificateOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\tresult, response, err := service.GetCustomCertificate(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetCustomCertificateOptions getCustomCertificateOptions = new GetCustomCertificateOptions.Builder()\n", " .customCertId(\"testString\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.getCustomCertificate(getCustomCertificateOptions).execute();\n", " // Validate response\n", " assertNotNull(response);\n", " assertEquals(response.getStatusCode(), 200);\n", "\n", " CustomCertResp customCertRespResult = response.getResult();\n", "\n", " assertNotNull(customCertRespResult);\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "sslCertApi.getCustomCertificate({\n", " customCertId: ${customCertificateId},\n", "})\n", " .then(response => {\n", " const customCertificate = response.result.result;\n", " console.log(customCertificate);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "patch": { "tags": [ "Edge Certificate" ], "summary": "Update custom certificate", "operationId": "update_custom_certificate", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.custom-certificates.update" } ] }, "description": "For a given zone identifier, update a custom certificates.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "custom_cert_id", "description": "Custom certificate ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_cert_req" } } }, "description": "Update a custom certificate." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_cert_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/custom_certificates/:custom_cert_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " --data '{\"private_key\": \"-----BEGIN RSA PRIVATE KEY-----\\n......\\n-----END RSA PRIVATE KEY-----\\n\", \"certificate\": \"-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n\", \"bundle_method\": \"ubiquitous\", \"geo_restrictions\": {\"label\":\"us\"}}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import SslCertificateApiV1\n", "\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " update_certificate = os.getenv(\"UPDATE_CERTIFICATE\")\n", " update_private_key = os.getenv(\"UPDATE_PRIVATE_KEY\")\n", " # create instance\n", " cert = SslCertificateApiV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " cert.set_service_url(endpoint)\n", " custom_cert_req_geo_restrictions_model = {\n", " 'label': 'us'\n", " }\n", " resp = cert.update_custom_certificate(custom_cert_id=\"6898d249785e6e5eab1d3700a9da0bf9\", certificate=update_certificate,\n", " private_key=update_private_key, bundle_method=\"optimal\", geo_restrictions=custom_cert_req_geo_restrictions_model)\n", " print(resp)\n", "\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/sslcertificateapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tupdateCertificate := os.Getenv(\"UPDATE_CERTIFICATE\")\n", "\tupdatePrivateKey := os.Getenv(\"UPDATE_PRIVATE_KEY\")\n", "\tglobalOptions := &sslcertificateapiv1.SslCertificateApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := sslcertificateapiv1.NewSslCertificateApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\tgeoOpt, geoErr := service.NewCustomCertReqGeoRestrictions(\"us\")\n", "\tif geoErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewUpdateCustomCertificateOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\toptions.SetBundleMethod(sslcertificateapiv1.UpdateCustomCertificateOptions_BundleMethod_Ubiquitous)\n", "\toptions.SetCertificate(updateCertificate)\n", "\toptions.SetGeoRestrictions(geoOpt)\n", "\toptions.SetPrivateKey(updatePrivateKey)\n", "\tresult, response, err := service.UpdateCustomCertificate(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " certificate: ${NEW_CERTIFICATE},\n", " privateKey: ${NEW_PRIVATE_KEY},\n", " customCertId: ${certificateId},\n", "};\n", "\n", "sslCertApi.updateCustomCertificate(params)\n", " .then(response => {\n", " const updatedCert = response.result.result;\n", " console.log(updatedCert);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "delete": { "tags": [ "Edge Certificate" ], "summary": "Delete custom certificate", "operationId": "delete_custom_certificate", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.custom-certificates.delete" } ] }, "description": "For a given zone identifier, delete a custom certificates.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "custom_cert_id", "description": "Custom certificate ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/custom_certificates/:custom_cert_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import SslCertificateApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cert = SslCertificateApiV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " cert.set_service_url(endpoint)\n", " resp = cert.delete_custom_certificate(\n", " custom_cert_id=\"6898d249785e6e5eab1d3700a9da0bf9\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/sslcertificateapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &sslcertificateapiv1.SslCertificateApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := sslcertificateapiv1.NewSslCertificateApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewDeleteCustomCertificateOptions(\"2be5d4a7-78f0-4c62-a957-41dc15342777\")\n", "\tresponse, err := service.DeleteCustomCertificate(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " DeleteCustomCertificateOptions deleteCustomCertificateOptions = new DeleteCustomCertificateOptions.Builder()\n", " .customCertId(\"testString\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.deleteCustomCertificate(deleteCustomCertificateOptions).execute();\n", " // Validate response\n", " assertNotNull(response);\n", " assertEquals(response.getStatusCode(), 200);\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "sslCertApi.deleteCustomCertificate({\n", " customCertId: ${customCertificateId},\n", "})\n", " .then(response => {\n", " const deletedCert = response.result.result;\n", " console.log(deletedCert);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/custom_certificates/prioritize": { "put": { "tags": [ "Edge Certificate" ], "summary": "Set certificate priority", "operationId": "change_certificate_priority", "description": "For a given zone identifier, set priority of certificates.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cert_priority_req" } } }, "description": "Set priority of certificates." }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/custom_certificates/prioritize \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " --data '{\"certificates\": [{\"id\": \"5a7805061c76ada191ed06f989cc3dac\", \"priority\": 2}, {\"id\": \"9a7806061c88ada191ed06f989cc3dac\", \"priority\": 1}]}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import SslCertificateApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cert = SslCertificateApiV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " cert.set_service_url(endpoint)\n", " cust_cert_priority = {\n", " \"id\": \"6898d249785e6e5eab1d3700a9da0bf9\",\n", " \"priority\": 4}\n", " resp = cert.change_certificate_priority(\n", " custom_identifier=\"6898d249785e6e5eab1d3700a9da0bf9\", certificates=[cust_cert_priority])\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/sslcertificateapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &sslcertificateapiv1.SslCertificateApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := sslcertificateapiv1.NewSslCertificateApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewChangeCertificatePriorityOptions()\n", "\tcertOpt := sslcertificateapiv1.CertPriorityReqCertificatesItem{\n", "\t\tID: core.StringPtr(\"6898d249785e6e5eab1d3700a9da0bf9\"),\n", "\t\tPriority: core.IntPtr(4),\n", "\t}\n", "\toptions.SetCertificates([]sslcertificateapiv1.CertPriorityReqCertificatesItem{certOpt})\n", "\tresponse, err := service.ChangeCertificatePriority(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " CertPriorityReqCertificatesItem certPriorityReqCertificatesItemModel = new CertPriorityReqCertificatesItem.Builder()\n", " .id(\"5a7805061c76ada191ed06f989cc3dac\")\n", " .priority(Long.valueOf(\"1\"))\n", " .build();\n", "\n", " ChangeCertificatePriorityOptions changeCertificatePriorityOptions = new ChangeCertificatePriorityOptions.Builder()\n", " .certificates(new java.util.ArrayList(java.util.Arrays.asList(certPriorityReqCertificatesItemModel)))\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.changeCertificatePriority(changeCertificatePriorityOptions).execute();\n", " // Validate response\n", " assertNotNull(response);\n", " assertEquals(response.getStatusCode(), 200);\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "const params = {\n", " certificates: [{\n", " customCertId: ${customCertificateId},\n", " priority: 2\n", " }],\n", "};\n", "\n", "sslCertApi.changeCertificatePriority(params)\n", " .then(response => {\n", " const result = response.result.result;\n", " console.log(result);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/ssl/universal/settings": { "get": { "tags": [ "Edge Certificate" ], "summary": "Get details of universal certificate", "operationId": "get_universal_certificate_setting", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.universal-ssl-setting.read" } ] }, "description": "For a given zone identifier, get universal certificate.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/universal_setting_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/ssl/universal/settings \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import SslCertificateApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cert = SslCertificateApiV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " cert.set_service_url(endpoint)\n", " resp = cert.get_universal_certificate_setting()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/sslcertificateapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &sslcertificateapiv1.SslCertificateApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := sslcertificateapiv1.NewSslCertificateApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewGetUniversalCertificateSettingOptions()\n", "\tresult, response, err := service.GetUniversalCertificateSetting(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.Enabled, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetUniversalCertificateSettingOptions getUniversalCertificateSettingOptions = new GetUniversalCertificateSettingOptions();\n", "\n", " // Invoke operation\n", " Response response = service.getUniversalCertificateSetting(getUniversalCertificateSettingOptions).execute();\n", " // Validate response\n", " assertNotNull(response);\n", " assertEquals(response.getStatusCode(), 200);\n", "\n", " UniversalSettingResp universalSettingRespResult = response.getResult();\n", "\n", " assertNotNull(universalSettingRespResult);\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "sslCertApi.getUniversalCertificateSetting({})\n", " .then(response => {\n", " const universalSetting = response.result.result;\n", " console.log(universalSetting);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "patch": { "tags": [ "Edge Certificate" ], "summary": "Enable or Disable universal certificate", "operationId": "change_universal_certificate_setting", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.universal-ssl-setting.update" } ] }, "description": "Change universal certificate setting.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/universal_cert_toggle_req" } } }, "description": "Enable or disable universal certificate." }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/ssl/universal/settings \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"enabled\": true}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import SslCertificateApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cert = SslCertificateApiV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " cert.set_service_url(endpoint)\n", " resp = cert.change_universal_certificate_setting(enabled=True)\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/sslcertificateapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &sslcertificateapiv1.SslCertificateApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := sslcertificateapiv1.NewSslCertificateApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewChangeTls12SettingOptions()\n", "\toptions.SetValue(sslcertificateapiv1.ChangeTls12SettingOptions_Value_On)\n", "\tresult, response, err := service.ChangeTls12Setting(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ChangeUniversalCertificateSettingOptions changeUniversalCertificateSettingOptions = new ChangeUniversalCertificateSettingOptions.Builder()\n", " .enabled(true)\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.changeUniversalCertificateSetting(changeUniversalCertificateSettingOptions).execute();\n", " // Validate response\n", " assertNotNull(response);\n", " assertEquals(response.getStatusCode(), 200);\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "sslCertApi.changeUniversalCertificateSetting({\n", " enabled: false,\n", "})\n", " .then(response => {\n", " const updatedUniversalSetting = response.result.result;\n", " console.log(updatedUniversalSetting);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/tls_1_2_only": { "get": { "tags": [ "Edge Certificate" ], "summary": "Get TLS 1.2 only setting", "operationId": "get_tls12_setting", "description": "For a given zone identifier, get TLS 1.2 only setting.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tls_1_2_setting_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/tls_1_2_only \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import SslCertificateApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cert = SslCertificateApiV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " cert.set_service_url(endpoint)\n", " resp = cert.get_tls12_setting()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/sslcertificateapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &sslcertificateapiv1.SslCertificateApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := sslcertificateapiv1.NewSslCertificateApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewGetTls12SettingOptions()\n", "\tresult, response, err := service.GetTls12Setting(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetTls12SettingOptions getTls12SettingOptions = new GetTls12SettingOptions();\n", "\n", " // Invoke operation\n", " Response response = service.getTls12Setting(getTls12SettingOptions).execute();\n", " // Validate response\n", " assertNotNull(response);\n", " assertEquals(response.getStatusCode(), 200);\n", "\n", " Tls12SettingResp tls12SettingRespResult = response.getResult();\n", "\n", " assertNotNull(tls12SettingRespResult);\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "sslCertApi.getTls12Setting({})\n", " .then(response => {\n", " const tls12Setting = response.result.result;\n", " console.log(tls12Setting);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "patch": { "tags": [ "Edge Certificate" ], "summary": "Set TLS 1.2 setting", "operationId": "change_tls12_setting", "description": "For a given zone identifier, set TLS 1.2 setting", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tls_1_2_setting_req" } } }, "description": "Set security-level setting." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tls_1_2_setting_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/tls_1_2_only \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import SslCertificateApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cert = SslCertificateApiV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " cert.set_service_url(endpoint)\n", " resp = cert.change_tls12_setting(value=\"off\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/sslcertificateapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &sslcertificateapiv1.SslCertificateApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := sslcertificateapiv1.NewSslCertificateApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewChangeTls12SettingOptions()\n", "\toptions.SetValue(sslcertificateapiv1.ChangeTls12SettingOptions_Value_On)\n", "\tresult, response, err := service.ChangeTls12Setting(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ChangeTls12SettingOptions changeTls12SettingOptions = new ChangeTls12SettingOptions.Builder()\n", " .value(\"on\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.changeTls12Setting(changeTls12SettingOptions).execute();\n", " // Validate response\n", " assertNotNull(response);\n", " assertEquals(response.getStatusCode(), 200);\n", "\n", " Tls12SettingResp tls12SettingRespResult = response.getResult();\n", "\n", " assertNotNull(tls12SettingRespResult);\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "sslCertApi.changeTls12Setting({\n", " value: 'on', // 'on' or 'off'\n", "})\n", " .then(response => {\n", " const updatedSetting = response.result.result;\n", " console.log(updatedSetting);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/settings/tls_1_3": { "get": { "tags": [ "Edge Certificate" ], "summary": "Get TLS 1.3 setting", "operationId": "get_tls13_setting", "description": "For a given zone identifier, get TLS 1.3 setting.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tls_1_3_setting_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/tls_1_3 \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import SslCertificateApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cert = SslCertificateApiV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " cert.set_service_url(endpoint)\n", " resp = cert.get_tls13_setting()\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/sslcertificateapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &sslcertificateapiv1.SslCertificateApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := sslcertificateapiv1.NewSslCertificateApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewGetTls13SettingOptions()\n", "\tresult, response, err := service.GetTls13Setting(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " GetTls13SettingOptions getTls13SettingOptions = new GetTls13SettingOptions();\n", "\n", " // Invoke operation\n", " Response response = service.getTls13Setting(getTls13SettingOptions).execute();\n", " // Validate response\n", " assertNotNull(response);\n", " assertEquals(response.getStatusCode(), 200);\n", "\n", " Tls13SettingResp tls13SettingRespResult = response.getResult();\n", "\n", " assertNotNull(tls13SettingRespResult);\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "sslCertApi.getTls13Setting({})\n", " .then(response => {\n", " const tls13Setting = response.result.result;\n", " console.log(tls13Setting);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } }, "patch": { "tags": [ "Edge Certificate" ], "summary": "Set TLS 1.3 setting", "operationId": "change_tls13_setting", "description": "For a given zone identifier, set TLS 1.3 setting.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tls_1_3_setting_req" } } }, "description": "Set security-level setting." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tls_1_3_setting_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PATCH \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/tls_1_3 \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"value\": \"on\"}'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from ibm_cloud_networking_services import SslCertificateApiV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn, zone id and end-point from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " endpoint = os.getenv(\"API_ENDPOINT\")\n", " # create instance\n", " cert = SslCertificateApiV1.new_instance(\n", " crn=crn, zone_identifier=zone_id, service_name=\"cis_services\")\n", " cert.set_service_url(endpoint)\n", " resp = cert.change_tls13_setting(value=\"off\")\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", "\t\"fmt\"\n", "\t\"os\"\n", "\n", "\t\"github.com/IBM/go-sdk-core/core\"\n", "\t\"github.com/IBM/networking-go-sdk/sslcertificateapiv1\"\n", ")\n", "\n", "func main() {\n", "\tauthenticator := &core.IamAuthenticator{\n", "\t\tApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", "\t\tURL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", "\t}\n", "\tserviceURL := os.Getenv(\"API_ENDPOINT\")\n", "\tcrn := os.Getenv(\"CRN\")\n", "\tzoneID := os.Getenv(\"ZONE_ID\")\n", "\tglobalOptions := &sslcertificateapiv1.SslCertificateApiV1Options{\n", "\t\tServiceName: \"cis_services\",\n", "\t\tURL: serviceURL,\n", "\t\tAuthenticator: authenticator,\n", "\t\tCrn: &crn,\n", "\t\tZoneIdentifier: &zoneID,\n", "\t}\n", "\tservice, serviceErr := sslcertificateapiv1.NewSslCertificateApiV1(globalOptions)\n", "\tif serviceErr != nil {\n", "\t\treturn\n", "\t}\n", "\toptions := service.NewChangeTls13SettingOptions()\n", "\toptions.SetValue(sslcertificateapiv1.ChangeTls13SettingOptions_Value_On)\n", "\tresult, response, err := service.ChangeTls13Setting(options)\n", "\tif err != nil {\n", "\t\treturn\n", "\t}\n", "\tfmt.Println(*result.Result.ID, response.RawResult)\n", "}\n" ] } ] } ], "java": [ { "name": "Example request", "example": [ { "type": "code", "source": [ " try {\n", " ChangeTls13SettingOptions changeTls13SettingOptions = new ChangeTls13SettingOptions.Builder()\n", " .value(\"on\")\n", " .build();\n", "\n", " // Invoke operation\n", " Response response = service.changeTls13Setting(changeTls13SettingOptions).execute();\n", " // Validate response\n", " assertNotNull(response);\n", " assertEquals(response.getStatusCode(), 200);\n", "\n", " Tls13SettingResp tls13SettingRespResult = response.getResult();\n", "\n", " assertNotNull(tls13SettingRespResult);\n", " } catch (ServiceResponseException e) {\n", " fail(String.format(\"Service returned status code %d: %s\\nError details: %s\",\n", " e.getStatusCode(), e.getMessage(), e.getDebuggingInfo()));\n", " }" ] } ] } ], "node": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "...\n", "\n", "sslCertApi.changeTls13Setting({\n", " value: 'on', // 'on', 'off', zrt\n", "})\n", " .then(response => {\n", " const updatedSetting = response.result.result;\n", " console.log(updatedSetting);\n", " })\n", " .catch(err => {\n", " console.log('error:', err);\n", " });" ] } ] } ] } } } }, "/v2/{crn}/zones/{zone_identifier}/ssl/certificate_packs/order": { "post": { "tags": [ "Advanced Certificate Pack" ], "summary": "Order advanced certificate", "operationId": "order_advanced_certificate", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.certificate-packs.create" } ] }, "description": "Order an advanced certificate pack for a given zone. The zone should be active before ordering an advanced certificate pack.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "header", "name": "X-Correlation-ID", "description": "UUID, identify a session", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/advanced_cert_req" } } }, "description": "Order an advanced certificate pack." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/advanced_cert_init_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/v2/{crn}/zones/{zone_identifier}/ssl/certificate_packs/{cert_identifier}": { "patch": { "tags": [ "Advanced Certificate Pack" ], "summary": "Restart validation for an advanced certificate pack", "operationId": "patch_certificate", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.certificate-packs.update" } ] }, "description": "Restart validation for an advanced certificate pack. This is only a validation operation for a Certificate Pack in a validation_timed_out status.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "cert_identifier", "required": true, "description": "Certificate identifier", "schema": { "type": "string" } }, { "in": "header", "name": "X-Correlation-ID", "description": "UUID, identify a session", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/advanced_cert_init_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Advanced Certificate Pack" ], "summary": "Delete advanced certificate", "operationId": "delete_certificate_v2", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.certificate-packs.delete" } ] }, "description": "Delete an advanced certificate pack.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "cert_identifier", "required": true, "description": "Certificate identifier", "schema": { "type": "string" } }, { "in": "header", "name": "X-Correlation-ID", "description": "UUID, identify a session", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/v2/{crn}/zones/{zone_identifier}/ssl/verification": { "get": { "tags": [ "Advanced Certificate Pack" ], "summary": "Get SSL Verification Info for a Zone", "operationId": "get_ssl_verification", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "description": "Get SSL Verification Info for a Zone", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "header", "name": "X-Correlation-ID", "description": "UUID, identify a session", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ssl_verification_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/v1/{crn}/zones/{zone_identifier}/origin_certificates": { "get": { "tags": [ "Origin Certificate" ], "summary": "List all origin certificates", "operationId": "list_origin_certificates", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.origin-certificates.read" } ] }, "description": "List all existing CIS-issued Certificates for a given domain.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "header", "name": "X-Correlation-ID", "description": "UUID, identify a session", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_origin_certificates_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/origin_certificates \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "post": { "tags": [ "Origin Certificate" ], "summary": "Create a CIS-signed certificate", "operationId": "create_origin_certificate", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.origin-certificates.create" } ] }, "description": "Create a CIS-signed certificate.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "header", "name": "X-Correlation-ID", "description": "UUID, identify a session", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/origin_certificate_req" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/origin_certificate_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/origin_certificates \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "-d '{\n", " \"hostnames\": [\n", " \"example.com\",\n", " \"*.example.com\"\n", " ],\n", " \"request_type\": \"origin-rsa\"\n", "}'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/origin_certificates/{cert_identifier}": { "delete": { "tags": [ "Origin Certificate" ], "summary": "Revoke a created origin certificate for a domain", "operationId": "revoke_origin_certificate", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.origin-certificates.delete" } ] }, "description": "Revoke a created origin certificate.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "cert_identifier", "description": "Certificate identifier", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "X-Correlation-ID", "description": "UUID, identify a session", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/revoke_origin_certificate_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/origin_certificates/:cert_id \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "get": { "tags": [ "Origin Certificate" ], "summary": "Get an existing origin certificate", "operationId": "get_origin_certificate", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.origin-certificates.read" } ] }, "description": "Get an existing origin certificate by its serial number.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "cert_identifier", "description": "Certificate identifier", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "X-Correlation-ID", "description": "UUID, identify a session", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/origin_certificate_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/origin_certificates/:cert_id \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/access/certificates": { "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "get": { "tags": [ "Mutual TLS" ], "summary": "List access certificates", "operationId": "list_access_certificates", "description": "List access certificates", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_access_certs_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/access/certificates \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "post": { "tags": [ "Mutual TLS" ], "summary": "Create access certificate", "operationId": "create_access_certificate", "description": "Create access certificate", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access_cert_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access_cert_input" } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/access/certificates \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " --data '{\n", " \"name\": \"test-cert\",\n", " \"certificate\": \"-----BEGIN CERTIFICATE-----\\nMIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10\\nDrUtmu/B\\n-----END CERTIFICATE-----\",\n", " \"associated_hostnames\": [\n", " \"test.example.com\"\n", " ]\n", "}'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/access/certificates/{cert_id}": { "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "$ref": "#/components/parameters/cert_id" } ], "get": { "tags": [ "Mutual TLS" ], "summary": "Get access certificate", "operationId": "get_access_certificate", "description": "Get access certificate", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access_cert_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/access/certificates/:cert_id \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "put": { "tags": [ "Mutual TLS" ], "summary": "Update access certificate", "operationId": "update_access_certificate", "description": "Update access certificate", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access_cert_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_access_cert_input" } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/access/certificates/:cert_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " --data '{\n", " \"name\": \"test-cert\",\n", " \"associated_hostnames\": [\n", " \"test.example.com\"\n", " ]\n", "}'\n" ] } ] } ] } } }, "delete": { "tags": [ "Mutual TLS" ], "summary": "Delete access certificate", "operationId": "delete_access_certificate", "description": "Delete access certificate", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_access_cert_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/access/certificates/:cert_id \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/access/apps": { "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "get": { "tags": [ "Mutual TLS" ], "summary": "List access applications", "operationId": "list_access_applications", "description": "List access applications", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_access_apps_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/access/apps \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "post": { "tags": [ "Mutual TLS" ], "summary": "Create access application", "operationId": "create_access_application", "description": "Create access application", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_access_app_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access_app_input" } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/access/apps \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " --data '{\n", " \"name\": \"mtls-test-app\",\n", " \"domain\": \"test.example.com\",\n", " \"session_duration\": \"24h\"\n", "}'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/access/apps/{app_id}": { "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "$ref": "#/components/parameters/app_id" } ], "get": { "tags": [ "Mutual TLS" ], "summary": "Get access application", "operationId": "get_access_application", "description": "Get access application", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access_app_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/access/apps/:app_id \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "put": { "tags": [ "Mutual TLS" ], "summary": "Update access application", "operationId": "update_access_application", "description": "Update access application", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access_app_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access_app_input" } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/access/apps/:app_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " --data '{\n", " \"name\": \"mtls-test-app\",\n", " \"domain\": \"test.example.com\",\n", " \"session_duration\": \"24h\"\n", "}'\n" ] } ] } ] } } }, "delete": { "tags": [ "Mutual TLS" ], "summary": "Delete access application", "operationId": "delete_access_application", "description": "Delete access application", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_access_app_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/access/apps/:app_id \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/access/apps/{app_id}/policies": { "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "$ref": "#/components/parameters/app_id" } ], "get": { "tags": [ "Mutual TLS" ], "summary": "List access policies", "operationId": "list_access_policies", "description": "List access policies", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_access_policies_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/access/policies \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "post": { "tags": [ "Mutual TLS" ], "summary": "Create access policy", "operationId": "create_access_policy", "description": "Create access policy", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access_policy_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access_policy_input" } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/access/policies \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " --data '{\n", " \"name\": \"mtls-test-policy\",\n", " \"decision\": \"non_identity\",\n", " \"include\": [\n", " {\n", " \"certificate\": {}\n", " },\n", " {\n", " \"common_name\": {\n", " \"common_name\": \"Access Testing CA\"\n", " }\n", " }\n", " ]\n", "}'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/access/apps/{app_id}/policies/{policy_id}": { "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "$ref": "#/components/parameters/app_id" }, { "$ref": "#/components/parameters/policy_id" } ], "get": { "tags": [ "Mutual TLS" ], "summary": "Get access policy", "operationId": "get_access_policy", "description": "Get access policy", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access_policy_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/access/policies/:policy_id \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "put": { "tags": [ "Mutual TLS" ], "summary": "Update access policy", "operationId": "update_access_policy", "description": "Update access policy", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access_policy_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access_policy_input" } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/access/policies/:policy_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " --data '{\n", " \"name\": \"mtls-test-policy\",\n", " \"decision\": \"non_identity\",\n", " \"include\": [\n", " {\n", " \"certificate\": {}\n", " },\n", " {\n", " \"common_name\": {\n", " \"common_name\": \"Access Testing CA\"\n", " }\n", " }\n", " ]\n", "}'\n" ] } ] } ] } } }, "delete": { "tags": [ "Mutual TLS" ], "summary": "Delete access policy", "operationId": "delete_access_policy", "description": "Delete access policy", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_access_policy_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/access/policies/:policy_id \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/access/certificates/settings": { "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "get": { "tags": [ "Mutual TLS" ], "summary": "Get access certificates settings", "operationId": "get_access_cert_settings", "description": "Get access certificates settings", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access_cert_settings_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/access/certificates/settings \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "put": { "tags": [ "Mutual TLS" ], "summary": "Update access certificates settings", "operationId": "update_access_cert_settings", "description": "Update access certificates settings", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access_cert_settings_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access_cert_settings_input" } } } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/access/certificates/settings \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " --data '{\"settings\": [{\n", " \"hostname\": \"test.example.com\",\n", " \"client_certificate_forwarding\": true\n", "}]}'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/filters": { "get": { "tags": [ "Filters" ], "summary": "List all filters for a zone", "operationId": "listAllFilters", "description": "List all filters for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_filters_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": [ { "paused": false, "expression": "ip.src eq 93.184.216.0", "id": "24b9b830dbc940bc80f84edc12a7b617" }, { "paused": false, "expression": "http.request.uri.path matches \"^/api/.*$\"", "id": "f74800bdc14e480e98f97484080abd31" }, { "paused": false, "expression": "(http.request.uri.path ~ \"^.*/wp-login.php$\" or http.request.uri.path ~ \"^.*/xmlrpc.php$\")", "id": "df887341486040fd920c620d207c85a3", "description": "Login" }, { "paused": true, "expression": "ip.src eq 93.184.216.0 and (http.request.uri.path ~ \"^.*/wp-login.php$\" or http.request.uri.path ~ \"^.*/xmlrpc.php$\")", "id": "603b9b969a274fb4a93f5c9c0a49e381", "description": "Login from office" } ], "result_info": { "count": 4, "per_page": 25, "total_pages": 1, "page": 1, "total_count": 4 } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/filters \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/core\"\n", " \"github.com/IBM/networking-go-sdk/filtersv1\"\n", ")\n", "\n", "func main() {\n", " serviceURL := os.Getenv(\"API_ENDPOINT\")\n", " crn := os.Getenv(\"CRN\")\n", " zoneId := os.Getenv(\"ZONE_ID\")\n", " xAuthUserToken := os.Getenv(\"CIS_SERVICES_APIKEY\")\n", " globalOptions := &filtersv1.FiltersV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: serviceURL,\n", " Authenticator: authenticator,\n", " }\n", " service, serviceErr := filtersv1.NewFiltersV1(globalOptions)\n", " listAllFiltersOptions:= service.NewListAllFiltersOptions(xAuthUserToken, crn, zoneId)\n", " result, response, error := service.ListAllFilters(listAllFiltersOptions)\n", " if error != nil {\n", " return\n", " }\n", "\n", " fmt.Println(*result.Result[0].ID)\n", "}" ] } ] } ] } } }, "post": { "tags": [ "Filters" ], "summary": "Create filters for a zone", "operationId": "createFilter", "description": "Create new filters for a zone under a service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/filters_input" } } }, "description": "JSON objects which are used to create filters." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/filters_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": [ { "paused": false, "expression": "http.request.uri.path matches \"^/api/.*$\"", "id": "fa5716194cc54a59b4090c9eb17ccf06" }, { "paused": false, "expression": "ip.src eq 93.184.216.0", "id": "59ca194ebb41440fa80ac2b9b0b41fab", "description": "Login" } ] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/filters \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " --data '[ \\\n", " { \\\n", " \"paused\": false, \\\n", " \"expression\": \"http.request.uri.path matches \\\"^/api/.*$\\\"\" \\\n", " }, \\\n", " { \\\n", " \"expression\": \"ip.src eq 93.184.216.0\", \\\n", " \"description\": \"Login\", \\\n", " \"paused\": false \\\n", " } \\\n", " ]'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/core\"\n", " \"github.com/IBM/networking-go-sdk/filtersv1\"\n", ")\n", "\n", "func main() {\n", " serviceURL := os.Getenv(\"API_ENDPOINT\")\n", " crn := os.Getenv(\"CRN\")\n", " zoneId := os.Getenv(\"ZONE_ID\")\n", " xAuthUserToken := os.Getenv(\"CIS_SERVICES_APIKEY\")\n", " globalOptions := &filtersv1.FiltersV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: serviceURL,\n", " Authenticator: authenticator,\n", " }\n", " service, serviceErr := filtersv1.NewFiltersV1(globalOptions)\n", " options:= service.NewCreateFilterOptions(xAuthUserToken, crn, zoneId)\n", " filetrInput := &filtersv1.FilterInput{\n", " Expression: core.StringPtr(\"(ip.src eq 93.60.125.234)\"),\n", " Paused: core.BoolPtr(false),\n", " Description: core.StringPtr(\"Login-Office-SDK\"),\n", " }\n", " options.SetFilterInput([]FilterInput{*filetrInput})\n", " result, response, error := service.CreateFilter(options)\n", " if error != nil {\n", " return\n", " }\n", " fmt.Println(*result.Result[0].ID)\n", "}" ] } ] } ] } } }, "put": { "tags": [ "Filters" ], "summary": "Update filters", "operationId": "updateFilters", "description": "Update existing filters for a zone under a service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/filters_update_input" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/filters_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": [ { "paused": false, "expression": "ip.src eq 193.184.216.0", "id": "24b9b830dbc940bc80f84edc12a7b617" }, { "paused": true, "expression": "http.request.uri.path matches \"^/apitest/.*$\"", "id": "f74800bdc14e480e98f97484080abd31" } ] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/filters \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " --data '[ \\\n", " { \\\n", " \"expression\": \"ip.src eq 193.184.216.0\", \\\n", " \"id\": \"24b9b830dbc940bc80f84edc12a7b617\" \\\n", " }, \\\n", " { \\\n", " \"paused\": true, \\\n", " \"expression\": \"http.request.uri.path matches \\\"^/apitest/.*$\\\"\", \\\n", " \"id\": \"f74800bdc14e480e98f97484080abd31\" \\\n", " } \\\n", " ]'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/core\"\n", " \"github.com/IBM/networking-go-sdk/filtersv1\"\n", ")\n", "\n", "func main() {\n", " serviceURL := os.Getenv(\"API_ENDPOINT\")\n", " crn := os.Getenv(\"CRN\")\n", " zoneId := os.Getenv(\"ZONE_ID\")\n", " xAuthUserToken := os.Getenv(\"CIS_SERVICES_APIKEY\")\n", " filterId := os.Getenv(\"FILTER_ID\")\n", " globalOptions := &filtersv1.FiltersV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: serviceURL,\n", " Authenticator: authenticator,\n", " }\n", " service, serviceErr := filtersv1.NewFiltersV1(globalOptions)\n", " options:= service.NewUpdateFiltersOptions(xAuthUserToken, crn, zoneId)\n", " filterUpdateInput := &filtersv1.FilterUpdateInput{\n", " ID: core.StringPtr(filterId),\n", " Expression: core.StringPtr(\"(ip.src eq 93.60.125.235)\"),\n", " Paused: core.BoolPtr(false),\n", " Description: core.StringPtr(\"Login-SDK-Update\"),\n", " }\n", " options.SetFilterUpdateInput([]FilterUpdateInput{*filterUpdateInput})\n", " result, response, error := service.UpdateFilters(options)\n", " if error != nil {\n", " return\n", " }\n", " fmt.Println(*result.Result[0].ID)\n", "}\n", "" ] } ] } ] } } }, "delete": { "tags": [ "Filters" ], "summary": "Delete filters", "operationId": "deleteFilters", "description": "Delete filters by filter IDs.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "query", "name": "id", "description": "IDs of filters which will be deleted.", "required": true, "example": "b7ff25282d394be7b945e23c7106ce8a", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_filters_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": [ { "id": "24b9b830dbc940bc80f84edc12a7b617" }, { "id": "f74800bdc14e480e98f97484080abd31" } ] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/filters?id=ID1&id=ID2 \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/core\"\n", " \"github.com/IBM/networking-go-sdk/filtersv1\"\n", ")\n", "\n", "func main() {\n", " serviceURL := os.Getenv(\"API_ENDPOINT\")\n", " crn := os.Getenv(\"CRN\")\n", " zoneId := os.Getenv(\"ZONE_ID\")\n", " xAuthUserToken := os.Getenv(\"CIS_SERVICES_APIKEY\")\n", " filterId := os.Getenv(\"FILTER_ID\")\n", " globalOptions := &filtersv1.FiltersV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: serviceURL,\n", " Authenticator: authenticator,\n", " }\n", " service, serviceErr := filtersv1.NewFiltersV1(globalOptions)\n", " options := service.NewDeleteFiltersOptions(xAuthUserToken, crn, zoneId, filterId)\n", " result, response, error := service.DeleteFilters(options)\n", " if error != nil {\n", " return\n", " }\n", "\n", " fmt.Println(*result.Result[0].ID)\n", "}" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/filters/{filter_identifier}": { "delete": { "tags": [ "Filters" ], "summary": "Delete a filter", "operationId": "deleteFilter", "description": "Delete a filter, given its ID.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "filter_identifier", "description": "Identifier of the filter to be deleted.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_filter_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "df887341486040fd920c620d207c85a3" } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/filters/:filter_id \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/core\"\n", " \"github.com/IBM/networking-go-sdk/filtersv1\"\n", ")\n", "\n", "func main() {\n", " serviceURL := os.Getenv(\"API_ENDPOINT\")\n", " crn := os.Getenv(\"CRN\")\n", " zoneId := os.Getenv(\"ZONE_ID\")\n", " xAuthUserToken := os.Getenv(\"CIS_SERVICES_APIKEY\")\n", " filterId := os.Getenv(\"FILTER_ID\")\n", " globalOptions := &filtersv1.FiltersV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: serviceURL,\n", " Authenticator: authenticator,\n", " }\n", " service, serviceErr := filtersv1.NewFiltersV1(globalOptions)\n", " options := service.NewDeleteFilterOptions(xAuthUserToken, crn, zoneId, filterId)\n", " result, response, error := service.DeleteFilter(options)\n", " if error != nil {\n", " return\n", " }\n", "\n", " fmt.Println(*result.Result.ID)\n", "}" ] } ] } ] } } }, "get": { "tags": [ "Filters" ], "summary": "Get filter details by ID", "operationId": "getFilter", "description": "Get the details of a filter for a zone under a service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "filter_identifier", "description": "Identifier of filter for the zone.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/filter_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "paused": false, "expression": "(http.request.uri.path ~ \"^.*/wp-login.php$\" or http.request.uri.path ~ \"^.*/xmlrpc.php$\")", "id": "df887341486040fd920c620d207c85a3", "description": "Login" } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/filters/:filter_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/core\"\n", " \"github.com/IBM/networking-go-sdk/filtersv1\"\n", ")\n", "\n", "func main() {\n", " serviceURL := os.Getenv(\"API_ENDPOINT\")\n", " crn := os.Getenv(\"CRN\")\n", " zoneId := os.Getenv(\"ZONE_ID\")\n", " xAuthUserToken := os.Getenv(\"CIS_SERVICES_APIKEY\")\n", " filterId := os.Getenv(\"FILTER_ID\")\n", " globalOptions := &filtersv1.FiltersV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: serviceURL,\n", " Authenticator: authenticator,\n", " }\n", " service, serviceErr := filtersv1.NewFiltersV1(globalOptions)\n", " if serviceErr != nil {\n", " return\n", " }\n", " options := service.NewGetFilterOptions(xAuthUserToken, crn, zoneId, filterId)\n", " result, response, error := service.GetFilter(options)\n", "\n", " if error != nil {\n", " return\n", " }\n", "\n", " fmt.Println(*result.Result.ID)\n", "}\n", "" ] } ] } ] } } }, "put": { "tags": [ "Filters" ], "summary": "Update a filter", "operationId": "updateFilter", "description": "Update an existing filter for a zone under a service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "filter_identifier", "description": "Identifier of filter", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/filter_update_input" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/filter_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "paused": false, "expression": "ip.src eq 193.184.216.0", "id": "df887341486040fd920c620d207c85a3" } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/filters/:filter_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " --data '{ \\\n", " \"expression\": \"ip.src eq 193.184.216.0\" \\\n", " }'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/core\"\n", " \"github.com/IBM/networking-go-sdk/filtersv1\"\n", ")\n", "\n", "func main() {\n", " serviceURL := os.Getenv(\"API_ENDPOINT\")\n", " crn := os.Getenv(\"CRN\")\n", " zoneId := os.Getenv(\"ZONE_ID\")\n", " xAuthUserToken := os.Getenv(\"CIS_SERVICES_APIKEY\")\n", " filterId := os.Getenv(\"FILTER_ID\")\n", " globalOptions := &filtersv1.FiltersV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: serviceURL,\n", " Authenticator: authenticator,\n", " }\n", " service, serviceErr := filtersv1.NewFiltersV1(globalOptions)\n", " options := service.NewUpdateFilterOptions(xAuthUserToken, crn, zoneId, filterId)\n", " options.SetExpression(`not http.request.uri.path matches \"^/api/.*$\"`)\n", " options.SetDescription(\"not /api\")\n", " options.SetPaused(false)\n", " result, response, error := service.UpdateFilter(optionsUpdate)\n", "\n", " if error != nil {\n", " return\n", " }\n", "\n", " fmt.Println(*result.Result.ID)\n", "}" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/firewall/rules": { "get": { "tags": [ "Firewall rules" ], "summary": "List all firewall rules for a zone", "operationId": "listAllFirewallRules", "description": "List all firewall rules for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_firewall_rules_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": [ { "filter": { "paused": false, "expression": "ip.src eq 93.184.216.0", "id": "326fa2c4ab374f2daeee43a375bcc36f" }, "paused": false, "modified_on": "2019-01-30T08:17:53.000Z", "created_on": "2019-01-30T08:17:53.000Z", "action": "allow", "id": "baab3de3114448bf9a324058dc968ea3", "priority": null }, { "filter": { "paused": false, "expression": "http.request.uri.path matches \"^/api/.*$\"", "id": "9cc1bfdd32604b839ca09cf8a49ee8f2" }, "paused": false, "modified_on": "2019-01-30T08:17:53.000Z", "created_on": "2019-01-30T08:17:53.000Z", "action": "challenge", "id": "1ae41f79213f46edb54cd3d3f3023100", "priority": null }, { "filter": { "paused": false, "expression": "http.request.uri.path contains \"/api/\" and ip.src eq 99.188.216.36", "id": "8c466260c6b3441787d367d960d674be" }, "paused": false, "modified_on": "2019-01-30T08:17:53.000Z", "created_on": "2019-01-30T08:17:53.000Z", "action": "block", "id": "5019ed8e902f4d9ab266cd2acbaeae40", "priority": null } ], "result_info": { "count": 5, "per_page": 25, "total_pages": 1, "page": 1, "total_count": 5 } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/rules \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/core\"\n", " \"github.com/IBM/networking-go-sdk/firewallrulesv1\"\n", ")\n", "\n", "func main() {\n", " authenticator := &core.IamAuthenticator{\n", " ApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", " URL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", " }\n", " serviceURL := os.Getenv(\"API_ENDPOINT\")\n", " crn := os.Getenv(\"CRN\")\n", " zoneId := os.Getenv(\"ZONE_ID\")\n", " globalOptions := &firewallrulesv1.FirewallRulesV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: serviceURL,\n", " Authenticator: authenticator,\n", " }\n", " service, serviceErr := firewallrulesv1.NewFirewallRulesV1(globalOptions)\n", " listAllFirewallRulesOptionsModel := service.NewListAllFirewallRulesOptions(xAuthUserToken, crn, zoneId)\n", " result, response, err := service.ListAllFirewallRules(listAllFirewallRulesOptionsModel)\n", " if err != nil {\n", " return\n", " }\n", " fmt.Println(*result.Result[0].ID)\n", "}\n", "" ] } ] } ] } } }, "post": { "tags": [ "Firewall rules" ], "summary": "Create firewall rules for a zone", "operationId": "createFirewallRules", "description": "Create new firewall rules for a zone under a service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewall_rules_input_with_filter_id" } } }, "description": "JSON objects which are used to create firewall rules." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewall_rules_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": [ { "filter": { "paused": false, "expression": "ip.src eq 93.184.216.0", "id": "326fa2c4ab374f2daeee43a375bcc36f" }, "paused": false, "modified_on": "2019-01-30T08:17:53.000Z", "created_on": "2019-01-30T08:17:53.000Z", "action": "allow", "id": "baab3de3114448bf9a324058dc968ea3", "priority": null }, { "filter": { "paused": false, "expression": "http.request.uri.path matches \"^/api/.*$\"", "id": "9cc1bfdd32604b839ca09cf8a49ee8f2" }, "paused": false, "modified_on": "2019-01-30T08:17:53.000Z", "created_on": "2019-01-30T08:17:53.000Z", "action": "challenge", "id": "1ae41f79213f46edb54cd3d3f3023100", "priority": null } ] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/rules \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " --data '[ \\\n", " { \\\n", " \"filter\": { \\\n", " \"id\": \"326fa2c4ab374f2daeee43a375bcc36f\" \\\n", " }, \\\n", " \"action\": \"allow\" \\\n", " }, \\\n", " { \\\n", " \"filter\": { \\\n", " \"id\": \"9cc1bfdd32604b839ca09cf8a49ee8f2\" \\\n", " }, \\\n", " \"action\": \"challenge\", \\\n", " \"paused\": false \\\n", " } \\\n", " ]'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/core\"\n", " \"github.com/IBM/networking-go-sdk/firewallrulesv1\"\n", ")\n", "\n", "func main() {\n", " authenticator := &core.IamAuthenticator{\n", " ApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", " URL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", " }\n", " serviceURL := os.Getenv(\"API_ENDPOINT\")\n", " crn := os.Getenv(\"CRN\")\n", " zoneId := os.Getenv(\"ZONE_ID\")\n", " filterId := os.Getenv(\"FILTER_ID\")\n", " globalOptions := &firewallrulesv1.FirewallRulesV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: serviceURL,\n", " Authenticator: authenticator,\n", " }\n", " service, serviceErr := firewallrulesv1.NewFirewallRulesV1(globalOptions)\n", " createFirewallRulesModel := service.NewCreateFirewallRulesOptions(xAuthUserToken, crn, zoneId)\n", " filterModel, filterErr := service.NewFirewallRuleInputWithFilterIdFilter(filterId)\n", " firewallRules := &firewallrulesv1.FirewallRuleInputWithFilterID{\n", " Filter: filterModel,\n", " Action: core.StringPtr(\"log\"),\n", " Description: core.StringPtr(\"Login-Office-SDK-Test\") ,\n", " }\n", " createFirewallRulesModel.SetFirewallRuleInputWithFilterID([]FirewallRuleInputWithFilterID{*firewallRules})\n", " result, response, err := service.CreateFirewallRules(createFirewallRulesOptionsModel)\n", " if err != nil {\n", " return\n", " }\n", " fmt.Println(*result.Result[0].ID)\n", "}\n", "" ] } ] } ] } } }, "put": { "tags": [ "Firewall rules" ], "summary": "Update firewall rules", "operationId": "updateFirewllRules", "description": "Update existing firewall rules for a zone under a service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewall_rules_update_input" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewall_rules_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": [ { "filter": { "paused": false, "expression": "ip.src eq 93.184.216.0", "id": "326fa2c4ab374f2daeee43a375bcc36f" }, "paused": false, "modified_on": "2019-01-30T08:17:56.000Z", "created_on": "2019-01-30T08:17:53.000Z", "action": "block", "id": "baab3de3114448bf9a324058dc968ea3", "priority": null }, { "priority": 200, "description": "js_challenge", "id": "1ae41f79213f46edb54cd3d3f3023100", "paused": false, "modified_on": "2019-01-30T08:17:56.000Z", "created_on": "2019-01-30T08:17:53.000Z", "action": "js_challenge", "filter": { "paused": false, "expression": "http.request.uri.path matches \"^/api/.*$\"", "id": "9cc1bfdd32604b839ca09cf8a49ee8f2" } } ] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/rules \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " --data ' [ \\\n", " { \\\n", " \"filter\": { \\\n", " \"id\": \"326fa2c4ab374f2daeee43a375bcc36f\" \\\n", " }, \\\n", " \"action\": \"block\", \\\n", " \"id\": \"baab3de3114448bf9a324058dc968ea3\" \\\n", " }, \\\n", " { \\\n", " \"paused\": false, \\\n", " \"description\": \"js_challenge\", \\\n", " \"filter\": { \\\n", " \"id\": \"9cc1bfdd32604b839ca09cf8a49ee8f2\" \\\n", " }, \\\n", " \"action\": \"js_challenge\", \\\n", " \"id\": \"1ae41f79213f46edb54cd3d3f3023100\", \\\n", " \"priority\": 200 \\\n", " } \\\n", " ]'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/core\"\n", " \"github.com/IBM/networking-go-sdk/firewallrulesv1\"\n", ")\n", "\n", "func main() {\n", " authenticator := &core.IamAuthenticator{\n", " ApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", " URL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", " }\n", " serviceURL := os.Getenv(\"API_ENDPOINT\")\n", " crn := os.Getenv(\"CRN\")\n", " zoneId := os.Getenv(\"ZONE_ID\")\n", " firewallRuleId := os.Getenv(\"FIREWALLRULE_ID\")\n", " filterId := os.Getenv(\"FILTER_ID\")\n", " globalOptions := &firewallrulesv1.FirewallRulesV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: serviceURL,\n", " Authenticator: authenticator,\n", " }\n", " service, serviceErr := firewallrulesv1.NewFirewallRulesV1(globalOptions)\n", " if serviceErr != nil {\n", " return\n", " }\n", " updateOption := service.NewUpdateFirewllRulesOptions(xAuthUserToken, crn, zoneId)\n", " filterModel, filterErr :=service.NewFirewallRulesUpdateInputItemFilter(filterId)\n", " firewallRulesUpdate := &FirewallRulesUpdateInputItem{\n", " ID: core.StringPtr(firewallRuleId),\n", " Action: core.StringPtr(\"block\"),\n", " Description: core.StringPtr(\"Firewall-Rules-Update\",\n", " Filter: filterUpdate,\n", " }\n", " updateOption.SetFirewallRulesUpdateInputItem([]FirewallRulesUpdateInputItem{*firewallRulesUpdate})\n", " result, response, err := service.UpdateFirewllRules(updateOption)\n", " if err != nil {\n", " return\n", " }\n", " fmt.Println(*result.Result[0].ID)\n", "} " ] } ] } ] } } }, "delete": { "tags": [ "Firewall rules" ], "summary": "Delete firewall rules", "operationId": "deleteFirewallRules", "description": "Delete firewall rules by filter IDs.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "query", "name": "id", "description": "IDs of firewall rules which will be deleted.", "required": true, "example": "f2d427378e7542acb295380d352e2ebd", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_firewall_rules_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": [ { "id": "baab3de3114448bf9a324058dc968ea3" }, { "id": "1ae41f79213f46edb54cd3d3f3023100" } ] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/rules?id=ID1&id=ID2 \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/core\"\n", " \"github.com/IBM/networking-go-sdk/firewallrulesv1\"\n", ")\n", "\n", "func main() {\n", " authenticator := &core.IamAuthenticator{\n", " ApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", " URL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", " }\n", " serviceURL := os.Getenv(\"API_ENDPOINT\")\n", " crn := os.Getenv(\"CRN\")\n", " zoneId := os.Getenv(\"ZONE_ID\")\n", " firewallRuleId := os.Getenv(\"FIREWALLRULE_ID\")\n", "\n", " globalOptions := &firewallrulesv1.FirewallRulesV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: serviceURL,\n", " Authenticator: authenticator,\n", " }\n", " service, serviceErr := firewallrulesv1.NewFirewallRulesV1(globalOptions)\n", " delOptions := service.NewDeleteFirewallRulesOptions(xAuthUserToken, crn, zoneId, firewallRuleId)\n", " result, response, err := service.DeleteFirewallRules(delOptions)\n", " if err != nil {\n", " return\n", " }\n", " fmt.Println(*result.Result[0].ID)\n", "}\n", "" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/firewall/rules/{firewall_rule_identifier}": { "delete": { "tags": [ "Firewall rules" ], "summary": "Delete a firewall rule", "operationId": "deleteFirewallRule", "description": "Delete a firewall rule, given its ID.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "firewall_rule_identifier", "description": "Identifier of the firewall rule to be deleted.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_firewall_rule_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "id": "8719aac958c64e31b07ce6c2612bec6b" } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/rules/:firewall_rule_id \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import (\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/core\"\n", " \"github.ibm.com/ibmcloud/networking-go-sdk/firewallrulesv1\"\n", ")\n", "\n", "func main() {\n", " authenticator := &core.IamAuthenticator{\n", " ApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", " URL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", " }\n", " serviceURL := os.Getenv(\"API_ENDPOINT\")\n", " crn := os.Getenv(\"CRN\")\n", " zoneId := os.Getenv(\"ZONE_ID\")\n", " firewallRuleId := os.Getenv(\"FIREWALLRULE_ID\")\n", "\n", " globalOptions := &firewallrulesv1.FirewallRulesV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: serviceURL,\n", " Authenticator: authenticator,\n", " }\n", " service, serviceErr := firewallrulesv1.NewFirewallRulesV1(globalOptions)\n", " delFirewallRuleOptionsModel := service.NewDeleteFirewallRuleOptions(xAuthUserToken, crn, zoneId, firewallRuleId)\n", " result, response, err := service.DeleteFirewallRule(delFirewallRuleOptionsModel)\n", " if err != nil {\n", " return\n", " }\n", " fmt.Println(*result.Result.ID)\n", "}" ] } ] } ] } } }, "get": { "tags": [ "Firewall rules" ], "summary": "Get firewall rule details by ID", "operationId": "getFirewallRule", "description": "Get the details of a firewall rule for a zone under a service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "firewall_rule_identifier", "description": "Identifier of firewall rule for the zone.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewall_rule_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "priority": null, "description": "JS challenge site", "id": "8719aac958c64e31b07ce6c2612bec6b", "paused": false, "modified_on": "2019-01-30T08:17:53.000Z", "created_on": "2019-01-30T08:17:53.000Z", "action": "js_challenge", "filter": { "paused": false, "expression": "(http.request.uri.path ~ \"^.*/wp-login.php$\" or http.request.uri.path ~ \"^.*/xmlrpc.php$\")", "id": "cb5cfb3a37634349b1f3e66da6bb7ce6", "description": "Login" } } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/rules/:firewall_rule_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/core\"\n", " \"github.com/IBM/networking-go-sdk/firewallrulesv1\"\n", ")\n", "\n", "func main() {\n", " authenticator := &core.IamAuthenticator{\n", " ApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", " URL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", " }\n", " serviceURL := os.Getenv(\"API_ENDPOINT\")\n", " crn := os.Getenv(\"CRN\")\n", " zoneId := os.Getenv(\"ZONE_ID\")\n", " firewallRuleId := os.Getenv(\"FIREWALLRULE_ID\")\n", "\n", " globalOptions := &firewallrulesv1.FirewallRulesV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: serviceURL,\n", " Authenticator: authenticator,\n", " }\n", " service, serviceErr := firewallrulesv1.NewFirewallRulesV1(globalOptions)\n", " getFirewallRuleOptionsModel := service.NewGetFirewallRuleOptions(xAuthUserToken, crn, zoneId, firewallRuleId)\n", " result, response, err := service.GetFirewallRule(getFirewallRuleOptionsModel)\n", " if err != nil {\n", " return\n", " }\n", " fmt.Println(*result.Result.ID)\n", "}" ] } ] } ] } } }, "put": { "tags": [ "Firewall rules" ], "summary": "Update a firewall rule", "operationId": "updateFirewallRule", "description": "Update an existing firewall rule for a zone under a service instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "path", "name": "firewall_rule_identifier", "description": "Identifier of firewall rule", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewall_rule_update_input" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firewall_rule_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "filter": { "paused": false, "expression": "(http.request.uri.path ~ \"^.*/wp-login.php$\" or http.request.uri.path ~ \"^.*/xmlrpc.php$\")", "id": "cb5cfb3a37634349b1f3e66da6bb7ce6", "description": "Login" }, "paused": false, "modified_on": "2019-01-30T08:18:01.000Z", "created_on": "2019-01-30T08:17:53.000Z", "action": "block", "id": "8719aac958c64e31b07ce6c2612bec6b", "priority": null } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/firewall/rules/:firewall_rule_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " --data '{ \\\n", " \"filter\": { \\\n", " \"id\": \"cb5cfb3a37634349b1f3e66da6bb7ce6\" \\\n", " }, \\\n", " \"action\": \"block\" \\\n", " }'\n" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "package main\n", "\n", "import (\n", " \"fmt\"\n", " \"os\"\n", "\n", " \"github.com/IBM/go-sdk-core/core\"\n", " \"github.com/IBM/networking-go-sdk/firewallrulesv1\"\n", ")\n", "\n", "func main() {\n", " authenticator := &core.IamAuthenticator{\n", " ApiKey: os.Getenv(\"CIS_SERVICES_APIKEY\"),\n", " URL: os.Getenv(\"CIS_SERVICES_AUTH_URL\"),\n", " }\n", " serviceURL := os.Getenv(\"API_ENDPOINT\")\n", " crn := os.Getenv(\"CRN\")\n", " zoneId := os.Getenv(\"ZONE_ID\")\n", " firewallRuleId := os.Getenv(\"FIREWALLRULE_ID\")\n", " filterId := os.Getenv(\"FILTER_ID\")\n", "\n", " globalOptions := &firewallrulesv1.FirewallRulesV1Options{\n", " ServiceName: \"cis_services\",\n", " URL: serviceURL,\n", " Authenticator: authenticator,\n", " }\n", " service, serviceErr := firewallrulesv1.NewFirewallRulesV1(globalOptions)\n", " updateFirewallRuleOptionsModel := service.NewUpdateFirewallRuleOptions(xAuthUserToken, crn, zoneId, firewallRuleId)\n", " updateFirewallRuleOptionsModel.SetAction(\"block\")\n", " updateFirewallRuleOptionsModel.SetPaused(false)\n", " updateFirewallRuleOptionsModel.SetDescription(\"SDK JS challenge site Test\")\n", " firewallFilterInput, firewallInputErr := service.NewFirewallRuleUpdateInputFilter(filterId)\n", " updateFirewallRuleOptionsModel.SetFilter(firewallFilterInput)\n", " result, response, err := service.UpdateFirewallRule(updateFirewallRuleOptionsModel)\n", " if err != nil {\n", " return\n", " }\n", " fmt.Println(*result.Result.ID)\n", "}\n", "" ] } ] } ] } } } }, "/v1/{crn}/alerting/policies": { "get": { "tags": [ "Alert Policies" ], "summary": "List alert policies", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.read" } ] }, "description": "List configured alert policies for the CIS instance.", "parameters": [ { "$ref": "#/components/parameters/crn" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_alert_policies_resp" }, "examples": { "response": { "value": { "result": [ { "id": "f0413b106d2c4aa9b1553d5d0209c522", "name": "My Policy", "description": "DDOS Attack Alert Policy", "enabled": true, "alert_type": "dos_attack_l7", "mechanisms": { "email": [ { "id": "mymail@something.com" } ] }, "created": "2021-09-15T16:33:31.834209Z", "modified": "2021-09-15T16:33:31.834209Z", "conditions": {}, "filters": {} } ], "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/alerting/policies \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "post": { "tags": [ "Alert Policies" ], "summary": "Create an alert policy", "operationId": "create_alert_policy", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.update" } ] }, "description": "Create a new alert policy for the CIS instance.", "parameters": [ { "$ref": "#/components/parameters/crn" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_alert_policy_input" }, "examples": { "DDoSAlerter": { "$ref": "#/components/examples/ddos_alerter_example" }, "PoolEnablementAlerter": { "$ref": "#/components/examples/pool_enablement_alerter_example" }, "WAFAlerter": { "$ref": "#/components/examples/waf_alerter_example" }, "AdvancedWAFAlerter": { "$ref": "#/components/examples/advanced_waf_alerter_example" }, "UniversalSSLAlerter": { "$ref": "#/components/examples/universal_ssl_alerter_example" }, "DedicatedSSLAlerter": { "$ref": "#/components/examples/dedicated_ssl_alerter_example" }, "LBHealthCheckAlerter": { "$ref": "#/components/examples/lb_health_check_alerter_example" }, "LBPoolEnablementAlerter": { "$ref": "#/components/examples/lb_pool_enable_alerter_example" }, "WebTrafficReporter": { "$ref": "#/components/examples/web_traffic_reporter_example" }, "CFMaintenanceReporter": { "$ref": "#/components/examples/maintenance_alerter_example" } } } }, "description": "Create alert policy body" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_success_resp" }, "examples": { "response": { "value": { "result": { "id": "f0413b106d2c4aa9b1553d5d0209c522" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/alerting/policies \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"name\":\"Example Policy\",\"enabled\":true,\"alert_type\":\"dos_attack_l7\",\"mechanisms\":{\"email\":[{\"id\":\"cistestemail@ibm.com\"}],\"webhooks\":[]}}'\n" ] } ] } ] } } } }, "/v1/{crn}/alerting/policies/{policy_id}": { "get": { "tags": [ "Alert Policies" ], "summary": "Get an alert policy", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.read" } ] }, "description": "Get an alert policy for the CIS instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "in": "path", "name": "policy_id", "description": "Alert policy identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_alert_policy_resp" }, "examples": { "response": { "value": { "result": { "id": "f0413b106d2c4aa9b1553d5d0209c522", "name": "My Policy", "description": "DDOS Attack Alert Policy", "enabled": true, "alert_type": "dos_attack_l7", "mechanisms": { "email": [ { "id": "mymail@something.com" } ] }, "created": "2021-09-15T16:33:31.834209Z", "modified": "2021-09-15T16:33:31.834209Z", "conditions": {}, "filters": {} }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/alerting/policies/:policy_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "put": { "tags": [ "Alert Policies" ], "summary": "Update an alert policy", "operationId": "update_alert_policy", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.update" } ] }, "description": "Update an existing alert policy for the CIS instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "in": "path", "name": "policy_id", "description": "Alert policy identifier", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_alert_policy_input" } } }, "description": "Update alert policy body" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_success_resp" }, "examples": { "response": { "value": { "result": { "id": "f0413b106d2c4aa9b1553d5d0209c522" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/alerting/policies/:policy_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"name\":\"Example Policy\",\"enabled\":true,\"alert_type\":\"dos_attack_l7\",\"conditions\":{},\"mechanisms\":{\"email\":[{\"id\":\"cistestemail@ibm.com\"}],\"webhooks\":[]}}'\n" ] } ] } ] } } }, "delete": { "tags": [ "Alert Policies" ], "summary": "Delete an alert policy", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.update" } ] }, "description": "Delete an alert policy for the CIS instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "in": "path", "name": "policy_id", "description": "Alert policy identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_success_resp" }, "examples": { "response": { "value": { "result": { "id": "f0413b106d2c4aa9b1553d5d0209c522" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/alerting/policies/:policy_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v1/{crn}/alerting/policies/{policy_id}/test": { "post": { "tags": [ "Alert Policies" ], "summary": "Test an alert policy", "operationId": "test_alert_policy", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.update" } ] }, "description": "Test an existing alert policy for the CIS instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "in": "path", "name": "policy_id", "description": "Alert policy identifier", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/test_alert_policy_input" } } }, "description": "Test alert policy body" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/test_alert_success_resp" }, "examples": { "response": { "value": { "result": true, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/alerting/policies/:policy_id/test \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{}'\n" ] } ] } ] } } } }, "/v1/{crn}/alerting/destinations/webhooks": { "get": { "tags": [ "Alert Webhooks" ], "summary": "List alert webhooks", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.read" } ] }, "description": "List configured alert webhooks for the CIS instance.", "parameters": [ { "$ref": "#/components/parameters/crn" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_alert_webhooks_resp" }, "examples": { "response": { "value": { "result": [ { "id": "6d16fcab-3e80-44b3-b59b-a3716237832e", "name": "My Webhook", "url": "https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd", "type": "generic", "created_at": "2021-09-15T16:33:31.834209Z", "last_success": null, "last_failure": null } ], "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/alerting/destinations/webhooks \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "post": { "tags": [ "Alert Webhooks" ], "summary": "Create an alert webhook", "operationId": "create_alert_webhook", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.update" } ] }, "description": "Create a new alert webhook for the CIS instance.", "parameters": [ { "$ref": "#/components/parameters/crn" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_webhook_input" } } }, "description": "Create alert webhook body" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_success_resp" }, "examples": { "response": { "value": { "result": { "id": "6d16fcab-3e80-44b3-b59b-a3716237832e" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/alerting/destinations/webhooks \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"name\":\"Example Webhook\",\"url\":\"https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd\"}'\n" ] } ] } ] } } } }, "/v1/{crn}/alerting/destinations/webhooks/{webhook_id}": { "get": { "tags": [ "Alert Webhooks" ], "summary": "Get an alert webhook", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.read" } ] }, "description": "Get an alert webhook for the CIS instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "in": "path", "name": "webhook_id", "description": "Alert webhook identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_alert_webhook_resp" }, "examples": { "response": { "value": { "result": { "id": "6d16fcab-3e80-44b3-b59b-a3716237832e", "name": "My Webhook", "url": "https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd", "type": "generic", "created_at": "2021-09-15T16:33:31.834209Z", "last_success": null, "last_failure": null }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/alerting/destinations/webhooks/:webhook_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "put": { "tags": [ "Alert Webhooks" ], "summary": "Update an alert webhook", "operationId": "update_alert_webhook", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.update" } ] }, "description": "Update an existing alert webhook for the CIS instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "in": "path", "name": "webhook_id", "description": "Alert webhook identifier", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_webhook_input" } } }, "description": "Update alert webhook body" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_success_resp" }, "examples": { "response": { "value": { "result": { "id": "6d16fcab-3e80-44b3-b59b-a3716237832e" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/alerting/destinations/webhooks/:webhook_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " -d '{\"name\":\"Example Webhook\",\"url\":\"https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd\"}'\n" ] } ] } ] } } }, "delete": { "tags": [ "Alert Webhooks" ], "summary": "Delete an alert webhook", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.update" } ] }, "description": "Delete an alert webhook for the CIS instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "in": "path", "name": "webhook_id", "description": "Alert webhook identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_success_resp" }, "examples": { "response": { "value": { "result": { "id": "6d16fcab-3e80-44b3-b59b-a3716237832e" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/alerting/destinations/webhooks/:webhook_id \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v2/{crn}/zones/{zone_id}/logpush/jobs": { "get": { "tags": [ "Logpush Jobs" ], "summary": "List logpush jobs", "operationId": "get_logpush_jobs_v2", "description": "List configured logpush jobs for your domain.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_logpush_jobs_resp" }, "examples": { "response": { "value": { "result": [ { "id": 5780, "enabled": false, "name": "CIS-Logpush-Job", "dataset": "firewall_events", "logpull_options": "timestamps=rfc3339×tamps=rfc3339", "destination_conf": "cos://cos-bucket001?region=us-south&instance-id=231f5467-3072-4cb9-9e39-a906fa3032ea", "frequency": "high", "last_complete": null, "last_error": null, "error_message": null } ], "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v2/$CRN/zones/$ZONE_ID/logpush/jobs \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx'\n" ] } ] } ] } } }, "post": { "tags": [ "Logpush Jobs" ], "summary": "Create a logpush job", "operationId": "create_logpush_job_v2", "description": "Create a new logpush job for the domain.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/logpush_job_ibmcl_req" }, { "$ref": "#/components/schemas/logpush_job_cos_req" }, { "$ref": "#/components/schemas/logpush_job_logdna_req" }, { "$ref": "#/components/schemas/logpush_job_splunk_req" }, { "$ref": "#/components/schemas/logpush_job_generic_req" } ] } } }, "description": "Create logpush job body" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logpush_jobs_resp" }, "examples": { "response": { "value": { "result": { "id": 5780, "enabled": false, "name": "CIS-Logpush-Job", "dataset": "firewall_events", "logpull_options": "timestamps=rfc3339×tamps=rfc3339", "destination_conf": "cos://cos-bucket001?region=us-south&instance-id=231f5467-3072-4cb9-9e39-a906fa3032ea", "frequency": "high", "last_complete": null, "last_error": null, "error_message": null }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v2/$CRN/zones/$ZONE_ID/logpush/jobs \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx' \\\n", " -d '{\"name\":\"cloud-logs-logpush\",\"ibmcl\":{\"instance_id\":\"604afake-585c-4a42-955d-76239ccc1905\",\"region\":\"us-south\",\"api_key\":\"fakeNQI22dPwNVCcmS62YFL1tm9vaehY6C9jxdtfake\"},\"logpull_options\":\"fields=RayID,CacheResponseBytes,CacheResponseStatus,CacheCacheStatus×tamps=rfc3339\",\"frequency\":\"high\",\"dataset\":\"http_requests\",\"enabled\":true}'\n" ] } ] } ] } } } }, "/v2/{crn}/zones/{zone_id}/logpush/jobs/{job_id}": { "get": { "tags": [ "Logpush Jobs" ], "summary": "Get a logpush job", "operationId": "get_logpush_job_v2", "description": "Get a logpush job for a given zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "in": "path", "name": "job_id", "description": "Logpush job identifier", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logpush_jobs_resp" }, "examples": { "response": { "value": { "result": { "id": 5780, "enabled": false, "name": "CIS-Logpush-Job", "dataset": "firewall_events", "logpull_options": "timestamps=rfc3339×tamps=rfc3339", "destination_conf": "cos://cos-bucket001?region=us-south&instance-id=231f5467-3072-4cb9-9e39-a906fa3032ea", "frequency": "high", "last_complete": null, "last_error": null, "error_message": null }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v2/$CRN/zones/$ZONE_ID/logpush/jobs/$JOB_ID \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx'\n" ] } ] } ] } } }, "put": { "tags": [ "Logpush Jobs" ], "summary": "Update a logpush job", "operationId": "update_logpush_job_v2", "description": "Update an existing logpush job for a given zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "in": "path", "name": "job_id", "description": "Logpush job identifier", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/logpush_jobs_update_ibmcl_req" }, { "$ref": "#/components/schemas/logpush_jobs_update_cos_req" }, { "$ref": "#/components/schemas/logpush_jobs_update_logdna_req" }, { "$ref": "#/components/schemas/logpush_jobs_update_splunk_req" }, { "$ref": "#/components/schemas/logpush_jobs_update_generic_req" } ] } } }, "description": "Update logpush job" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logpush_jobs_resp" }, "examples": { "response": { "value": { "result": { "id": 5780, "enabled": false, "name": "CIS-Logpush-Job", "dataset": "firewall_events", "logpull_options": "timestamps=rfc3339×tamps=rfc3339", "destination_conf": "cos://cos-bucket001?region=us-south&instance-id=231f5467-3072-4cb9-9e39-a906fa3032ea", "frequency": "high", "last_complete": null, "last_error": null, "error_message": null }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v2/$CRN/zones/$ZONE_ID/logpush/jobs/$JOB_ID \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx' \\\n", " -d '{\"ibmcl\":{\"instance_id\":\"604afake-585c-4a42-955d-76239ccc1905\",\"region\":\"us-south\",\"api_key\":\"fakeNQI22dPwNVCcmS62YFL1tm9vaehY6C9jxdtfake\"},\"enabled\":false}'\n" ] } ] } ] } } }, "delete": { "tags": [ "Logpush Jobs" ], "summary": "Delete a logpush job", "operationId": "delete_logpush_job_v2", "description": "Delete a logpush job for a zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "in": "path", "name": "job_id", "description": "Logpush job identifier", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_logpush_job_resp" }, "examples": { "response": { "value": { "result": {}, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v2/$CRN/zones/$ZONE_ID/logpush/jobs/$JOB_ID \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v2/{crn}/zones/{zone_id}/logpush/ownership": { "post": { "tags": [ "Logpush Jobs" ], "summary": "Get a new ownership challenge sent to your destination", "operationId": "get_logpush_ownership_v2", "description": "Get a new ownership challenge.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logpush_ownership_cos_req" } } }, "description": "Get ownership body" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ownership_challenge_resp" }, "examples": { "response": { "value": { "result": { "filename": "logs/challenge-filename.txt", "valid": true, "message": "" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v2/$CRN/zones/$ZONE_ID/logpush/ownership \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx' \\\n", " -d '{\"cos\":{\"bucket_name\":\"cos-bucket001\",\"region\":\"us-south\",\"id\":\"231f5467-3072-4cb9-9e39-a906fa3032ea\"}}'\n" ] } ] } ] } } } }, "/v2/{crn}/zones/{zone_id}/logpush/ownership/validate": { "post": { "tags": [ "Logpush Jobs" ], "summary": "Validate ownership challenge of the destination", "operationId": "validate_logpush_ownership_challenge_v2", "description": "Validate ownership challenge of the destination", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ownership_validate_cos_req" } } }, "description": "Get ownership body" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ownership_challenge_validate_result" }, "examples": { "response": { "value": { "result": { "valid": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v2/$CRN/zones/$ZONE_ID/logpush/validate \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx' \\\n", " -d '{\"cos\":{\"bucket_name\":\"cos-bucket001\",\"region\":\"us-south\",\"id\":\"231f5467-3072-4cb9-9e39-a906fa3032ea\"},\"ownership_challenge\":\"00000000000000000000\"}'\n" ] } ] } ] } } } }, "/v2/{crn}/zones/{zone_id}/logpush/datasets/{dataset}/fields": { "get": { "tags": [ "Logpush Jobs" ], "summary": "The list of all fields available for a dataset", "operationId": "list_fields_for_dataset_v2", "description": "The list of all fields available for a dataset.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "in": "path", "name": "dataset", "x-sdk-global-param": true, "description": "The dataset", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_fields_resp" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": {} } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v2/$CRN/zones/$ZONE_ID/logpush/datasets/$DATASET/fields \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v2/{crn}/zones/{zone_id}/logpush/datasets/{dataset}/jobs": { "get": { "tags": [ "Logpush Jobs" ], "summary": "List logpush jobs for dataset", "operationId": "list_logpush_jobs_for_dataset_v2", "description": "List configured logpush jobs for a dataset.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" }, { "in": "path", "name": "dataset", "x-sdk-global-param": true, "description": "The dataset", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logpush_jobs_resp" }, "examples": { "response": { "value": { "result": { "id": 5780, "enabled": false, "name": "CIS-Logpush-Job", "dataset": "firewall_events", "logpull_options": "timestamps=rfc3339×tamps=rfc3339", "destination_conf": "cos://cos-bucket001?region=us-south&instance-id=231f5467-3072-4cb9-9e39-a906fa3032ea", "frequency": "high", "last_complete": null, "last_error": null, "error_message": null }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v2/$CRN/zones/$ZONE_ID/logpush/datasets/$DATASET/jobs \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/logs/retention": { "get": { "tags": [ "Logpush Jobs" ], "summary": "Get log retention", "operationId": "get_logs_retention", "description": "Get log retention setting for Logpull/Logpush on your domain.", "parameters": [ { "in": "path", "name": "crn", "x-sdk-global-param": true, "description": "Full URL-encoded cloud resource name of the service instance", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "zone_id", "x-sdk-global-param": true, "description": "The domain ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/log_retention_resp" }, "examples": { "response": { "value": { "result": { "flag": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v2/$CRN/zones/$ZONE_ID/logs/retention \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx'\n" ] } ] } ] } } }, "post": { "tags": [ "Logpush Jobs" ], "summary": "Update log retention", "operationId": "create_log_retention", "description": "Update log retention flag for Logpull/Logpush.", "parameters": [ { "in": "path", "name": "crn", "x-sdk-global-param": true, "description": "Full URL-encoded cloud resource name of the service instance", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "zone_id", "x-sdk-global-param": true, "description": "The domain ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/log_retention_req" } } }, "description": "Create logpush job body" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/log_retention_resp" }, "examples": { "response": { "value": { "result": { "flag": true }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v2/$CRN/zones/$ZONE_ID/logs/retention \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx' \\\n", " -d '{\"flag\":true}'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/logs/rayids/{ray_id}": { "get": { "tags": [ "Logs RayID" ], "summary": "Get logs by RayID", "operationId": "get_logs_by_rayid", "description": "Get log events for a specific RayID. RayIDs are unique identifiers for requests that can be used to trace requests through Cloudflare's network.", "parameters": [ { "in": "path", "name": "crn", "x-sdk-global-param": true, "description": "Full URL-encoded cloud resource name of the service instance", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "zone_id", "x-sdk-global-param": true, "description": "The domain ID", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "ray_id", "description": "RayID identifier for the request", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated list of fields to include in the response. If not specified, all fields are returned.", "required": false, "schema": { "type": "string" }, "example": "RayID,ClientIP,EdgeStartTimestamp" }, { "name": "timestamps", "in": "query", "description": "Format for timestamps. Options are 'unix', 'unixnano', or 'rfc3339'. Default is 'unix'.", "required": false, "schema": { "type": "string", "enum": [ "unix", "unixnano", "rfc3339" ], "default": "unix" }, "example": "rfc3339" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logs_rayid_resp" }, "examples": { "response": { "value": { "result": [ { "RayID": "7e8b4c5d6f7a8b9c", "ClientIP": "192.0.2.1", "EdgeStartTimestamp": "2026-01-15T10:30:00Z", "EdgeEndTimestamp": "2026-01-15T10:30:01Z", "ClientRequestHost": "example.com", "ClientRequestMethod": "GET", "ClientRequestURI": "/v1/status", "EdgeResponseStatus": 200, "EdgeResponseBytes": 1234, "ClientASN": 15169, "ClientCountry": "US" } ], "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/zones/$ZONE_ID/logs/rayids/$RAY_ID \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/bot_analytics/score_source": { "get": { "tags": [ "Bot Analytics" ], "summary": "Get Bot Analytics score source", "operationId": "get_bot_score", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.bot_score.read" } ] }, "description": "Get Bot Analytics score source for a given zone. Use this to identify the most common detection engines used to score your traffic.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "query", "name": "since", "description": "UTC datetime for start of query.", "required": true, "schema": { "type": "string", "format": "date-time" }, "example": { "value": "2021-06-10T00:00:00Z", "summary": "Example of since parameter" } }, { "in": "query", "name": "until", "description": "UTC datetime for end of query.", "required": true, "schema": { "type": "string", "format": "date-time" }, "example": { "value": "2021-06-11T00:00:00Z", "summary": "Example of until parameter" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_score_resp" }, "examples": { "response": { "value": { "result": [ { "botScore": [ { "avg": { "sampleInterval": 1.122218123693594 }, "count": 73016, "dimensions": { "botScoreSrcName": "heuristics" } } ] } ], "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/zones/$ZONE_ID/bot_analytics/score_source?since=2021-06-10T00:00:00Z&until=2021-06-11T00:00:00Z \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer $TOKEN'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/bot_analytics/timeseries": { "get": { "tags": [ "Bot Analytics" ], "summary": "Get Bot Analytics timeseries", "operationId": "get_bot_timeseries", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.bot_timeseries.read" } ] }, "description": "Get Bot Analytics timeseries for a given zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "query", "name": "since", "description": "UTC datetime for start of query.", "required": true, "schema": { "type": "string", "format": "date-time" }, "example": { "value": "2021-06-10T00:00:00Z", "summary": "Example of since parameter" } }, { "in": "query", "name": "until", "description": "UTC datetime for end of query.", "required": true, "schema": { "type": "string", "format": "date-time" }, "example": { "value": "2021-06-11T00:00:00Z", "summary": "Example of until parameter" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_timeseries_resp" }, "examples": { "response": { "value": { "result": [ { "topASNs": [ { "avg": { "sampleInterval": 1.1220114264422778 }, "count": 72271, "dimensions": { "description": "SOFTLAYER", "metric": "36351" } } ], "topCountries": [ { "avg": { "sampleInterval": 1.1220379514891767 }, "count": 72257, "dimensions": { "metric": "US" } } ], "topHosts": [ { "avg": { "sampleInterval": 1.1220379514891767 }, "count": 72257, "dimensions": { "metric": "example.com" } } ], "topIPs": [ { "avg": { "sampleInterval": 1.1220114264422778 }, "count": 72271, "dimensions": { "metric": "169.48.154.210" } } ], "topJA3Hashes": [ { "avg": { "sampleInterval": 1.1220152150287221 }, "count": 72269, "dimensions": { "metric": "" } } ], "topPaths": [ { "avg": { "sampleInterval": 1.1220246875242605 }, "count": 72264, "dimensions": { "metric": "/" } } ], "topUserAgents": [ { "avg": { "sampleInterval": 1.1220114264422778 }, "count": 72271, "dimensions": { "metric": "curl/7.58.0" } } ] } ], "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/zones/$ZONE_ID/bot_analytics/timeseries?since=2021-06-10T00:00:00Z&until=2021-06-11T00:00:00Z \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer $TOKEN'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/bot_analytics/top_ns": { "get": { "tags": [ "Bot Analytics" ], "summary": "Get Bot Analytics top attributes", "operationId": "get_bot_topns", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.bot_topns.read" } ] }, "description": "Get Bot Analytics top attributes for a given zone. Use this to view more detailed information on specific IP addresses and other characteristics.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "query", "name": "since", "description": "UTC datetime for start of query.", "required": true, "schema": { "type": "string", "format": "date-time" }, "example": { "value": "2021-06-10T00:00:00Z", "summary": "Example of since parameter" } }, { "in": "query", "name": "until", "description": "UTC datetime for end of query.", "required": true, "schema": { "type": "string", "format": "date-time" }, "example": { "value": "2021-06-11T00:00:00Z", "summary": "Example of until parameter" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_topns_resp" }, "examples": { "response": { "value": { "result": null, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/zones/$ZONE_ID/bot_analytics/top_ns?since=2021-06-10T00:00:00Z&until=2021-06-11T00:00:00Z \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer $TOKEN'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/bot_management": { "get": { "tags": [ "Bot Management Settings" ], "summary": "Get Bot management settings", "operationId": "get_bot_management", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.bot_management.read" } ] }, "description": "Get Bot management settings for a given zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_mgt_resp" }, "examples": { "response": { "value": { "result": { "type": "cloudflare", "scope": "both" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/zones/$ZONE_ID/bot_management \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "put": { "tags": [ "Bot Management Settings" ], "summary": "Update Bot management settings", "operationId": "update_bot_management", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.security.update" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.bot_management.update" } ] }, "description": "Update Bot management settings for given zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_mgt_settings" } } }, "description": "Update Bot management setting." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_mgt_resp" }, "examples": { "response": { "value": { "result": { "session_score": false, "enable_js": false, "use_latest_model": true, "ai_bots_protection": "block" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/zones/$ZONE_ID/bot_management \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer $TOKEN' \\\n", " -d '{\"enable_js\": false, \"session_score\": false, \"ai_bots_protection\": \"block\"}'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/hold": { "get": { "tags": [ "Zone Hold" ], "summary": "Get Zone Hold", "operationId": "get_zone_hold", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.reliability.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.zone_hold.read" } ] }, "description": "Get zone hold status for a given zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_hold_list_resp" }, "examples": { "response": { "value": { "result": { "hold": true, "hold_after": "2023-01-01T05:20:00.000Z", "include_subdomains": false }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } }, "post": { "tags": [ "Zone Hold" ], "summary": "Enforce a zone hold", "operationId": "create_zone_hold", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.reliability.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.zone_hold.create" } ] }, "description": "Enforce a zone hold for given zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_hold_resp" }, "examples": { "response": { "value": { "result": { "hold": true, "hold_after": "2023-01-01T05:20:00.000Z", "include_subdomains": false }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } }, "delete": { "tags": [ "Zone Hold" ], "summary": "Stop enforcement of a zone hold on the zone", "operationId": "delete_zone_hold", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.reliability.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.zone_hold.read" } ] }, "description": "Stop enforcement of a zone hold for a given zone.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_hold_delete_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } } } }, "/v1/{crn}/zones/{zone_identifier}/range/analytics/events/summary": { "get": { "tags": [ "Range Analytics" ], "summary": "Get range analytics summary", "operationId": "get_range_analytics_summary", "description": "Get summarized analytics data for Range applications.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "query", "name": "metrics", "description": "One or more metrics to compute.", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "count", "bytesIngress", "bytesEgress", "durationAvg", "durationMedian", "duration90th", "duration99th" ] } } }, { "in": "query", "name": "dimensions", "description": "Used to break down the data by given attributes.", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "event", "appID", "coloName", "ipVersion" ] } } }, { "in": "query", "name": "filters", "description": "Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Comparison options are:", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "description": "The sort order for the result set; sort fields must be included in metrics or dimensions.", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "in": "query", "name": "since", "description": "The start of the time interval to query, which defaults to `until - 6 hours`.", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "until", "description": "The end of the time interval to query, which defaults to the current time.", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Success", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/analytics_summary_response" } }, "application/json": { "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "rows": 2, "data": [ { "metrics": [ [ 4, 3 ] ] } ], "totals": { "count": 4, "bytesIngress": 3 }, "min": { "count": 4, "bytesIngress": 3 }, "max": { "count": 4, "bytesIngress": 3 }, "data_lag": 60, "query": { "metrics": [ "count", "bytesIngress" ], "dimensions": [ "event", "appID" ], "filters": "event==connect AND coloName!=SFO", "sort": [ { "Id": "count", "Desc": false }, { "Id": "bytesIngress", "Desc": true } ], "since": "2014-01-02T02:20:00.000Z", "until": "2014-01-02T03:20:00.000Z", "limit": 10000 } } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \"https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/range/analytics/events/summary?metrics=count,bytesIngress&dimensions=event,appID&filters=event==connect AND coloName!=SFO&sort=+count,-bytesIngress&since=2014-01-02T02:20:00Z&until=2014-01-02T03:20:00Z\" \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from cis_services import RangeAnalyticsSummaryV1\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and zone id from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " # create instance\n", " analytics = RangeAnalyticsSummaryV1.new_instance(service_name=\"cis_services\")\n", " resp = analytics.get_range_analytics_summary(crn=crn, zone_identifier=zone_id)\n", " print(resp)\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/range/analytics/events/bytime": { "get": { "tags": [ "Range Analytics" ], "summary": "Get range analytics by time", "operationId": "get_range_analytics_by_time", "description": "Retrieves a list of aggregate metrics grouped by time interval.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "in": "query", "name": "metrics", "description": "One or more metrics to compute.", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "count", "bytesIngress", "bytesEgress", "durationAvg", "durationMedian", "duration90th", "duration99th" ] } } }, { "in": "query", "name": "dimensions", "description": "Used to break down the data by given attributes.", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "event", "appID", "coloName", "ipVersion" ] } } }, { "in": "query", "name": "filters", "description": "Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Comparison options are:", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "sort", "description": "The sort order for the result set; sort fields must be included in metrics or dimensions.", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "in": "query", "name": "since", "description": "The start of the time interval to query, which defaults to `until - 6 hours`.", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "until", "description": "The end of the time interval to query, which defaults to the current time.", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "time_delta", "description": "Used to select time series resolution.", "schema": { "type": "string", "enum": [ "year", "quarter", "month", "week", "day", "hour", "dekaminute", "minute" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/analytics_by_time_response" }, "examples": { "response": { "value": { "success": true, "errors": [], "messages": [], "result": { "rows": 2, "data": [ { "metrics": [ [ 1, 2 ], [ 3, 1 ] ] } ], "totals": { "count": 4, "bytesIngress": 3 }, "min": { "count": 1, "bytesIngress": 1 }, "max": { "count": 3, "bytesIngress": 2 }, "data_lag": 60, "time_intervals": [ [ "2018-10-01T12:31:00.000Z", "2018-10-01T12:31:59.000Z" ], [ "2018-10-01T12:39:00.000Z", "2018-10-01T12:39:59.000Z" ] ], "query": { "metrics": [ "count", "bytesIngress" ], "dimensions": [ "event", "appID" ], "filters": "event==connect AND coloName!=SFO", "sort": [ { "Id": "count", "Desc": false }, { "Id": "bytesIngress", "Desc": true } ], "since": "2014-01-02T02:20:00.000Z", "until": "2014-01-02T03:20:00.000Z", "time_delta": "minute", "limit": 10000 } } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \"https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/range/analytics/events/bytime?metrics=count,bytesIngress&dimensions=event,appID&filters=event==connect AND coloName!=SFO&sort=+count,-bytesIngress&since=2014-01-02T02:20:00Z&until=2014-01-02T03:20:00Z&time_delta=minute\" \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ], "python": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "import os\n", "from dotenv import load_dotenv\n", "from cis_services import RangeAnalyticsByTimeV1\n", "\n", "\n", "def main():\n", " load_dotenv()\n", " # read crn and zone id from environment\n", " crn = os.getenv(\"CRN\")\n", " zone_id = os.getenv(\"ZONE_ID\")\n", " # create instance\n", " analytics = RangeAnalyticsByTimeV1.new_instance(service_name=\"cis_services\")\n", " resp = analytics.get_range_analytics_by_time(crn=crn, zone_identifier=zone_id)\n", " print(resp)\n", "\n", "\n", "if __name__ == \"__main__\":\n", " main()\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_id}/logpush/edge/jobs": { "get": { "tags": [ "Instant Logs" ], "summary": "List instant logs jobs", "operationId": "get_instant_logs", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.read" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.instant-logs-jobs.read" } ] }, "description": "List all currently active instant logs jobs.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_instant_logs_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/zones/$ZONE_ID/logpush/edge/jobs \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx'\n" ] } ] } ] } } }, "post": { "tags": [ "Instant Logs" ], "summary": "Create an instant logs job", "operationId": "create_instant_logs", "x-ibm-permissions": { "actions": [ { "name": "internet-svcs.zones.manage" } ] }, "x-ibm-events": { "events": [ { "name": "internet-svcs.instant-logs-jobs.create" } ] }, "description": "Create an instant logs job.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/instant_logs_create" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/instant_logs_create_resp" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/zones/$ZONE_ID/logpush/edge/jobs \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx'\\\n", " -d '{\"fields\":\"ClientIP,ClientRequestHost,ClientRequestMethod,ClientRequestURI,EdgeEndTimestamp,EdgeResponseBytes,EdgeResponseStatus,EdgeStartTimestamp,RayID\",\"filter\":\"{\\\"where\\\":{\\\"and\\\":[{\\\"key\\\":\\\"ClientCountry\\\",\\\"operator\\\":\\\"neq\\\",\\\"value\\\":\\\"ca\\\"}]}}\",\"sample\":1,\"kind\":\"instant-logs\"}'\n" ] } ] } ] } } } }, "/v1/{crn}/rules/managed_lists": { "get": { "tags": [ "Lists" ], "summary": "List Managed Lists", "operationId": "get_managed_lists", "description": "List available managed lists for your instance.", "parameters": [ { "$ref": "#/components/parameters/crn" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/managed_lists_resp" }, "examples": { "response": { "value": { "result": [ { "name": "cf.malware", "description": "IP addresses of known sources of malware", "kind": "ip" } ], "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rules/managed_lists \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v1/{crn}/rules/lists": { "get": { "tags": [ "Lists" ], "summary": "List Custom Lists", "operationId": "get_custom_lists", "description": "List the custom lists for your instance.", "parameters": [ { "$ref": "#/components/parameters/crn" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_lists_resp" }, "examples": { "response": { "value": { "result": [ { "name": "good_ips", "id": "99175b38bf274d1cb6a2cb502e1b2c71", "kind": "ip", "num_items": 12, "num_referencing_filters": 5 } ], "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rules/lists \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx'\n" ] } ] } ] } } }, "post": { "tags": [ "Lists" ], "summary": "Create Custom List", "operationId": "create_custom_lists", "description": "Create a custom list for your instance.", "parameters": [ { "$ref": "#/components/parameters/crn" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_custom_list_req" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_list_resp" }, "examples": { "response": { "value": { "result": { "name": "good_ips", "id": "99175b38bf274d1cb6a2cb502e1b2c71", "kind": "ip", "num_items": 12, "num_referencing_filters": 5 }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rules/lists \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx' \\\n", " -d '{\"kind\":\"ip\",\"name\":\"good_ips\"}'\n" ] } ] } ] } } } }, "/v1/{crn}/rules/lists/{list_id}": { "get": { "tags": [ "Lists" ], "summary": "Get Custom List", "operationId": "get_custom_list", "description": "Get a custom list for your instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/list_id" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_list_resp" }, "examples": { "response": { "value": { "result": [ { "name": "good_ips", "id": "99175b38bf274d1cb6a2cb502e1b2c71", "kind": "ip", "num_items": 12, "num_referencing_filters": 5 } ], "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rules/lists/$LIST_ID \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx'\n" ] } ] } ] } } }, "put": { "tags": [ "Lists" ], "summary": "Update Custom List", "operationId": "update_custom_list", "description": "Update the description of a custom list.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/list_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_custom_list_req" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_list_resp" }, "examples": { "response": { "value": { "result": { "name": "good_ips", "id": "99175b38bf274d1cb6a2cb502e1b2c71", "kind": "ip", "num_items": 12, "num_referencing_filters": 5 }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rules/lists/$LIST_ID \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx' \\\n", " -d '{\"description\":\"My list of known malicious IPs\"}'\n" ] } ] } ] } } }, "delete": { "tags": [ "Lists" ], "summary": "Delete Custom List", "operationId": "delete_custom_list", "description": "Delete a custom list for your instance.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/list_id" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/delete_resource_resp" }, "examples": { "response": { "value": { "result": { "id": "99175b38bf274d1cb6a2cb502e1b2c71" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rules/lists/$LIST_ID \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v1/{crn}/rules/lists/{list_id}/items": { "get": { "tags": [ "Lists" ], "summary": "Get List Items", "operationId": "get_list_items", "description": "Get the list items for a custom list.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/list_id" }, { "name": "cursor", "in": "query", "description": "The pagination cursor. An opaque string token indicating the position from which to continue when requesting the next/previous set of records. Cursor values are provided under result_info.cursors in the response.", "required": false, "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "description": "Amount of results to include in each paginated response. A non-negative 32 bit integer. Minimum 1, maximum 500.", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 500 } }, { "name": "search", "in": "query", "description": "A search query to filter returned items. Its meaning depends on the list type: IP addresses must start with the provided string, hostnames and bulk redirects must contain the string, and ASNs must match the string exactly.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_items_resp" }, "examples": { "response": { "value": { "result": [ { "id": "70c2009751b24ffc9ed1ab462ba957b4", "ip": "172.64.0.0/13", "comment": "A nice IP address.", "created_on": "2025-03-21T16:19:21Z", "modified_on": "2025-03-21T16:19:21Z" } ], "success": true, "errors": [], "messages": [], "result_info": { "cursors": { "after": "yyy", "before": "xxx" } } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rules/lists/$LIST_ID/items \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx'\n" ] } ] } ] } } }, "post": { "tags": [ "Lists" ], "summary": "Create List Items", "operationId": "create_list_items", "description": "Create list items for your custom list. This operation is asynchronous. To get current the operation status, use the get operation status API.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/list_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_list_items_req" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_operation_resp" }, "examples": { "response": { "value": { "result": { "operation_id": "53d73a83d33d4e3b8791764a9b9f2412" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rules/lists/$LIST_ID/items \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx' \\\n", " -d '[{\"ip\":\"129.35.0.0\",\"comment\":\"IBM-AUSTIN1\"},{\"ip\":\"26.9.0.216\",\"comment\":\"NCPDS-BERMUDA\"}]'\n" ] } ] } ] } } }, "delete": { "tags": [ "Lists" ], "summary": "Delete List Items", "operationId": "delete_list_items", "description": "Remove one or more list items from your custom list. This operation is asynchronous. To get current the operation status, use the get operation status API.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/list_id" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_operation_resp" }, "examples": { "response": { "value": { "result": { "operation_id": "53d73a83d33d4e3b8791764a9b9f2412" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rules/lists/$LIST_ID/items \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx' \\\n", " -d '{\"items\":[{\"id\":\"70c2009751b24ffc9ed1ab462ba957b4\"}]}'\n" ] } ] } ] } } }, "put": { "tags": [ "Lists" ], "summary": "Update All List Items", "operationId": "update_list_items", "description": "Update all list items for your custom list. This removes existing items from the list. This operation is asynchronous. To get current the operation status, use the get operation status API.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/list_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_list_items_req" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_operation_resp" }, "examples": { "response": { "value": { "result": { "operation_id": "53d73a83d33d4e3b8791764a9b9f2412" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rules/lists/$LIST_ID/items \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx' \\\n", " -d '[{\"ip\":\"129.35.0.0\",\"comment\":\"IBM-AUSTIN1\"},{\"ip\":\"26.9.0.216\",\"comment\":\"NCPDS-BERMUDA\"}]'\n" ] } ] } ] } } } }, "/v1/{crn}/rules/lists/{list_id}/items/{item_id}": { "get": { "tags": [ "Lists" ], "summary": "Get List Item", "operationId": "get_list_item", "description": "Get a specific list item.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/list_id" }, { "$ref": "#/components/parameters/item_id" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_item_resp" }, "examples": { "response": { "value": { "result": { "id": "70c2009751b24ffc9ed1ab462ba957b4", "ip": "172.64.0.0/13", "comment": "A nice IP address.", "created_on": "2025-03-21T16:19:21Z", "modified_on": "2025-03-21T16:19:21Z" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rules/lists/$LIST_ID/items/$ITEM_ID \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v1/{crn}/rules/lists/bulk_operations/{operation_id}": { "get": { "tags": [ "Lists" ], "summary": "Get List Operation Status", "operationId": "get_operation_status", "description": "Get the operation status for a custom list operation.", "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/operation_id" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/operation_status_resp" }, "examples": { "response": { "value": { "result": { "id": "0147be950d5c42b8b47c07792c5015e3", "status": "completed", "completed": "2025-03-21T16:07:41.782564Z" }, "success": true, "errors": [], "messages": [] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/$CRN/rules/lists/bulk_operations/$OPERATION_ID \\\n", " -H 'Content-Type: application/json' \\\n", " -H 'Accept: application/json' \\\n", " -H 'X-Auth-User-Token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/origin_tls_client_auth/settings": { "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "$ref": "#/components/parameters/X-Correlation-ID" } ], "get": { "tags": [ "Zone-Level Authenticated Origin Pull" ], "summary": "Get Zone level Authenticated Origin Pull Settings.", "operationId": "get_zone_origin_pull_settings", "description": "Get whether zone-level authenticated origin pulls is enabled or not. It is false by default.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_zone_origin_pull_settings_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/origin_tls_client_auth/settings \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "put": { "tags": [ "Zone-Level Authenticated Origin Pull" ], "summary": "Set Zone level Authenticated Origin Pull Settings.", "operationId": "set_zone_origin_pull_settings", "description": "Enable or disable zone-level authenticated origin pulls. 'enabled' should be set true either before/after the certificate is uploaded to see the certificate in use.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_origin_pull_settings_req" } } }, "description": "enable or disable zone-level authenticated origin pulls." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_zone_origin_pull_settings_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/origin_tls_client_auth/settings \\\n", " -H 'content-type: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx' \\\n", " --data '{\"enabled\":true}'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/origin_tls_client_auth": { "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "$ref": "#/components/parameters/X-Correlation-ID" } ], "get": { "tags": [ "Zone-Level Authenticated Origin Pull" ], "summary": "List Zone level Authenticated Origin Pull Certificates.", "operationId": "list_zone_origin_pull_certificates", "description": "List zone-level authenticated origin pulls certificates.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_zone_origin_pull_certificates_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/origin_tls_client_auth \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "post": { "tags": [ "Zone-Level Authenticated Origin Pull" ], "summary": "Upload Zone level Authenticated Origin Pull Certificate.", "operationId": "upload_zone_origin_pull_certificate", "description": "Upload your own certificate you want Cloudflare to use for edge-to-origin communication to override the shared certificate Please note that it is important to keep only one certificate active. Also, make sure to enable zone-level authenticated origin pulls by making a PUT call to settings endpoint to see the uploaded certificate in use.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/origin_pull_cert_req" } } }, "description": "upload a custom certificate." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_origin_pull_certificate_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/origin_tls_client_auth \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "--data '{\"certificate\":\"-----BEGIN CERTIFICATE-----\n......\n-----END CERTIFICATE-----\n\",\"private_key\":\"-----BEGIN RSA PRIVATE KEY-----\n......\n-----END RSA PRIVATE KEY-----\n\"}'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/origin_tls_client_auth/{cert_identifier}": { "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "$ref": "#/components/parameters/cert_identifier" }, { "$ref": "#/components/parameters/X-Correlation-ID" } ], "get": { "tags": [ "Zone-Level Authenticated Origin Pull" ], "summary": "Get a Zone level Authenticated Origin Pull Certificate.", "operationId": "get_zone_origin_pull_certificate", "description": "Get a zone-level authenticated origin pulls certificate.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_origin_pull_certificate_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/origin_tls_client_auth/:cert_id \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "delete": { "tags": [ "Zone-Level Authenticated Origin Pull" ], "summary": "Delete a Zone level Authenticated Origin Pull Certificate.", "operationId": "delete_zone_origin_pull_certificate", "description": "Delete a zone-level authenticated origin pulls certificate.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_origin_pull_certificate_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/origin_tls_client_auth/:cert_id \\\n", "-H 'content-type: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/origin_tls_client_auth/hostnames": { "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "$ref": "#/components/parameters/X-Correlation-ID" } ], "get": { "tags": [ "Per-hostname Authenticated Origin Pull" ], "summary": "List Per-hostname Authenticated Origin Pull Settings.", "operationId": "list_all_per_hostname_authenticated_origin_pull_settings", "description": "List all per hostname authenticated origin pull settings.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_hostname_origin_pull_settings_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/origin_tls_client_auth/hostnames \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "put": { "tags": [ "Per-hostname Authenticated Origin Pull" ], "summary": "Set Hostname level Authenticated Origin Pull Settings.", "operationId": "set_hostname_origin_pull_settings", "description": "Associate a hostname to a certificate and enable, disable or invalidate the association. If disabled, client certificate will not be sent to the hostname even if activated at the zone level. 100 maximum associations on a single certificate are allowed", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hostname_origin_pull_settings_req" } } }, "description": "associate a hostname to a certificate and enable, disable or invalidate the association." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_hostname_origin_pull_settings_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/origin_tls_client_auth/hostnames \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n", " --data '{\"config\":[{\"hostname\":\"app.example.com\",\"cert_id\":\"2458ce5a-0c35-4c7f-82c7-8e9487d3ff60\",\"enabled\":true}]}'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/origin_tls_client_auth/hostnames/{hostname}": { "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "$ref": "#/components/parameters/hostname" }, { "$ref": "#/components/parameters/X-Correlation-ID" } ], "get": { "tags": [ "Per-hostname Authenticated Origin Pull" ], "summary": "Get Hostname level Authenticated Origin Pull Settings.", "operationId": "get_hostname_origin_pull_settings", "description": "Get hostname-level authenticated origin pulls settings.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_hostname_origin_pull_settings_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", " https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/origin_tls_client_auth/hostnames/:hostname \\\n", " -H 'content-type: application/json' \\\n", " -H 'accept: application/json' \\\n", " -H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/origin_tls_client_auth/hostnames/certificates": { "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "$ref": "#/components/parameters/X-Correlation-ID" } ], "get": { "tags": [ "Per-hostname Authenticated Origin Pull" ], "summary": "List Per-hostname Authenticated Origin Pull certificates.", "operationId": "list_all_per_hostname_authenticated_origin_pull_certificates", "description": "List all per hostname authenticated origin pull certificates.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_hostname_origin_pull_certificates_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/origin_tls_client_auth/hostnames/certificates \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "post": { "tags": [ "Per-hostname Authenticated Origin Pull" ], "summary": "Upload Hostname level Authenticated Origin Pull Certificate.", "operationId": "upload_hostname_origin_pull_certificate", "description": "Upload a certificate to be used for client authentication on a hostname. 10 hostname certificates per zone are allowed.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/origin_pull_cert_req" } } }, "description": "upload a custom certificate." }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hostname_origin_pull_certificate_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/origin_tls_client_auth/hostnames/certificates \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n", "--data '{\"certificate\":\"-----BEGIN CERTIFICATE-----\n......\n-----END CERTIFICATE-----\n\",\"private_key\":\"-----BEGIN RSA PRIVATE KEY-----\n......\n-----END RSA PRIVATE KEY-----\n\"}'\n" ] } ] } ] } } } }, "/v1/{crn}/zones/{zone_identifier}/origin_tls_client_auth/hostnames/certificates/{cert_identifier}": { "parameters": [ { "$ref": "#/components/parameters/crn" }, { "$ref": "#/components/parameters/zone_identifier" }, { "$ref": "#/components/parameters/cert_identifier" }, { "$ref": "#/components/parameters/X-Correlation-ID" } ], "get": { "tags": [ "Per-hostname Authenticated Origin Pull" ], "summary": "Get a Hostname level Authenticated Origin Pull Certificate.", "operationId": "get_hostname_origin_pull_certificate", "description": "Get the certificate by ID to be used for client authentication on a hostname.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hostname_origin_pull_certificate_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/origin_tls_client_auth/hostnames/certificates/:cert_id \\\n", "-H 'content-type: application/json' \\\n", "-H 'accept: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } }, "delete": { "tags": [ "Per-hostname Authenticated Origin Pull" ], "summary": "Delete a Hostname level Authenticated Origin Pull Certificate.", "operationId": "delete_hostname_origin_pull_certificate", "description": "Delete the certificate by ID to be used for client authentication on a hostname.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hostname_origin_pull_certificate_resp" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden! User has no privilege" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE \\\n", "https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/origin_tls_client_auth/hostnames/certificates/:cert_id \\\n", "-H 'content-type: application/json' \\\n", "-H 'x-auth-user-token: Bearer xxxxxx'\n" ] } ] } ] } } } } }, "components": { "securitySchemes": { "iamToken": { "type": "oauth2", "description": "This API uses OAuth 2 with the implicit grant flow.", "flows": { "implicit": { "authorizationUrl": "https://iam.bluemix.net/identity/authorize", "scopes": {} } } } }, "parameters": { "crn": { "description": "Full URL-encoded cloud resource name of the service instance", "in": "path", "name": "crn", "x-sdk-global-param": true, "required": true, "schema": { "type": "string" } }, "zone_identifier": { "description": "Zone identifier", "name": "zone_identifier", "in": "path", "x-sdk-global-param": true, "required": true, "schema": { "type": "string" } }, "zone_id": { "description": "Zone identifier", "name": "zone_id", "in": "path", "x-sdk-global-param": true, "required": true, "schema": { "type": "string" } }, "dnsrecord_identifier": { "description": "Zone identifier", "name": "dnsrecord_identifier", "in": "path", "x-sdk-global-param": true, "required": true, "schema": { "type": "string" } }, "rate_limit_identifier": { "description": "Rate limit rule identifier", "name": "rate_limit_identifier", "in": "path", "x-sdk-global-param": true, "required": true, "schema": { "type": "string" } }, "cert_identifier": { "description": "Certificate identifier", "name": "cert_identifier", "in": "path", "x-sdk-global-param": true, "required": true, "schema": { "type": "string" } }, "custom_cert_id": { "description": "Custom certificate ID", "name": "custom_cert_id", "in": "path", "x-sdk-global-param": true, "required": true, "schema": { "type": "string" } }, "route_id": { "description": "Trigger identifier", "name": "route_id", "in": "path", "required": true, "schema": { "type": "string" } }, "script_name": { "description": "The edge function action name", "name": "script_name", "in": "path", "required": true, "schema": { "type": "string" } }, "monitor_identifier": { "description": "Identifier of the GLB monitor", "name": "monitor_identifier", "in": "path", "x-sdk-global-param": true, "required": true, "schema": { "type": "string" } }, "pool_identifier": { "description": "Identifier of the GLB pool", "name": "pool_identifier", "in": "path", "x-sdk-global-param": true, "required": true, "schema": { "type": "string" } }, "load_balancer_identifier": { "description": "Identifier of the load balancer", "name": "load_balancer_identifier", "in": "path", "x-sdk-global-param": true, "required": true, "schema": { "type": "string" } }, "lockdown_rule_identifier": { "description": "Identifier of the lockdown rule", "name": "lockdown_rule_identifier", "in": "path", "x-sdk-global-param": true, "required": true, "schema": { "type": "string" } }, "useragent_rule_identifier": { "description": "Identifier of the user-agent rule", "name": "useragent_rule_identifier", "in": "path", "x-sdk-global-param": true, "required": true, "schema": { "type": "string" } }, "app_identifier": { "description": "Identifier of range app", "name": "app_identifier", "in": "path", "x-sdk-global-param": true, "required": true, "schema": { "type": "string" } }, "app_id": { "in": "path", "name": "app_id", "x-sdk-global-param": true, "required": true, "schema": { "type": "string" }, "description": "Access application ID" }, "cert_id": { "in": "path", "name": "cert_id", "x-sdk-global-param": true, "required": true, "schema": { "type": "string" }, "description": "Access certificate ID" }, "policy_id": { "in": "path", "name": "policy_id", "x-sdk-global-param": true, "required": true, "schema": { "type": "string" } }, "package_id": { "description": "Identifier of WAF package", "name": "package_id", "in": "path", "x-sdk-global-param": true, "required": true, "schema": { "type": "string" } }, "pkg_id": { "description": "Identifier of WAF package", "name": "pkg_id", "in": "path", "x-sdk-global-param": true, "required": true, "schema": { "type": "string" } }, "group_id": { "description": "Identifier of WAF group", "name": "group_id", "in": "path", "x-sdk-global-param": true, "required": true, "schema": { "type": "string" } }, "identifier": { "description": "Identifier of rule", "name": "identifier", "in": "path", "x-sdk-global-param": true, "required": true, "schema": { "type": "string" } }, "page_identifier": { "description": "Identifier of the custom error page", "name": "page_identifier", "in": "path", "x-sdk-global-param": true, "required": true, "schema": { "type": "string" } }, "accessrule_identifier": { "description": "Identifier of the firewall access rule", "name": "accessrule_identifier", "in": "path", "x-sdk-global-param": true, "required": true, "schema": { "type": "string" } }, "primary_id": { "description": "Identifier of the primary dns server", "name": "primary_id", "in": "path", "x-sdk-global-param": true, "required": true, "schema": { "type": "string" } }, "tsig_id": { "description": "Identifier of the TSIG key", "name": "tsig_id", "in": "path", "x-sdk-global-param": true, "required": true, "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Uniquely identifying a request", "name": "X-Correlation-ID", "in": "header", "required": false, "schema": { "type": "string" } }, "ruleset_id": { "in": "path", "name": "ruleset_id", "description": "ID of a specific ruleset", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, "ruleset_version": { "in": "path", "name": "ruleset_version", "description": "The version of the ruleset", "required": true, "schema": { "type": "string", "example": 1, "pattern": "^[0-9]+$" } }, "ruleset_phase": { "in": "path", "name": "ruleset_phase", "description": "The phase of the ruleset", "required": true, "schema": { "$ref": "#/components/schemas/ruleset_phase" } }, "rule_id": { "in": "path", "name": "rule_id", "description": "ID of a specific rule", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, "rule_tag": { "in": "path", "name": "rule_tag", "description": "A category of the rule", "required": true, "schema": { "type": "string" } }, "list_id": { "in": "path", "name": "list_id", "x-sdk-global-param": true, "description": "List identifier", "required": true, "schema": { "type": "string" } }, "item_id": { "in": "path", "name": "item_id", "x-sdk-global-param": true, "description": "List item identifier", "required": true, "schema": { "type": "string" } }, "operation_id": { "in": "path", "name": "operation_id", "x-sdk-global-param": true, "description": "List operation identifier", "required": true, "schema": { "type": "string" } }, "hostname": { "description": "the hostname on the origin for which the client certificate associate", "name": "hostname", "in": "path", "required": true, "schema": { "type": "string" } } }, "schemas": { "result_info": { "type": "object", "description": "Result information", "required": [ "page", "per_page", "count", "total_count" ], "properties": { "page": { "type": "integer", "description": "Page", "format": "int32", "example": 1 }, "per_page": { "type": "integer", "description": "Per page", "format": "int32", "example": 20 }, "count": { "type": "integer", "description": "Count", "format": "int32", "example": 1 }, "total_count": { "type": "integer", "description": "Total count", "format": "int32", "example": 2000 } } }, "success": { "description": "Was operation successful", "type": "boolean", "example": true }, "errors": { "type": "array", "description": "Errors", "items": { "type": "object", "items": { "type": "string" } } }, "messages": { "type": "array", "description": "Messages", "items": { "type": "object", "items": { "type": "string" } } }, "smart_routing_resp": { "type": "object", "description": "Smart routing response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "smart_routing" }, "value": { "description": "Value", "type": "string", "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2017-01-01T05:20:00.123Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "bot_score_resp": { "type": "object", "description": "Bot Score Source Response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "array", "items": { "type": "object", "properties": { "botScore": { "type": "array", "items": { "type": "object", "properties": { "avg": { "type": "object", "properties": { "sampleInterval": { "type": "number" } } }, "count": { "type": "number" }, "dimensions": { "type": "object", "properties": { "botScoreSrcName": { "type": "string" } } } } } } } } } } }, "bot_timeseries_resp": { "type": "object", "description": "Bot Timeseries Response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "array", "items": { "type": "object", "properties": { "botScore": { "type": "array", "items": { "type": "object" } } } } } } }, "bot_topns_resp": { "type": "object", "description": "Bot top attributes response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "array", "items": { "type": "object" } } } }, "bot_mgt_resp": { "type": "object", "description": "Bot Management Response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "description": "Was operation successful", "type": "boolean", "example": true }, "errors": { "description": "Array of errors encountered", "type": "array", "items": { "type": "object", "items": { "type": "string" } } }, "messages": { "description": "Array of messages returned", "type": "array", "items": { "type": "object", "items": { "type": "string" } } }, "result": { "$ref": "#/components/schemas/bot_mgt_settings" } } }, "bot_mgt_settings": { "type": "object", "description": "Bot Management settings", "properties": { "session_score": { "type": "boolean", "description": "Set to disable tracking the max bot score during a session using the Bot Management cookie.", "example": false }, "enable_js": { "type": "boolean", "description": "Use JavaScript detections to improve bot detection.", "example": false }, "use_latest_model": { "type": "boolean", "description": "Automatically update to the newest bot detection models as they are released.", "example": false }, "ai_bots_protection": { "type": "string", "description": "Block scrapers and crawlers known to be feeding AI training data.", "enum": [ "block", "disabled" ] } } }, "zone_hold_resp": { "type": "object", "description": "Zone Hold Response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "array", "items": { "type": "object", "properties": { "hold": { "type": "boolean", "example": true }, "hold_after": { "type": "string", "example": "2023-01-31T15:56:36.000Z" }, "include_subdomains": { "type": "boolean", "example": false } } } } } }, "zone_hold_delete_resp": { "type": "object", "description": "Zone Hold Response", "required": [ "result" ], "properties": { "result": { "description": "Container for response information", "type": "array", "items": { "type": "object", "properties": { "hold": { "type": "boolean", "example": false }, "hold_after": { "type": "string", "example": "2023-01-31T15:56:36.000Z" }, "include_subdomains": { "type": "boolean", "example": false } } } } } }, "zone_hold_list_resp": { "type": "object", "description": "Zone Hold Response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "array", "items": { "type": "object", "properties": { "hold": { "type": "boolean", "example": true }, "hold_after": { "type": "string", "example": "2023-01-31T15:56:36.000Z" }, "include_subdomains": { "type": "boolean", "example": false } } } } } }, "routing_tiered_caching_resp": { "type": "object", "description": "Tiered routing cache response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "tiered_caching" }, "value": { "description": "Value", "type": "string", "example": "on" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2017-01-01T05:20:00.123Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "smart_routing_setting": { "type": "object", "description": "Smart routing setting", "required": [ "value" ], "properties": { "value": { "description": "Value", "type": "string", "enum": [ "on", "off" ], "example": "off" } } }, "routing_tiered_caching_setting": { "type": "object", "description": "Routing tiered caching setting", "required": [ "value" ], "properties": { "value": { "description": "Value", "type": "string", "enum": [ "on", "off" ], "example": "on" } } }, "routing_latency_resp": { "type": "object", "description": "Routing latency response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "percent_smart_routed", "bins", "range", "time_range", "data" ], "properties": { "percent_smart_routed": { "description": "Percent smart routed", "type": "number", "format": "float", "example": 63.4 }, "bins": { "description": "The number of bin", "type": "integer", "format": "int32", "example": 10 }, "range": { "description": "Range", "type": "object", "properties": { "min": { "description": "Min time", "type": "integer", "format": "int32", "example": 0 }, "max": { "description": "Max time", "type": "integer", "format": "int32", "example": 1500 } } }, "time_range": { "description": "Time range", "type": "object", "properties": { "min": { "description": "Min time", "type": "string", "format": "date-time", "example": "2017-05-30T00:02:14.000Z" }, "max": { "description": "Max time", "type": "string", "format": "date-time", "example": "2017-05-30T00:14:48.000Z" } } }, "data": { "description": "Date", "type": "object", "properties": { "lable": { "description": "Label", "type": "array", "items": { "type": "string" } }, "counts": { "description": "Counts", "type": "array", "items": { "type": "integer", "format": "int32" } }, "averages": { "description": "Averages", "type": "array", "items": { "type": "integer", "format": "int32" } } } } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "routing_latency_colos_resp": { "type": "object", "description": "Routing latency colos response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "type", "features" ], "properties": { "type": { "description": "Type", "type": "string", "example": "FeatureCollection" }, "features": { "description": "Features", "type": "array", "items": { "type": "object", "properties": { "code": { "description": "Code", "type": "string", "example": "EWR" }, "smart_routing_req_count": { "description": "Routing request count", "type": "integer", "format": "int32", "example": 6696990 }, "pct_avg_change": { "description": "PCT avg change", "type": "number", "format": "double", "example": 0.06003951841343536 }, "no_smart_routing_avg": { "description": "No smart routing avg", "type": "number", "format": "double", "example": 651.7771493198342 }, "smart_routing_avg": { "description": "No smart routing avg", "type": "number", "format": "double", "example": 690.9095354778789 }, "geometry": { "description": "Geometry", "type": "object", "properties": { "coordinates": { "description": "Coordinates", "type": "array", "items": { "type": "number", "format": "float" } }, "type": { "description": "Type", "type": "string", "example": "Point" } } } } } } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "zones_dnssec_resp": { "type": "object", "description": "Zones DNS Sec Response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "object", "properties": { "status": { "description": "Status", "type": "string", "example": "active", "enum": [ "active", "disabled", "pending", "pending-disabled", "error" ] }, "flags": { "description": "Flags", "type": "integer", "example": 257 }, "algorithm": { "description": "Algorithm", "type": "string", "example": "13" }, "key_type": { "description": "Key type", "type": "string", "example": "ECDSAP256SHA256" }, "digest_type": { "description": "Digest type", "type": "string", "example": "2" }, "digest_algorithm": { "description": "Digest algorithm", "type": "string", "example": "SHA256" }, "digest": { "description": "Digest", "type": "string", "example": "48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45" }, "ds": { "description": "DS", "type": "string", "example": "example.com. 3600 IN DS 16953 13 2 248E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45" }, "key_tag": { "description": "Key tag", "type": "integer", "example": 42 }, "public_key": { "description": "Public key", "type": "string", "example": "oXiGYrSTO+LSCJ3mohc8EP+CzF9KxBj8/ydXJ22pKuZP3VAC3/Md/k7xZfz470CoRyZJ6gV6vml07IC3d8xqhA==" } } } } }, "dnssec_input": { "type": "object", "description": "DNS sec input", "required": [ "status" ], "properties": { "status": { "description": "Status", "type": "string", "enum": [ "active", "disabled" ], "example": "active" } } }, "cname_flattening_response": { "type": "object", "description": "CNAME Flattening response", "properties": { "id": { "type": "string", "description": "ID", "example": "cname_flattening" }, "value": { "type": "string", "description": "Value", "enum": [ "flatten_all", "flatten_at_root" ], "example": "flatten_all" }, "modified_on": { "type": "string", "description": "Date when it is modified", "format": "date-time", "example": "2014-01-01T05:20:00.123Z" }, "editable": { "type": "boolean", "description": "Editable", "example": true } } }, "zones_cname_flattening_resp": { "type": "object", "description": "Zones CNAME flattening response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/cname_flattening_response" } } }, "cname_flattening_input": { "type": "object", "description": "CNAME Flattening input", "required": [ "value" ], "properties": { "value": { "description": "Valid values are \"flatten_at_root\", \"flatten_all\". \"flatten_at_root\" - Flatten CNAME at root domain. This is the default value. \"flatten_all\" - Flatten all CNAME records under your domain.", "type": "string", "enum": [ "flatten_at_root", "flatten_all" ], "example": "flatten_all" } } }, "opportunistic_encryption_resp": { "type": "object", "description": "Opportunistic encryption response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "opportunistic_encryption" }, "value": { "description": "Value", "type": "string", "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2017-01-01T05:20:00.123Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "opportunistic_encryption_setting": { "type": "object", "description": "Opportunistic encryption setting", "required": [ "value" ], "properties": { "value": { "description": "Value", "type": "string", "enum": [ "on", "off" ], "example": "off" } } }, "opportunistic_onion_resp": { "type": "object", "description": "Opportunistic onion response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "opportunistic_onion" }, "value": { "description": "Value", "type": "string", "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2017-01-01T05:20:00.123Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "replace_insecure_js": { "type": "object", "description": "Replace insecure Javascript setting", "required": [ "value" ], "properties": { "value": { "description": "Value", "type": "string", "enum": [ "on", "off" ], "example": "off" } } }, "replace_insecure_js_resp": { "type": "object", "description": "Replace insecure Javascript response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable" ], "properties": { "id": { "description": "ID", "type": "string", "example": "replace_insecure_js" }, "value": { "description": "Value", "type": "string", "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "nullable": true, "example": "2017-01-01T05:20:00.123Z" } } }, "result_info": { "description": "Result information", "type": "object" }, "success": { "description": "Was the get successful", "type": "boolean", "example": true }, "errors": { "description": "Array of errors encountered", "type": "array", "items": { "type": "object", "items": { "type": "string" } } }, "messages": { "description": "Array of messages returned", "type": "array", "items": { "type": "object", "items": { "type": "string" } } } } }, "email_obfuscation": { "type": "object", "description": "email address obfuscation setting", "required": [ "value" ], "properties": { "value": { "description": "Value", "type": "string", "enum": [ "on", "off" ], "example": "off" } } }, "email_obfuscation_resp": { "type": "object", "description": "email address obfuscation response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable" ], "properties": { "id": { "description": "ID", "type": "string", "example": "email_obfuscation" }, "value": { "description": "Value", "type": "string", "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "nullable": true, "example": "2017-01-01T05:20:00.123Z" } } }, "result_info": { "description": "Result information", "type": "object" }, "success": { "description": "Was the get successful", "type": "boolean", "example": true }, "errors": { "description": "Array of errors encountered", "type": "array", "items": { "type": "object", "items": { "type": "string" } } }, "messages": { "description": "Array of messages returned", "type": "array", "items": { "type": "object", "items": { "type": "string" } } } } }, "opportunistic_onion_setting": { "type": "object", "description": "Opportunistic onion setting", "required": [ "value" ], "properties": { "value": { "description": "Value", "type": "string", "enum": [ "on", "off" ], "example": "off" } } }, "challenge_ttl_resp": { "type": "object", "description": "Challenge TTL response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "challenge_ttl" }, "value": { "description": "Value", "type": "integer", "example": 1800 }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-09-17T07:21:39.844Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "challenge_ttl_setting": { "type": "object", "description": "Challenge TTL setting", "required": [ "value" ], "properties": { "value": { "description": "Value", "type": "integer", "enum": [ 300, 900, 1800, 2700, 3600, 7200, 10800, 14400, 28800, 57600, 86400, 604800, 2592000, 31536000 ], "example": 1800 } } }, "automatic_https_rewrites_resp": { "type": "object", "description": "Automatic https rewrite response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "automatic_https_rewrites" }, "value": { "description": "Value", "type": "string", "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-09-14T09:49:19.524Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "automatic_https_rewrites_setting": { "type": "object", "description": "Automatic https rewrite setting", "required": [ "value" ], "properties": { "value": { "description": "Value", "type": "string", "enum": [ "on", "off" ], "example": "off" } } }, "true_client_ip_resp": { "type": "object", "description": "True client IP response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "true_client_ip_header" }, "value": { "description": "Value", "type": "string", "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-09-14T09:49:19.524Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "zone_property_on_off_setting": { "type": "object", "description": "Zone property on/off setting", "required": [ "value" ], "properties": { "value": { "description": "Value", "type": "string", "enum": [ "on", "off" ], "example": "on" } } }, "image_size_optimization_setting": { "type": "object", "description": "Image size optimization", "required": [ "value" ], "properties": { "value": { "description": "Valid values are \"lossy\", \"off\", \"lossless\". \"lossy\" - The file size of JPEG images is reduced using lossy compression, which might reduce visual quality. \"off\" - Disable Image Size Optimization. \"lossless\" - Reduce the size of image files without impacting visual quality.", "type": "string", "enum": [ "off", "lossless", "lossy" ], "example": "lossless" } } }, "minify_setting": { "type": "object", "description": "Minify setting", "required": [ "value" ], "properties": { "value": { "description": "Value", "type": "object", "required": [ "css", "html", "js" ], "properties": { "css": { "description": "Automatically minify all CSS for your website.", "type": "string", "enum": [ "on", "off" ], "example": "off" }, "html": { "description": "Automatically minify all HTML for your website.", "type": "string", "enum": [ "on", "off" ], "example": "off" }, "js": { "description": "Automatically minify all JavaScript for your website.", "type": "string", "enum": [ "on", "off" ], "example": "off" } } } } }, "min_tls_version_setting": { "type": "object", "description": "Mininum TLS Version setting", "required": [ "value" ], "properties": { "value": { "description": "Value", "type": "string", "enum": [ "1.0", "1.1", "1.2", "1.3" ], "example": "1.2" } } }, "security_header_setting": { "type": "object", "description": "Security Header setting", "required": [ "value" ], "properties": { "value": { "description": "Value", "type": "object", "required": [ "strict_transport_security" ], "properties": { "strict_transport_security": { "description": "Strict transport security", "type": "object", "required": [ "enabled", "max_age", "include_subdomains", "nosniff", "preload" ], "properties": { "enabled": { "description": "Whether or not security header is enabled", "type": "boolean", "example": true }, "max_age": { "description": "Max age in seconds", "type": "integer", "example": 86400 }, "include_subdomains": { "description": "Include all subdomains", "type": "boolean", "example": true }, "nosniff": { "description": "Whether or not to include 'X-Content-Type-Options:nosniff' header", "type": "boolean", "example": true }, "preload": { "description": "Whether or not to permit browsers to preload security_header config", "type": "boolean", "example": true } } } } } } }, "mobile_redirec_setting": { "type": "object", "description": "Mobile Redirect Setting", "required": [ "value" ], "properties": { "value": { "description": "Value", "type": "object", "required": [ "status", "mobile_subdomain", "strip_uri" ], "properties": { "status": { "description": "Whether or not the mobile redirection is enabled", "type": "string", "enum": [ "on", "off" ], "example": "on" }, "mobile_subdomain": { "description": "Which subdomain prefix you wish to redirect visitors on mobile devices to", "type": "string", "example": "m" }, "strip_uri": { "description": "Whether to drop the current page path and redirect to the mobile subdomain URL root or to keep the path and redirect to the same page on the mobile subdomain", "type": "boolean", "example": false } } } } }, "pseudo_ipv4_setting": { "type": "object", "description": "Pseudo IPv4 Setting response", "required": [ "value" ], "properties": { "value": { "description": "Value", "type": "string", "enum": [ "off", "add_header", "overwrite_header" ], "example": "add_header" } } }, "max_upload_setting": { "type": "object", "description": "Maximum Upload setting", "required": [ "value" ], "properties": { "value": { "description": "Valid values(in MB) for \"max_upload\" are 100, 125, 150, 175, 200, 225, 250, 275, 300, 325, 350, 375, 400, 425, 450, 475, 500. Values 225, 250, 275, 300, 325, 350, 375, 400, 425, 450, 475, 500 are only for Enterprise Plan.", "type": "integer", "enum": [ 100, 125, 150, 175, 200, 225, 250, 275, 300, 325, 350, 375, 400, 425, 450, 475, 500 ], "example": 300 } } }, "proxy_read_timeout_setting": { "type": "object", "description": "Proxy read timeout setting", "required": [ "value" ], "properties": { "value": { "description": "Value", "type": "number", "minimum": 1, "maximum": 6000, "example": 600 } } }, "always_use_https_resp": { "type": "object", "description": "Always use http response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "always_use_https" }, "value": { "description": "Value", "type": "string", "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-09-14T09:49:19.524Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "image_size_optimization_resp": { "type": "object", "description": "Image size optimization response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "image_size_optimization" }, "value": { "description": "Value", "type": "string", "example": "lossless" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-09-14T09:49:19.524Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "script_load_optimization_resp": { "type": "object", "description": "Script load optimization response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "script_load_optimization" }, "value": { "description": "Value", "type": "string", "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-09-14T09:49:19.524Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "image_load_optimization_resp": { "type": "object", "description": "Image Load Optimization response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "image_load_optimization" }, "value": { "description": "Value", "type": "string", "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-09-14T09:49:19.524Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "minify_resp": { "type": "object", "description": "Minify response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "minify" }, "value": { "description": "Value", "type": "object", "required": [ "css", "html", "js" ], "properties": { "css": { "description": "CSS", "type": "string", "example": "on" }, "html": { "description": "HTML", "type": "string", "example": "on" }, "js": { "description": "JS", "type": "string", "example": "on" } } }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-09-14T09:49:19.524Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "min_tls_version_resp": { "type": "object", "description": "Minimum TLS Version response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "min_tls_version" }, "value": { "description": "Value", "type": "string", "example": "1.2" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-09-14T09:49:19.524Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "ip_geolocation_resp": { "type": "object", "description": "IP Geolocation response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "ip_geolocation" }, "value": { "description": "Value", "type": "string", "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-09-14T09:49:19.524Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "server_side_exclude_resp": { "type": "object", "description": "Response of server side exclude", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "server_side_exclude" }, "value": { "description": "Value", "type": "string", "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-09-14T09:49:19.524Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "security_header_resp": { "type": "object", "description": "Response of Security Header", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "security_header" }, "value": { "description": "Value", "type": "object", "required": [ "strict_transport_security" ], "properties": { "strict_transport_security": { "description": "Strict transport security", "type": "object", "required": [ "enabled", "max_age", "include_subdomains", "nosniff", "preload" ], "properties": { "enabled": { "description": "Whether or not security header is enabled", "type": "boolean", "example": true }, "max_age": { "description": "Max age in seconds", "type": "integer", "example": 86400 }, "include_subdomains": { "description": "Include all subdomains", "type": "boolean", "example": true }, "nosniff": { "description": "Whether or not to include 'X-Content-Type-Options:nosniff' header", "type": "boolean", "example": true }, "preload": { "description": "Whether or not to permit browsers to preload security_header config", "type": "boolean", "example": true } } } } }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-09-14T09:49:19.524Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "mobile_redirect_resp": { "type": "object", "description": "Mobile Redirect Response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "mobile_redirect" }, "value": { "description": "Value", "type": "object", "required": [ "status", "mobile_subdomain", "strip_uri" ], "properties": { "status": { "description": "Whether or not the mobile redirection is enabled", "type": "string", "example": "on" }, "mobile_subdomain": { "description": "Which subdomain prefix you wish to redirect visitors on mobile devices to", "type": "string", "example": "m" }, "strip_uri": { "description": "Whether to drop the current page path and redirect to the mobile subdomain URL root or to keep the path and redirect to the same page on the mobile subdomain", "type": "boolean", "example": false } } }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-09-14T09:49:19.524Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "prefetch_preload_resp": { "type": "object", "description": "Prefetch & Preload Response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "prefetch_preload" }, "value": { "description": "Value", "type": "string", "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-09-14T09:49:19.524Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "http2_resp": { "type": "object", "description": "HTTP2 Response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "http2" }, "value": { "description": "Value", "type": "string", "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-09-14T09:49:19.524Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "http3_resp": { "type": "object", "description": "HTTP3 Response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "http3" }, "value": { "description": "Value", "type": "string", "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-09-14T09:49:19.524Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "ipv6_resp": { "type": "object", "description": "IPv6 Response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "ipv6" }, "value": { "description": "Value", "type": "string", "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-09-14T09:49:19.524Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "websockets_resp": { "type": "object", "description": "Websocket Response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "websockets" }, "value": { "description": "Value", "type": "string", "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-09-14T09:49:19.524Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "pseudo_ipv4_resp": { "type": "object", "description": "Pseudo ipv4 response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "pseudo_ipv4" }, "value": { "description": "Value", "type": "string", "example": "add_header" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-09-14T09:49:19.524Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "response_buffering_resp": { "type": "object", "description": "Buffering response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "response_buffering" }, "value": { "description": "Value", "type": "string", "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-09-14T09:49:19.524Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "hotlink_protection_resp": { "type": "object", "description": "Hotlink Protection response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "hotlink_protection" }, "value": { "description": "Value", "type": "string", "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-09-14T09:49:19.524Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "max_upload_resp": { "type": "object", "description": "Maximum upload response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "max_upload" }, "value": { "description": "Value", "type": "integer", "example": 300 }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-09-14T09:49:19.524Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "tls_client_auth_resp": { "type": "object", "description": "TLS Client authentication response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "tls_client_auth" }, "value": { "description": "Value", "type": "string", "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-09-14T09:49:19.524Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "brotli_resp": { "type": "object", "description": "Brotli response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "brotli" }, "value": { "description": "Value", "type": "string", "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-12-08T18:57:52.826Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "browser_check_resp": { "type": "object", "description": "Browser Check response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "browser_check" }, "value": { "description": "Value", "type": "string", "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-12-08T18:57:14.506Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "origin_error_page_pass_thru_resp": { "type": "object", "description": "Origin error page pass through response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "origin_error_page_pass_thru" }, "value": { "description": "Value", "type": "string", "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-12-08T18:57:52.826Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "waf_resp": { "type": "object", "description": "WAF Response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "waf" }, "value": { "description": "Value", "type": "string", "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-12-08T18:57:43.889Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "ciphers_setting": { "type": "object", "description": "Ciphers setting", "required": [ "value" ], "properties": { "value": { "description": "Value", "type": "array", "items": { "type": "string", "enum": [ "ECDHE-ECDSA-AES128-GCM-SHA256", "ECDHE-ECDSA-CHACHA20-POLY1305", "ECDHE-RSA-AES128-GCM-SHA256", "ECDHE-RSA-CHACHA20-POLY1305", "ECDHE-ECDSA-AES128-SHA256", "ECDHE-ECDSA-AES128-SHA", "ECDHE-RSA-AES128-SHA256", "ECDHE-RSA-AES128-SHA", "AES128-GCM-SHA256", "AES128-SHA256", "AES128-SHA", "ECDHE-ECDSA-AES256-GCM-SHA384", "ECDHE-ECDSA-AES256-SHA384", "ECDHE-RSA-AES256-GCM-SHA384", "ECDHE-RSA-AES256-SHA384", "ECDHE-RSA-AES256-SHA", "AES256-GCM-SHA384", "AES256-SHA256", "AES256-SHA", "DES-CBC3-SHA" ] }, "example": [ "AES256-GCM-SHA384", "AES256-SHA256" ] } } }, "ciphers_resp": { "type": "object", "description": "Ciphers response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "ciphers" }, "value": { "description": "Value", "type": "array", "items": { "type": "string" }, "example": [ "AES256-GCM-SHA384", "AES256-SHA256" ] }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-09-14T09:49:19.524Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "origin_post_quantum_encryption": { "type": "object", "description": "Origin post quantum encryption setting", "required": [ "value" ], "properties": { "value": { "description": "Instructs CIS to use Post-Quantum (PQ) key agreement algorithms when connecting to your origin.\n- `preferred`: Instructs CIS to opportunistically send a Post-Quantum keyshare in the first message to the origin for fastest connections when the origin supports and prefers PQ.\n- `supported`: The PQ algorithms are advertised but used only when requested by the origin.\n- `off`: The PQ algorithms are not advertised.", "type": "string", "example": "preferred", "enum": [ "preferred", "supported", "off" ] } } }, "origin_post_quantum_encryption_resp": { "type": "object", "description": "Origin post quantum encryption response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "origin_pqe" }, "value": { "description": "Value", "type": "string", "enum": [ "preferred", "supported", "off" ], "example": "off" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2023-09-14T09:49:19.524Z" } } }, "success": { "description": "Was the get successful", "type": "boolean", "example": true }, "errors": { "description": "Array of errors encountered", "type": "array", "items": { "type": "object", "items": { "type": "string" } } }, "messages": { "description": "Array of messages returned", "type": "array", "items": { "type": "object", "items": { "type": "string" } } } } }, "origin_max_http_version": { "type": "object", "description": "Origin max http version setting", "required": [ "value" ], "properties": { "value": { "description": "Value", "type": "string", "example": "1", "enum": [ "1", "2" ] } } }, "origin_max_http_version_resp": { "type": "object", "description": "Origin max http version response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "origin_max_http_version" }, "value": { "description": "Value", "type": "string", "enum": [ "1", "2" ], "example": "1" }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2023-09-14T09:49:19.524Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "ip-response": { "type": "object", "description": "IP response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "object", "properties": { "ipv4_cidrs": { "type": "array", "description": "List of IPv4 CIDR addresses", "items": { "type": "string", "example": "180.15.128.0/20" } }, "ipv6_cidrs": { "type": "array", "description": "List of IPv6 CIDR addresses", "items": { "type": "string", "example": "2400:cb00::/32" } } } } } }, "load_balancer_req": { "type": "object", "description": "Load balancer request", "required": [ "name", "fallback_pool", "default_pools" ], "properties": { "name": { "type": "string", "description": "Name", "example": "www.example.com" }, "fallback_pool": { "type": "string", "description": "Fallback pool", "maximum": 32, "example": "17b5962d775c646f3f9725cbc7a53df4" }, "default_pools": { "$ref": "#/components/schemas/default_pools" }, "description": { "type": "string", "description": "Desc", "example": "Load Balancer for www.example.com" }, "ttl": { "type": "integer", "description": "TTL", "example": 30 }, "region_pools": { "$ref": "#/components/schemas/region_pools" }, "pop_pools": { "$ref": "#/components/schemas/pop_pools" }, "proxied": { "type": "boolean", "description": "Proxied", "example": true }, "enabled": { "type": "boolean", "description": "Enabled/disabled", "example": true }, "session_affinity": { "$ref": "#/components/schemas/session_affinity" }, "steering_policy": { "$ref": "#/components/schemas/steering_policy" } } }, "delete_load_balancers_resp": { "type": "object", "description": "Delete load balancers response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "object", "description": "Result", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Identifier", "example": "699d98642c564d2e855e9661899b7252" } } } } }, "load_balancers_resp": { "type": "object", "description": "Load balancer response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/load_balancer_pack" } } }, "list_load_balancers_resp": { "type": "object", "description": "Load balancer list response", "required": [ "success", "errors", "messages", "result", "result_info" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/load_balancer_result" }, "result_info": { "$ref": "#/components/schemas/result_info" } } }, "default_pools": { "type": "array", "description": "Default pools", "items": { "type": "string" }, "example": [ "17b5962d775c646f3f9725cbc7a53df4", "9290f38c5d07c2e2f4df57b1f61d4196", "00920f38ce07c2e2f4df50b1f61d4194" ] }, "region_pools": { "type": "object", "description": "Region pools", "example": { "WNAM": [ "de90f38ced07c2e2f4df50b1f61d4194", "9290f38c5d07c2e2f4df57b1f61d4196" ], "ENAM": [ "00920f38ce07c2e2f4df50b1f61d4194" ] } }, "pop_pools": { "type": "object", "description": "Pop pools", "example": { "LAX": [ "de90f38ced07c2e2f4df50b1f61d4194", "9290f38c5d07c2e2f4df57b1f61d4196" ], "LHR": [ "abd90f38ced07c2e2f4df50b1f61d4194", "f9138c5d07c2e2f4df57b1f61d4196" ], "SJC": [ "00920f38ce07c2e2f4df50b1f61d4194" ] } }, "session_affinity": { "type": "string", "description": "Session affinity", "enum": [ "", "none", "cookie", "ip_cookie" ], "example": "ip_cookie" }, "session_affinity_attributes": { "type": "object", "description": "Session affinity attributes", "required": [ "samesite", "secure", "drain_duration" ], "properties": { "samesite": { "type": "string", "description": "Configures the SameSite attribute on session affinity cookie.", "enum": [ "Auto", "None", "Lax", "Strict" ] }, "secure": { "type": "string", "description": "Configures the Secure attribute on session affinity cookie.", "enum": [ "Auto", "Always", "Never" ] }, "drain_duration": { "type": "integer", "description": "Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.", "minimum": 0, "maximum": 86400, "default": 0, "example": 100 } } }, "steering_policy": { "type": "string", "description": "Steering policy", "enum": [ "", "off", "geo", "random", "dynamic_latency" ], "example": "dynamic_latency" }, "load_balancer_pack": { "type": "object", "description": "Load balancer pack", "required": [ "id", "created_on", "modified_on", "description", "name", "ttl", "fallback_pool", "default_pools", "region_pools", "pop_pools", "proxied", "enabled", "session_affinity", "steering_policy" ], "properties": { "id": { "type": "string", "description": "Identifier", "example": "699d98642c564d2e855e9661899b7252" }, "created_on": { "type": "string", "description": "Created date", "example": "2014-01-01T05:20:00.12345Z" }, "modified_on": { "type": "string", "description": "Modified date", "example": "2014-01-01T05:20:00.12345Z" }, "description": { "type": "string", "description": "Desc", "example": "Load Balancer for www.example.com" }, "name": { "type": "string", "description": "Name", "example": "www.example.com" }, "ttl": { "type": "integer", "description": "TTL", "example": 30 }, "fallback_pool": { "type": "string", "description": "Fallback pool", "example": "17b5962d775c646f3f9725cbc7a53df4" }, "default_pools": { "$ref": "#/components/schemas/default_pools" }, "region_pools": { "$ref": "#/components/schemas/region_pools" }, "pop_pools": { "$ref": "#/components/schemas/pop_pools" }, "proxied": { "type": "boolean", "description": "Proxied", "example": true }, "enabled": { "type": "boolean", "description": "Enabled/disabled", "example": true }, "session_affinity": { "$ref": "#/components/schemas/session_affinity" }, "steering_policy": { "$ref": "#/components/schemas/steering_policy" } } }, "load_balancer_result": { "type": "array", "description": "Result", "items": { "$ref": "#/components/schemas/load_balancer_pack" } }, "dns_records_object": { "type": "object", "description": "Dns records objects", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "DNS record", "type": "object", "required": [ "recs_added", "total_records_parsed" ], "properties": { "recs_added": { "type": "integer", "description": "Total records added", "example": 5 }, "total_records_parsed": { "type": "integer", "description": "Total records parsed", "example": 5 } } }, "timing": { "type": "object", "description": "Timing object", "properties": { "start_time": { "type": "string", "description": "Start time", "example": "2014-03-01T12:20:00.000Z" }, "end_time": { "type": "string", "description": "End time", "example": "2014-03-01T12:20:01.000Z" }, "process_time": { "type": "integer", "description": "Process time", "example": 1 } } } } }, "zone_access_rule_object": { "type": "object", "description": "Access rule object", "required": [ "id", "notes", "allowed_modes", "mode", "configuration", "created_on", "modified_on" ], "properties": { "id": { "description": "Identifier of the firewall access rule", "type": "string", "example": "92f17202ed8bd63d69a66b86a49a8f6b" }, "notes": { "description": "A personal note about the rule. Typically used as a reminder or explanation for the rule.", "type": "string", "example": "This rule is set because of an event that occurred and caused X." }, "allowed_modes": { "description": "List of modes that are allowed.", "type": "array", "items": { "type": "string", "enum": [ "block", "challenge", "whitelist", "js_challenge" ] } }, "mode": { "description": "The action to be applied to a request matching the access rule.", "type": "string", "enum": [ "block", "challenge", "whitelist", "js_challenge" ] }, "scope": { "description": "The scope definition of the access rule", "type": "object", "required": [ "type" ], "properties": { "type": { "description": "The scope of the access rule, indicating if it's applicable at zone level(\\\"zone\\\") or inherited\\ \\ from instance level(\\\"account\\\").", "type": "string", "enum": [ "account", "zone" ] } } }, "created_on": { "description": "The creation date-time of the firewall access rule.", "type": "string", "example": "2014-01-01T05:20:00.123Z" }, "modified_on": { "description": "The modification date-time of the firewall access rule.", "type": "string", "example": "2014-01-01T05:20:00.123Z" }, "configuration": { "type": "object", "description": "Configuration", "required": [ "target", "value" ], "properties": { "target": { "type": "string", "description": "Target", "enum": [ "ip", "ip_range", "asn", "country" ] }, "value": { "type": "string", "description": "Value for the given target. For `ip`, the value is a valid IP address. For `ip_range`, the value specifies an IP range limited to /16 and /24. For `asn`, the value is an AS number. For `country`, the value is a country code for the country.", "example": "ip example 198.51.100.4; ip_range example 198.51.100.4/16 ; asn example AS12345; country example AZ" } } } } }, "delete_zone_access_rule_resp": { "type": "object", "description": "Delete access rule response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "object", "required": [ "id" ], "properties": { "id": { "description": "ID", "type": "string", "example": "f1aba936b94213e5b8dca0c0dbf1f9cc" } } } } }, "list_zone_access_rules_resp": { "type": "object", "description": "List access rules response", "required": [ "success", "errors", "messages", "result", "result_info" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "array", "items": { "$ref": "#/components/schemas/zone_access_rule_object" } }, "result_info": { "$ref": "#/components/schemas/result_info" } } }, "zone_access_rule_resp": { "type": "object", "description": "Access rule response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/zone_access_rule_object" } } }, "zone_access_rule_input": { "description": "Access rule create parameters", "type": "object", "required": [ "mode", "notes", "configuration" ], "properties": { "mode": { "type": "string", "description": "The action to apply to a matched request", "enum": [ "block", "challenge", "whitelist", "js_challenge" ] }, "notes": { "description": "A personal note about the rule. Typically used as a reminder or explanation for the rule.", "type": "string", "example": "This rule is added because of event X that occurred on date xyz" }, "configuration": { "type": "object", "description": "Configuration object specifying access rule", "required": [ "target", "value" ], "properties": { "target": { "description": "The request property to target", "type": "string", "enum": [ "ip", "ip_range", "asn", "country" ] }, "value": { "description": "Value for the given target. For `ip`, the value is a valid IP address. For `ip_range`, the value specifies an IP range limited to /16 and /24. For `asn`, the value is an AS number. For `country`, the value is a country code for the country.", "type": "string", "example": "ip example 198.51.100.4; ip_range example 198.51.100.4/16 ; asn example AS12345; country example AZ" } } } } }, "zone_access_rule_update_input": { "type": "object", "description": "Access rule update input", "required": [ "mode", "notes" ], "properties": { "mode": { "type": "string", "description": "The action to apply to a matched request", "enum": [ "block", "challenge", "whitelist", "js_challenge" ] }, "notes": { "description": "A personal note about the rule. Typically used as a reminder or explanation for the rule.", "type": "string", "example": "This rule is added because of event X that occurred on date xyz" } } }, "useragent_rule_object": { "type": "object", "description": "User agent rule object", "required": [ "id", "paused", "description", "mode", "configuration" ], "properties": { "id": { "description": "Identifier of the user-agent blocking rule", "type": "string", "example": "92f17202ed8bd63d69a66b86a49a8f6b" }, "paused": { "description": "Whether this user-agent rule is currently disabled.", "type": "boolean" }, "description": { "description": "Some useful information about this rule to help identify the purpose of it.", "type": "string", "maxLength": 1024, "example": "Prevent access from abusive clients identified by this UserAgent to mitigate DDoS attack" }, "mode": { "description": "The type of action to perform.", "type": "string", "enum": [ "block", "challenge", "js_challenge" ] }, "configuration": { "description": "Target/Value pair to use for this rule. The value is the exact UserAgent to match", "type": "object", "required": [ "target", "value" ], "properties": { "target": { "type": "string", "description": "Properties", "enum": [ "ua" ] }, "value": { "type": "string", "description": "The exact UserAgent string to match with this rule.", "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4" } } } } }, "delete_useragent_rule_resp": { "type": "object", "description": "User agent delete response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "object", "required": [ "id" ], "properties": { "id": { "description": "ID", "type": "string", "example": "f1aba936b94213e5b8dca0c0dbf1f9cc" } } } } }, "list_useragent_rules_resp": { "type": "object", "description": "User agent rules response", "required": [ "success", "errors", "messages", "result", "result_info" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "array", "items": { "$ref": "#/components/schemas/useragent_rule_object" } }, "result_info": { "$ref": "#/components/schemas/result_info" } } }, "useragent_rule_resp": { "type": "object", "description": "User agent rule response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/useragent_rule_object" } } }, "useragent_rule_input": { "type": "object", "description": "User agent rule input", "required": [ "mode", "configuration" ], "properties": { "paused": { "description": "Whether this user-agent rule is currently disabled.", "type": "boolean" }, "description": { "description": "Some useful information about this rule to help identify the purpose of it.", "type": "string", "maxLength": 1024, "example": "Prevent access from abusive clients identified by this UserAgent to mitigate DDoS attack" }, "mode": { "description": "The type of action to perform.", "type": "string", "enum": [ "block", "challenge", "js_challenge" ] }, "configuration": { "description": "Target/Value pair to use for this rule. The value is the exact UserAgent to match", "type": "object", "required": [ "target", "value" ], "properties": { "target": { "type": "string", "description": "Properties", "enum": [ "ua" ] }, "value": { "type": "string", "description": "The exact UserAgent string to match with this rule.", "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4" } } } } }, "firewall_event_analytics": { "type": "object", "description": "Firewall event analytics objects", "required": [ "data" ], "properties": { "data": { "description": "Data container for response data", "type": "object", "$ref": "#/components/schemas/firewall_event_analytics_data" } } }, "firewall_event_analytics_data": { "description": "Firewall event analytics data", "type": "object", "required": [ "viewer" ], "properties": { "viewer": { "description": "Viewer for firewall events analytics data", "type": "object", "$ref": "#/components/schemas/firewall_event_analytics_viewer" } } }, "firewall_event_analytics_viewer": { "description": "Viewer of the firewall events analytics data", "type": "object", "required": [ "zones" ], "properties": { "zones": { "description": "Container of the firewall events analytics data for zones", "type": "array", "items": { "$ref": "#/components/schemas/firewall_event_analytics_zone" } } } }, "firewall_event_analytics_zone": { "description": "Firewall events analytics datasets of the given zone", "type": "object", "required": [ "firewallEventsAdaptiveGroups" ], "properties": { "firewallEventsAdaptiveGroups": { "description": "FirewallEventsAdaptiveGroups dataset", "type": "array", "items": { "$ref": "#/components/schemas/firewall_event_adaptive_groups_dimensions" } } } }, "firewall_event_adaptive_groups_dimensions": { "description": "Containers for firewall events analytics data of the given zone", "type": "object", "required": [ "dimensions" ], "properties": { "dimensions": { "description": "Container of firewallEventsAdaptiveGroups dimensions.", "$ref": "#/components/schemas/firewall_event_adaptive_groups_dimension" } } }, "firewall_event_adaptive_groups_dimension": { "description": "Dimensions of firewall events analytics data", "type": "object", "properties": { "action": { "description": "Firewall action", "type": "string", "example": "drop" }, "clientCountryName": { "description": "Client country", "type": "string" }, "clientIP": { "description": "Client IP address", "type": "string" }, "clientRequestHTTPHost": { "description": "Client request HTTP hostname", "type": "string" }, "clientRequestHTTPMethodName": { "description": "Client request HTTP method", "type": "string" }, "clientRequestHTTPProtocol": { "description": "Client request HTTP protocol version", "type": "string" }, "clientRequestPath": { "description": "Client request path", "type": "string" }, "datetime": { "description": "Date time of the firewall analytics event", "type": "string" }, "edgeColoName": { "description": "Edge colocation name", "type": "string" }, "kind": { "description": "Kind of fireall analytic event", "type": "string" }, "rayName": { "description": "Ray ID", "type": "string" }, "ruleId": { "description": "Rule ID", "type": "string" }, "userAgent": { "description": "User agent", "type": "string" } } }, "list_events_resp": { "type": "object", "description": "Events list response object", "required": [ "success", "errors", "messages", "result", "result_info" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "result": { "description": "Result of the operation", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "ID of the event", "type": "string", "example": "f1aba936b94213e5b8dca0c0dbf1f9cc" }, "timestamp": { "description": "Time of the event", "type": "string", "format": "date-time", "example": "2014-01-01T05:20:00.123Z" }, "pool": { "description": "Pool information", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "Pool ID", "type": "string", "example": "f1aba936b94213e5b8dca0c0dbf1f9cc" }, "name": { "description": "Pool name", "type": "string", "example": "some-pool" }, "healthy": { "description": "Pool is healthy", "type": "boolean", "example": true }, "changed": { "description": "Pool changed", "type": "boolean", "example": true }, "minimum_origins": { "description": "Minimum origins", "type": "integer", "format": "int32", "example": 1 } } } }, "origins": { "description": "Load balancer origins", "type": "array", "items": { "type": "object", "properties": { "name": { "description": "Origin name", "type": "string", "example": "f1aba936b94213e5b8dca0c0dbf1f9cc" }, "address": { "description": "Origin address", "type": "string", "example": "1.2.3.4" }, "ip": { "description": "Origin ID", "type": "string", "example": "1.2.3.4" }, "enabled": { "description": "Origin enabled", "type": "boolean", "example": true }, "healthy": { "description": "Origin healthy", "type": "boolean", "example": true }, "failure_reason": { "description": "Origin failure reason", "type": "string", "example": "No failures" }, "changed": { "description": "Origin changed", "type": "boolean", "example": true } } } } } } }, "result_info": { "$ref": "#/components/schemas/result_info" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "waf-response": { "type": "object", "description": "WAF response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "object", "description": "Result", "properties": { "id": { "type": "string", "description": "ID", "example": "waf" }, "value": { "type": "string", "description": "Value", "example": "on" }, "editable": { "type": "boolean", "description": "Editable", "example": true }, "modified_on": { "type": "string", "description": "Modified date", "example": "2018-01-10T05:13:13.967946Z" } } } } }, "waf-body": { "type": "object", "description": "WAF body", "required": [ "value" ], "properties": { "value": { "type": "string", "description": "Value", "enum": [ "on", "off" ], "example": "on" } } }, "security_level_setting_req": { "type": "object", "description": "Security-level setting request object", "required": [ "value" ], "properties": { "value": { "type": "string", "description": "Security level", "enum": [ "essentially_off", "low", "medium", "high", "under_attack" ], "example": "under_attack" } } }, "security_level_setting_resp": { "type": "object", "description": "Security-level setting response", "required": [ "result", "result_info", "success", "errors", "messages" ], "properties": { "result": { "type": "object", "description": "Result object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "type": "string", "description": "Identifier", "enum": [ "security_level" ] }, "value": { "type": "string", "description": "Value", "example": "medium" }, "editable": { "type": "boolean", "description": "Editable", "example": true }, "modified_on": { "type": "string", "description": "Modified date", "example": "2014-01-01T05:20:00.12345Z" } } }, "result_info": { "$ref": "#/components/schemas/result_info" }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "ratelimit_object": { "type": "object", "description": "Rate limit object", "required": [ "id", "disabled", "description", "match", "bypass", "threshold", "period", "action" ], "properties": { "id": { "description": "Identifier of the rate limit", "type": "string", "maxLength": 32, "example": "92f17202ed8bd63d69a66b86a49a8f6b" }, "disabled": { "description": "Whether this ratelimit is currently disabled.", "type": "boolean", "example": false }, "description": { "description": "A note that you can use to describe the reason for a rate limit.", "type": "string", "maxLength": 1024, "example": "Prevent multiple login failures to mitigate brute force attacks" }, "bypass": { "description": "Criteria that would allow the rate limit to be bypassed, for example to express that you shouldn't\\ \\ apply a rate limit to a given set of URLs", "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "Rate limit name", "enum": [ "url" ], "example": "url" }, "value": { "type": "string", "description": "The URL to bypass", "example": "example.com/*" } } } }, "threshold": { "description": "The threshold that triggers the rate limit mitigations, combine with period. i.e. threshold per period", "type": "integer", "minimum": 2, "maximum": 1000000, "example": 1000 }, "period": { "type": "integer", "description": "The time in seconds to count matching traffic. If the count exceeds threshold within this period the action will be performed", "example": 60, "minimum": 10, "maximum": 86400 }, "correlate": { "type": "object", "description": "Enable NAT based rate limits", "required": [ "by" ], "properties": { "by": { "type": "string", "description": "Rate limit enabled by", "enum": [ "nat" ], "example": "nat" } } }, "action": { "type": "object", "description": "Action", "required": [ "mode" ], "properties": { "mode": { "type": "string", "description": "The type of action to perform.", "enum": [ "simulate", "ban", "challenge", "js_challenge" ], "example": "simulate" }, "timeout": { "type": "integer", "description": "The time in seconds as an integer to perform the mitigation action. Must be the same or greater than the period. This field is valid only when mode is \"simulate\" or \"ban\"", "example": 60, "minimum": 10, "maximum": 86400 }, "response": { "type": "object", "description": "Custom content-type and body to return, this overrides the custom error for the zone. This field is not required. Omission will result in default HTML error page.This field is valid only when mode is \"simulate\" or \"ban\"", "required": [ "content_type", "body" ], "properties": { "content_type": { "type": "string", "description": "The content type of the body", "enum": [ "text/plain", "text/xml", "application/json" ], "example": "text/plain" }, "body": { "type": "string", "description": "The body to return, the content here should conform to the content_type.", "maxLength": 10240, "example": "This request has been rate-limited." } } } } }, "match": { "type": "object", "description": "Determines which traffic the rate limit counts towards the threshold. Needs to be one of \"request\" or \"response\" objects.", "properties": { "request": { "type": "object", "description": "Request", "required": [ "url" ], "properties": { "methods": { "type": "array", "description": "A subset of the list HTTP methods, or [\"_ALL_\"] for selecting all methods.", "items": { "type": "string", "enum": [ "GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "_ALL_" ], "example": "_ALL_" } }, "schemes": { "type": "array", "description": "HTTP schemes list, or [\"_ALL_\"] for selecting all schemes.", "items": { "type": "string", "enum": [ "HTTP", "HTTPS", "_ALL_" ], "example": "_ALL_" } }, "url": { "type": "string", "description": "The URL pattern to match comprised of the host and path, i.e. example.org/path. Wildcard are expanded to match applicable traffic, query strings are not matched. Use * for all traffic to your zone.", "example": "*.example.org/path*", "maxLength": 1024 } } }, "response": { "type": "object", "description": "Response", "properties": { "status": { "type": "array", "description": "HTTP Status codes, can be one [403], many [401,403] or indicate all by not providing this value. This field is not required.", "items": { "type": "integer", "minimum": 100, "maximum": 999, "example": 403 } }, "headers": { "type": "array", "description": "Array of response headers to match. If a response does not meet the header criteria then the request will not be counted towards the rate limit.", "items": { "type": "object", "required": [ "name", "op", "value" ], "properties": { "name": { "type": "string", "description": "The name of the response header to match", "example": "Cf-Cache-Status" }, "op": { "type": "string", "description": "The operator when matchin, eq means equals, ne means not equals", "enum": [ "eq", "ne" ], "example": "ne" }, "value": { "type": "string", "enum": [ "HIT" ], "example": "HIT", "description": "The value of the header, which will be exactly matched" } } } }, "origin_traffic": { "type": "boolean", "description": "Deprecated, please use response headers instead and also provide \"origin_traffic:false\" to avoid legacy behaviour interacting with the response.headers property.", "example": false } } } } } } }, "delete_rate_limit_resp": { "type": "object", "description": "Rate limit delete response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "object", "required": [ "id" ], "properties": { "id": { "description": "ID", "type": "string", "example": "f1aba936b94213e5b8dca0c0dbf1f9cc" } } } } }, "list_ratelimit_resp": { "type": "object", "description": "Rate limit list response", "required": [ "success", "errors", "messages", "result", "result_info" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "array", "items": { "$ref": "#/components/schemas/ratelimit_object" } }, "result_info": { "$ref": "#/components/schemas/result_info" } } }, "ratelimit_resp": { "type": "object", "description": "Rate limit response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/ratelimit_object" } } }, "ratelimit_input": { "type": "object", "description": "Rate limit input parameters", "required": [ "match", "threshold", "period", "action" ], "properties": { "disabled": { "description": "Whether this ratelimit is currently disabled.", "type": "boolean", "example": false }, "description": { "description": "A note that you can use to describe the reason for a rate limit.", "type": "string", "example": "Prevent multiple login failures to mitigate brute force attacks" }, "bypass": { "description": "Criteria that would allow the rate limit to be bypassed, for example to express that you shouldn't apply a rate limit to a given set of URLs", "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "Rate limit name", "enum": [ "url" ], "example": "url" }, "value": { "type": "string", "description": "The URL to bypass.", "example": "api.example.com/*" } } } }, "threshold": { "description": "The threshold that triggers the rate limit mitigations, combine with period. i.e. threshold per period", "type": "integer", "minimum": 2, "maximum": 1000000, "example": 1000 }, "period": { "type": "integer", "description": "The time in seconds to count matching traffic. If the count exceeds threshold within this period the action will be performed", "example": 60, "minimum": 10, "maximum": 86400 }, "action": { "type": "object", "description": "Action", "required": [ "mode" ], "properties": { "mode": { "type": "string", "description": "The type of action to perform.", "enum": [ "simulate", "ban", "challenge", "js_challenge" ] }, "timeout": { "type": "integer", "description": "The time in seconds as an integer to perform the mitigation action. Must be the same or greater than the period. This field is valid only when mode is \"simulate\" or \"ban\"", "example": 60, "minimum": 10, "maximum": 86400 }, "response": { "type": "object", "description": "Custom content-type and body to return, this overrides the custom error for the zone. This field is not required. Omission will result in default HTML error page.This field is valid only when mode is \"simulate\" or \"ban\"", "properties": { "content_type": { "type": "string", "description": "The content type of the body", "enum": [ "text/plain", "text/xml", "application/json" ], "example": "text/plain" }, "body": { "type": "string", "description": "The body to return, the content here should conform to the content_type.", "example": "This request has been rate-limited.", "maxLength": 10240 } } } } }, "correlate": { "type": "object", "description": "Enable NAT based rate limits", "required": [ "by" ], "properties": { "by": { "type": "string", "description": "NAT rate limits by", "enum": [ "nat" ], "example": "nat" } } }, "match": { "type": "object", "description": "Determines which traffic the rate limit counts towards the threshold. Needs to be one of \"request\" or \"response\" objects.", "properties": { "request": { "type": "object", "description": "Request", "required": [ "url" ], "properties": { "methods": { "type": "array", "description": "A subset of the list HTTP methods, or [\"_ALL_\"] for selecting all methods.", "items": { "type": "string", "enum": [ "GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "_ALL_" ] }, "example": [ "_ALL_" ] }, "schemes": { "type": "array", "description": "HTTP schemes list, or [\"_ALL_\"] for selecting all schemes.", "items": { "type": "string", "enum": [ "HTTP", "HTTPS", "_ALL_" ] }, "example": [ "_ALL_" ] }, "url": { "type": "string", "description": "The URL pattern to match comprised of the host and path, i.e. example.org/path. Wildcard are expanded to match applicable traffic, query strings are not matched. Use * for all traffic to your zone.", "example": "*.example.org/path*", "maxLength": 1024 } } }, "response": { "type": "object", "description": "Response", "properties": { "status": { "type": "array", "description": "HTTP Status codes, can be one [403], many [401,403] or indicate all by not providing this value. This field is not required.", "items": { "type": "integer", "minimum": 100, "maximum": 999, "example": 403 } }, "headers": { "type": "array", "description": "Array of response headers to match. If a response does not meet the header criteria then the request will not be counted towards the rate limit.", "items": { "type": "object", "required": [ "name", "op", "value" ], "properties": { "name": { "type": "string", "description": "The name of the response header to match", "example": "Cf-Cache-Status" }, "op": { "type": "string", "description": "The operator when matchin, eq means equals, ne means not equals", "enum": [ "eq", "ne" ], "example": "ne" }, "value": { "type": "string", "description": "The value of the header, which will be exactly matched", "enum": [ "HIT" ], "example": "HIT" } } } }, "origin_traffic": { "type": "boolean", "description": "Deprecated, please use response headers instead and also provide \"origin_traffic:false\" to avoid legacy behaviour interacting with the response.headers property.", "example": false } } } } } } }, "ratelimit_analytics_resp": { "type": "object", "description": "Rate limit analytics", "required": [ "since", "until", "time_delta", "golden_record", "labels", "timeseries" ], "properties": { "since": { "description": "The beginning time of analytics.", "type": "string", "format": "date-time", "example": "2018-09-18T04:56:00.000Z" }, "until": { "description": "The end time of analytics.", "type": "string", "format": "date-time", "example": "2018-09-18T04:58:00.000Z" }, "time_delta": { "description": "The time interval of analytics' record.", "type": "integer", "example": 60 }, "golden_record": { "description": "Whether the analytics' record is golden record.", "type": "boolean", "example": true }, "labels": { "description": "Labels.", "type": "object", "example": { "0285184ba1234698bb1e8e4b3550011c": "protect login" } }, "timeseries": { "description": "The analytics' records in the time frame.", "type": "array", "items": { "type": "object", "required": [ "since", "until", "rules" ], "properties": { "since": { "description": "The beginning time of the analytics record.", "type": "string", "format": "date-time", "example": "2018-09-18T04:56:00.000Z" }, "until": { "description": "The end time of the analytics record.", "type": "string", "format": "date-time", "example": "2018-09-18T04:57:00.000Z" }, "rules": { "type": "object", "description": "Rate limit rules", "example": {} } } } } } }, "load_balancer_pool_req": { "type": "object", "description": "Load balancer pool request", "required": [ "name", "origins", "check_regions" ], "properties": { "name": { "type": "string", "description": "Name", "example": "primary-dc-1" }, "check_regions": { "type": "array", "description": "Regions check", "items": { "type": "string", "example": "WNAM", "description": "Geographic region code" } }, "origins": { "type": "array", "description": "Origins", "items": { "type": "object", "description": "Items", "properties": { "name": { "type": "string", "description": "Name", "example": "app-server-1" }, "address": { "type": "string", "description": "Address", "example": "0.0.0.0" }, "enabled": { "type": "boolean", "description": "Enabled/disabled", "example": true }, "weight": { "type": "number", "description": "Weight", "example": 1 }, "header": { "type": "object", "description": "Header", "properties": { "host": { "type": "array", "description": "Host", "items": { "type": "string", "example": "example.com" } } } } } } }, "description": { "type": "string", "description": "Desc", "example": "Primary data center - Provider XYZ" }, "minimum_origins": { "type": "integer", "example": 2, "description": "The minimum number of origins that must be healthy for this pool to serve traffic" }, "enabled": { "type": "boolean", "description": "Enabled/disabled", "example": true }, "monitor": { "type": "string", "description": "Monitor", "example": "f1aba936b94213e5b8dca0c0dbf1f9cc" }, "notification_email": { "type": "string", "description": "Notification email", "example": "someone@example.com" } } }, "list_load_balancer_pools_resp": { "type": "object", "description": "List load balancer pools response", "required": [ "success", "errors", "messages", "result", "result_info" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/load_balancer_pool_result" }, "result_info": { "$ref": "#/components/schemas/result_info" } } }, "load_balancer_pool_resp": { "type": "object", "description": "Get load balancer pool response", "required": [ "success", "errors", "messages", "result", "result_info" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/load_balancer_pool_pack" }, "result_info": { "$ref": "#/components/schemas/result_info" } } }, "delete_load_balancer_pool_resp": { "type": "object", "description": "Load balancer pool delete response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "object", "description": "Result", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Identifier", "example": "17b5962d775c646f3f9725cbc7a53df4" } } } } }, "load_balancer_pool_pack": { "type": "object", "description": "Load balancer pool pack", "required": [ "name", "origins" ], "properties": { "id": { "type": "string", "description": "Identifier", "example": "17b5962d775c646f3f9725cbc7a53df4" }, "created_on": { "type": "string", "description": "Created date", "example": "2014-01-01T05:20:00.12345Z" }, "modified_on": { "type": "string", "description": "Modified date", "example": "2014-01-01T05:20:00.12345Z" }, "description": { "type": "string", "description": "Desc", "example": "Primary data center - Provider XYZ" }, "name": { "type": "string", "description": "Name", "example": "primary-dc-1" }, "enabled": { "type": "boolean", "description": "Enabled/disabled", "example": true }, "healthy": { "type": "boolean", "description": "Healthy", "example": true }, "monitor": { "type": "string", "description": "Monitor", "example": "f1aba936b94213e5b8dca0c0dbf1f9cc" }, "minimum_origins": { "type": "integer", "format": "int32", "description": "Minimum origin count", "example": 1 }, "check_regions": { "type": "array", "description": "Regions check", "items": { "type": "string", "example": "WNAM", "description": "Geographic region code" } }, "origins": { "type": "array", "description": "Original", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name", "example": "app-server-1" }, "address": { "type": "string", "description": "Address", "example": "0.0.0.0" }, "enabled": { "type": "boolean", "description": "Enabled/disabled", "example": true }, "healthy": { "type": "boolean", "description": "Healthy", "example": true }, "weight": { "type": "number", "description": "Weight", "example": 1 }, "header": { "type": "object", "description": "Header", "properties": { "host": { "type": "array", "description": "Host", "items": { "type": "string", "example": "example.com" } } } }, "disabled_at": { "type": "string", "description": "Pool origin disabled date", "example": "2014-01-01T05:20:00.12345Z" }, "failure_reason": { "type": "string", "description": "Reason for failure", "example": "HTTP Timeout occured" } } } }, "notification_email": { "type": "string", "description": "Notification email", "example": "someone@example.com" } } }, "load_balancer_pool_result": { "type": "array", "description": "Result", "items": { "$ref": "#/components/schemas/load_balancer_pool_pack" } }, "lockdown_object": { "type": "object", "description": "Lockdown object", "required": [ "id", "paused", "description", "urls", "configurations" ], "properties": { "id": { "description": "Lockdown rule identifier", "type": "string", "example": "372e67954025e0ba6aaa6d586b9e0b59" }, "priority": { "description": "Firewall priority", "type": "integer", "example": 5 }, "paused": { "description": "Whether this zone lockdown is currently paused", "type": "boolean", "example": false }, "description": { "description": "A note that you can use to describe the reason for a Lockdown rule.", "type": "string", "example": "Restrict access to these endpoints to requests from a known IP address" }, "urls": { "description": "URLs to be included in this rule definition. Wildcards are permitted. The URL pattern entered here will be escaped before use. This limits the URL to just simple wildcard patterns.", "type": "array", "items": { "type": "string", "example": "api.mysite.com/some/endpoint*" } }, "configurations": { "description": "List of IP addresses or CIDR ranges to use for this rule. This can include any number of `ip` or `ip_range` configurations that can access the provided URLs.", "type": "array", "items": { "type": "object", "required": [ "target", "value" ], "properties": { "target": { "type": "string", "description": "Target", "enum": [ "ip", "ip_range" ] }, "value": { "description": "IP addresses or CIDR, if target is \"ip\", then value should be an IP addresses, otherwise CIDR.", "type": "string", "example": "198.51.100.4 if target=ip, 2.2.2.0/24 if target=ip_range" } } } } } }, "delete_lockdown_resp": { "type": "object", "description": "Delete lockdown response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "object", "required": [ "id" ], "properties": { "id": { "description": "ID", "type": "string", "example": "f1aba936b94213e5b8dca0c0dbf1f9cc" } } } } }, "list_lockdown_resp": { "type": "object", "description": "List lockdown response", "required": [ "success", "errors", "messages", "result", "result_info" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "array", "items": { "$ref": "#/components/schemas/lockdown_object" } }, "result_info": { "$ref": "#/components/schemas/result_info" } } }, "lockdown_resp": { "type": "object", "description": "Lockdown response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/lockdown_object" } } }, "lockdown_input": { "type": "object", "description": "Lockdown input", "required": [ "urls", "configurations" ], "properties": { "id": { "description": "Lockdown rule identifier", "type": "string", "example": "372e67954025e0ba6aaa6d586b9e0b59" }, "paused": { "description": "Whether this zone lockdown is currently paused", "type": "boolean", "example": false }, "description": { "description": "A note that you can use to describe the reason for a Lockdown rule.", "type": "string", "example": "Restrict access to these endpoints to requests from a known IP address" }, "urls": { "description": "URLs to be included in this rule definition. Wildcards are permitted. The URL pattern entered here will be escaped before use. This limits the URL to just simple wildcard patterns.", "type": "array", "items": { "type": "string", "example": "api.mysite.com/some/endpoint*" } }, "configurations": { "description": "List of IP addresses or CIDR ranges to use for this rule. This can include any number of `ip` or `ip_range` configurations that can access the provided URLs.", "type": "array", "items": { "type": "object", "required": [ "target", "value" ], "properties": { "target": { "type": "string", "description": "Properties", "enum": [ "ip", "ip_range" ] }, "value": { "description": "IP addresses or CIDR, if target is \"ip\", then value should be an IP addresses, otherwise CIDR.", "type": "string", "example": "198.51.100.4 if target=ip, 2.2.2.0/24 if target=ip_range" } } } }, "priority": { "description": "Firewall priority", "type": "integer", "example": 5 } } }, "waf-packages-response": { "type": "object", "description": "WAF packages response", "required": [ "success", "errors", "messages", "result", "result_info" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "ID", "type": "string", "example": "a25a9a7e9c00afc1fb2e0245519d725b" }, "name": { "description": "Name", "type": "string", "example": "WordPress rules" }, "description": { "description": "Description", "type": "string", "example": "Common WordPress exploit protections" }, "detection_mode": { "description": "Detection mode", "type": "string", "example": "traditional" }, "zone_id": { "description": "Value", "type": "string", "example": "023e105f4ecef8ad9ca31a8372d0c353" }, "status": { "description": "Value", "type": "string", "example": "active" } } } }, "result_info": { "$ref": "#/components/schemas/result_info" } } }, "waf-package-response": { "type": "object", "description": "WAF package response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "object", "properties": { "id": { "description": "ID", "type": "string", "example": "a25a9a7e9c00afc1fb2e0245519d725b" }, "name": { "description": "Name", "type": "string", "example": "WordPress rules" }, "description": { "description": "Description", "type": "string", "example": "Common WordPress exploit protections" }, "detection_mode": { "description": "Detection mode", "type": "string", "example": "traditional" }, "zone_id": { "description": "Value", "type": "string", "example": "023e105f4ecef8ad9ca31a8372d0c353" }, "status": { "description": "Value", "type": "string", "example": "active" }, "sensitivity": { "description": "Value", "type": "string", "example": "high" }, "action_mode": { "description": "Value", "type": "string", "example": "challenge" } } } } }, "pageRules-response-list-all": { "type": "object", "description": "Page rule response list all", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "array", "description": "Result", "items": { "$ref": "#/components/schemas/page_rule_result" } } } }, "pageRules-response-without-result_info": { "type": "object", "description": "Page rule response without result information", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/page_rule_result" } } }, "pageRules-body": { "type": "object", "description": "Page rule body", "required": [ "targets", "actions" ], "properties": { "targets": { "$ref": "#/components/schemas/targets" }, "actions": { "$ref": "#/components/schemas/actions" }, "priority": { "type": "integer", "description": "Priority", "format": "int32", "example": 1 }, "status": { "type": "string", "description": "Status", "example": "active" } } }, "pageRules-patch-body": { "type": "object", "description": "Page rule patch body", "properties": { "targets": { "$ref": "#/components/schemas/targets" }, "actions": { "$ref": "#/components/schemas/actions" }, "priority": { "type": "integer", "description": "Priority", "format": "int32", "example": 1 }, "status": { "type": "string", "description": "Status", "example": "active" } } }, "targets": { "type": "array", "description": "Targets", "items": { "type": "object", "description": "Items", "required": [ "target", "constraint" ], "properties": { "target": { "type": "string", "description": "Target", "example": "url" }, "constraint": { "type": "object", "description": "Constraint", "required": [ "operator", "value" ], "properties": { "operator": { "type": "string", "description": "Operator", "example": "matches" }, "value": { "type": "string", "description": "Value", "example": "*example.com/images/*" } } } } } }, "actions": { "type": "array", "description": "Actions", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "enum": [ "disable_security", "browser_check", "server_side_exclude", "ssl", "browser_cache_ttl", "always_online", "security_level", "cache_level", "edge_cache_ttl", "ip_geolocation", "email_obfuscation", "automatic_https_rewrites", "opportunistic_encryption", "forwarding_url", "always_use_https", "explicit_cache_control", "bypass_cache_on_cookie", "cache_deception_armor", "waf" ], "description": "\" Page rule action field map from UI to API\n CF-UI map API,\n'Disable Security' to 'disable_security',\n'Browser Integrity Check' to 'browser_check',\n'Server Side Excludes' to 'server_side_exclude',\n'SSL' to 'ssl',\n'Browser Cache TTL' to 'browser_cache_ttl',\n'Always Online' to 'always_online',\n'Security Level' to 'security_level',\n'Cache Level' to 'cache_level',\n'Edge Cache TTL' to 'edge_cache_ttl'\n'IP Geolocation Header' to 'ip_geolocation,\n'Email Obfuscation' to 'email_obfuscation',\n'Automatic HTTPS Rewrites' to 'automatic_https_rewrites',\n'Opportunistic Encryption' to 'opportunistic_encryption',\n'Forwarding URL' to 'forwarding_url',\n'Always Use HTTPS' to 'always_use_https',\n'Origin Cache Control' to 'explicit_cache_control',\n'Bypass Cache on Cookie' to 'bypass_cache_on_cookie',\n'Cache Deception Armor' to 'cache_deception_armor',\n'WAF' to 'waf'\n\n Page rule conflict list\n\"forwarding_url\" with all other settings for the rules\n\"always_use_https\" with all other settings for the rules\n\"disable_security\" with \"email_obfuscation\", \"server_side_exclude\", \"waf\"\n\"\n" }, "value": { "type": "object", "description": "Value" } }, "oneOf": [ { "$ref": "#/components/schemas/actions-security" }, { "$ref": "#/components/schemas/actions-security-options" }, { "$ref": "#/components/schemas/actions-ssl" }, { "$ref": "#/components/schemas/actions-ttl" }, { "$ref": "#/components/schemas/actions-security-level" }, { "$ref": "#/components/schemas/actions-cache-level" }, { "$ref": "#/components/schemas/actions-edge-cache-ttl" }, { "$ref": "#/components/schemas/actions-forwarding-url" }, { "$ref": "#/components/schemas/actions-bypass_cache_on_cookie" } ] }, "example": [ { "id": "disable_security" }, { "id": "browser_check", "value": "off" }, { "id": "always_use_https" }, { "id": "server_side_exclude", "value": "off" }, { "id": "ssl", "value": "flexible" }, { "id": "browser_cache_ttl", "value": 1800 }, { "id": "always_online", "value": "off" }, { "id": "security_level", "value": "low" }, { "id": "cache_level", "value": "basic" }, { "id": "edge_cache_ttl", "value": 18000 }, { "id": "ip_geolocation", "value": "off" }, { "id": "email_obfuscation", "value": "off" }, { "id": "automatic_https_rewrites", "value": "off" }, { "id": "opportunistic_encryption", "value": "off" }, { "id": "forwarding_url", "value": { "url": "http://www.example.com", "status_code": 301 } }, { "id": "explicit_cache_control", "value": "off" }, { "id": "bypass_cache_on_cookie", "value": "testCookie" }, { "id": "cache_deception_armor", "value": "off" }, { "id": "waf", "value": "off" } ] }, "page_rule_result": { "type": "object", "description": "Page rule result", "required": [ "id", "targets", "actions", "priority", "status", "modified_on", "created_on" ], "properties": { "id": { "type": "string", "description": "Identifier", "example": "9a7806061c88ada191ed06f989cc3dac" }, "targets": { "$ref": "#/components/schemas/targets" }, "actions": { "$ref": "#/components/schemas/actions" }, "priority": { "type": "integer", "description": "Priority", "format": "int32", "example": 1 }, "status": { "type": "string", "description": "Status", "example": "active" }, "modified_on": { "type": "string", "description": "Modified date", "example": "2014-01-01T05:20:00.12345Z" }, "created_on": { "type": "string", "description": "Created date", "example": "2014-01-01T05:20:00.12345Z" } } }, "pageRules-delete-response": { "type": "object", "description": "Page rules delete response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "object", "description": "Result", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Identifier", "example": "9a7806061c88ada191ed06f989cc3dac" } } } } }, "actions-security-level": { "type": "object", "description": "Security-level actions", "properties": { "id": { "type": "string", "description": "Identifier", "enum": [ "security_level" ] }, "value": { "type": "string", "description": "Value", "enum": [ "off", "essentially_off", "low", "medium", "high", "under_attack" ] } } }, "actions-ttl": { "type": "object", "description": "TTL actions", "properties": { "id": { "type": "string", "description": "Identifier", "enum": [ "browser_cache_ttl" ] }, "value": { "type": "integer", "description": "Value", "enum": [ 0, 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800, 259200, 345600, 432000, 691200, 1382400, 2073600, 2678400, 5356800, 16070400, 31536000 ] } } }, "actions-ssl": { "type": "object", "description": "SSL actions", "properties": { "id": { "type": "string", "description": "Identifier", "enum": [ "ssl" ] }, "value": { "type": "string", "description": "Value", "enum": [ "off", "flexible", "full", "strict", "origin_pull" ] } } }, "actions-security": { "type": "object", "description": "Security actions", "properties": { "id": { "type": "string", "description": "Identifier", "enum": [ "disable_security", "always_use_https" ] } } }, "actions-security-options": { "type": "object", "description": "Security options", "properties": { "id": { "type": "string", "description": "Identifier", "enum": [ "browser_check", "server_side_exclude", "always_online", "email_obfuscation", "automatic_https_rewrites", "opportunistic_encryption", "ip_geolocation", "explicit_cache_control", "cache_deception_armor", "waf" ] }, "value": { "type": "string", "description": "Value", "enum": [ "on", "off" ] } } }, "actions-edge-cache-ttl": { "type": "object", "description": "Edge cache ttl actions", "properties": { "id": { "type": "string", "description": "Identifier", "enum": [ "edge_cache_ttl" ] }, "value": { "type": "integer", "description": "TTL value", "enum": [ 0, 30, 60, 300, 600, 1200, 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800, 259200, 345600, 432000, 518400, 604800, 1209600, 2419200 ] } } }, "actions-forwarding-url": { "type": "object", "description": "Forwarding URL actions", "properties": { "id": { "type": "string", "description": "Identifier", "enum": [ "forwarding_url" ] }, "value": { "type": "object", "description": "Value", "properties": { "url": { "type": "string", "description": "URL" }, "status_code": { "type": "integer", "description": "Status code", "enum": [ 301, 302 ] } } } } }, "actions-bypass_cache_on_cookie": { "type": "object", "description": "Bypass cache on cookie actions", "properties": { "id": { "type": "string", "description": "Identifier", "enum": [ "bypass_cache_on_cookie" ] }, "value": { "type": "string", "description": "Value" } } }, "actions-cache-level": { "type": "object", "description": "Cache level actions", "properties": { "id": { "type": "string", "description": "Identifier", "enum": [ "cache_level" ] }, "value": { "type": "string", "description": "Value", "enum": [ "bypass", "aggressive", "basic", "simplified", "cache_everything" ] } } }, "monitor_req": { "type": "object", "description": "Monitor response", "required": [ "expected_codes" ], "properties": { "type": { "type": "string", "description": "HTTP type", "example": "http" }, "description": { "type": "string", "description": "Login page monitor", "example": "Login page monitor" }, "method": { "type": "string", "description": "Method", "example": "GET" }, "port": { "type": "integer", "description": "Port number", "example": 8080 }, "path": { "type": "string", "description": "Path", "example": "/" }, "timeout": { "type": "integer", "description": "Timeout count", "example": 5 }, "retries": { "type": "integer", "description": "Retry count", "example": 2 }, "interval": { "type": "integer", "description": "Interval", "example": 60 }, "expected_codes": { "type": "string", "description": "Expected codes", "example": "2xx" }, "follow_redirects": { "type": "boolean", "description": "Follow redirects", "example": true }, "expected_body": { "type": "string", "description": "Expected body", "example": "alive" }, "allow_insecure": { "type": "boolean", "description": "Allow insecure", "example": true }, "header": { "type": "object", "description": "Header", "additionalProperties": { "$ref": "#/components/schemas/monitor_header_input" } } } }, "monitor_header_input": { "type": "array", "items": { "type": "string" } }, "delete_monitor_resp": { "type": "object", "description": "Delete monitor response object", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "object", "description": "Result", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Identifier", "example": "f1aba936b94213e5b8dca0c0dbf1f9cc" } } } } }, "list_monitor_resp": { "type": "object", "description": "Monitor list response", "required": [ "success", "errors", "messages", "result", "result_info" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/monitor_result" }, "result_info": { "$ref": "#/components/schemas/result_info" } } }, "monitor_resp": { "type": "object", "description": "Monitor response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/monitor_pack" } } }, "monitor_pack": { "type": "object", "description": "Monitor package", "required": [ "expected_body", "expected_codes" ], "properties": { "id": { "type": "string", "description": "Identifier", "example": "f1aba936b94213e5b8dca0c0dbf1f9cc" }, "created_on": { "type": "string", "description": "Created date", "example": "2014-01-01T05:20:00.12345Z" }, "modified_on": { "type": "string", "description": "Modified date", "example": "2014-01-01T05:20:00.12345Z" }, "type": { "type": "string", "description": "Type", "example": "http" }, "description": { "type": "string", "description": "Login page", "example": "Login page monitor" }, "method": { "type": "string", "description": "Method name", "example": "GET" }, "port": { "type": "integer", "description": "Port number", "example": 8080 }, "path": { "type": "string", "description": "Path", "example": "/" }, "timeout": { "type": "integer", "description": "Timeout count", "example": 5 }, "retries": { "type": "integer", "description": "Retries count", "example": 2 }, "interval": { "type": "integer", "description": "Interval", "example": 60 }, "expected_body": { "type": "string", "description": "Expected body", "example": "alive" }, "expected_codes": { "type": "string", "description": "Expected codes", "example": "2xx" }, "follow_redirects": { "type": "boolean", "description": "Follow redirects", "example": true }, "allow_insecure": { "type": "boolean", "description": "Allow insecure", "example": true }, "header": { "type": "object", "description": "Header", "additionalProperties": { "$ref": "#/components/schemas/monitor_header_input" } } } }, "monitor_result": { "type": "array", "description": "Result", "items": { "$ref": "#/components/schemas/monitor_pack" } }, "id": { "description": "Identifier of the zone.", "type": "string", "example": "269d8f4853475ca241c4e730be286b20" }, "name": { "description": "Name of the zone.", "type": "string", "example": "www.example.com" }, "delete_zone_resp": { "type": "object", "description": "Delete zone response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "object", "description": "Result", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "ID", "example": "f1aba936b94213e5b8dca0c0dbf1f9cc" } } } } }, "zone_activationcheck_resp": { "type": "object", "description": "zone activation check response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "object", "description": "Result", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "ID", "example": "f1aba936b94213e5b8dca0c0dbf1f9cc" } } } } }, "list_zones_resp": { "type": "object", "description": "List zones response", "required": [ "success", "errors", "messages", "result", "result_info" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/zone_list" }, "result_info": { "$ref": "#/components/schemas/result_info" } } }, "zone_resp": { "type": "object", "description": "zone response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/zone_details" } } }, "zone_details": { "type": "object", "description": "zone details", "properties": { "id": { "type": "string", "description": "ID", "example": "f1aba936b94213e5b8dca0c0dbf1f9cc" }, "created_on": { "type": "string", "description": "Created date", "example": "2014-01-01T05:20:00.12345Z" }, "modified_on": { "type": "string", "description": "Modified date", "example": "2014-01-01T05:20:00.12345Z" }, "name": { "type": "string", "description": "Name", "example": "test-example.com" }, "original_registrar": { "type": "string", "description": "Original registrar", "example": "GoDaddy" }, "original_dnshost": { "type": "string", "description": "Orginal dns host", "example": "NameCheap" }, "status": { "type": "string", "description": "Status", "example": "active" }, "paused": { "type": "boolean", "description": "Paused", "example": false }, "original_name_servers": { "type": "array", "description": "Orginal name servers", "items": { "type": "string", "example": "ns1.originaldnshost.com" } }, "name_servers": { "type": "array", "description": "Name servers", "items": { "type": "string", "example": "ns001.name.cloud.ibm.com" } }, "type": { "type": "string", "description": "zone type", "example": "full" }, "verification_key": { "type": "string", "description": "Verification key", "example": "476754457-428595283" }, "cname_suffix": { "type": "string", "description": "Canme suffix", "example": "cdn.cloudflare.net" } } }, "zone_input": { "type": "object", "description": "zone input", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name", "example": "test-example.com" }, "type": { "type": "string", "description": "A zone implies that DNS is hosted with CIS authoritative nameservers. A partial zone is typically a CNAME setup.", "example": "full", "enum": [ "full", "partial" ] } } }, "zone_update_input": { "type": "object", "description": "zone update input", "required": [ "paused" ], "properties": { "paused": { "type": "boolean", "description": "Paused", "example": false } } }, "zone_list": { "type": "array", "description": "zone list", "items": { "$ref": "#/components/schemas/zone_details" } }, "account_access_rule_object": { "type": "object", "description": "Access rule objects", "required": [ "id", "notes", "allowed_modes", "mode", "configuration", "created_on", "modified_on" ], "properties": { "id": { "description": "Identifier of the instance level firewall access rule", "type": "string", "example": "92f17202ed8bd63d69a66b86a49a8f6b" }, "notes": { "description": "A personal note about the rule. Typically used as a reminder or explanation for the rule.", "type": "string", "example": "This rule is set because of an event that occurred and caused X." }, "allowed_modes": { "description": "List of modes that are allowed.", "type": "array", "items": { "type": "string", "enum": [ "block", "challenge", "whitelist", "js_challenge" ] } }, "mode": { "description": "The action to be applied to a request matching the instance level access rule.", "type": "string", "enum": [ "block", "challenge", "whitelist", "js_challenge" ] }, "scope": { "description": "The scope definition of the access rule", "type": "object", "required": [ "type" ], "properties": { "type": { "description": "The scope of the access rule", "type": "string", "enum": [ "account", "organization" ] } } }, "created_on": { "description": "The creation date-time of the instance level firewall access rule.", "type": "string", "format": "date-time", "example": "2014-01-01T05:20:00.123Z" }, "modified_on": { "description": "The modification date-time of the instance level firewall access rule.", "type": "string", "format": "date-time", "example": "2014-01-01T05:20:00.123Z" }, "configuration": { "type": "object", "description": "Configuration", "required": [ "target", "value" ], "properties": { "target": { "type": "string", "description": "Target IP address", "enum": [ "ip", "ip_range", "asn", "country" ] }, "value": { "type": "string", "description": "Value for the given target. For `ip`, the value is a valid IP address. For `ip_range`, the value specifies an IP range limited to /16 and /24. For `asn`, the value is an AS number. For `country`, the value is a country code for the country.", "example": "ip example 198.51.100.4; ip_range example 198.51.100.4/16 ; asn example AS12345; country example AZ" } } } } }, "delete_account_access_rule_resp": { "type": "object", "description": "Delete access rule response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "object", "required": [ "id" ], "properties": { "id": { "description": "ID", "type": "string", "example": "f1aba936b94213e5b8dca0c0dbf1f9cc" } } } } }, "list_account_access_rules_resp": { "type": "object", "description": "Access rule list response", "required": [ "success", "errors", "messages", "result", "result_info" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "array", "items": { "$ref": "#/components/schemas/account_access_rule_object" } }, "result_info": { "description": "Statistics of results", "type": "object", "required": [ "page", "per_page", "count", "total_count" ], "properties": { "page": { "description": "Page number", "type": "integer", "format": "int32", "example": 1 }, "per_page": { "description": "Number of results per page", "type": "integer", "format": "int32", "example": 2 }, "count": { "description": "Number of results", "type": "integer", "format": "int32", "example": 1 }, "total_count": { "description": "Total number of results", "type": "integer", "format": "int32", "example": 200 } } } } }, "account_access_rule_resp": { "type": "object", "description": "Access rule response output", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/account_access_rule_object" } } }, "account_access_rule_input": { "description": "Access Rule create parameters", "type": "object", "required": [ "mode", "notes", "configuration" ], "properties": { "mode": { "type": "string", "description": "The action to apply to a matched request", "enum": [ "block", "challenge", "whitelist", "js_challenge" ] }, "notes": { "description": "A personal note about the rule. Typically used as a reminder or explanation for the rule.", "type": "string", "example": "This rule is added because of event X that occurred on date xyz" }, "configuration": { "type": "object", "description": "Configuration object specifying access rule", "required": [ "target", "value" ], "properties": { "target": { "description": "The request property to target", "type": "string", "enum": [ "ip", "ip_range", "asn", "country" ] }, "value": { "description": "Value for the given target. For `ip`, the value is a valid IP address. For `ip_range`, the value specifies an IP range limited to /16 and /24. For `asn`, the value is an AS number. For `country`, the value is a country code for the country.", "type": "string", "example": "ip example 198.51.100.4; ip_range example 198.51.100.4/16 ; asn example AS12345; country example AZ" } } } } }, "account_access_rule_update_input": { "type": "object", "description": "Access rule update input", "required": [ "mode", "notes" ], "properties": { "mode": { "type": "string", "description": "The action to apply to a matched request", "enum": [ "block", "challenge", "whitelist", "js_challenge" ] }, "notes": { "description": "A personal note about the rule. Typically used as a reminder or explanation for the rule.", "type": "string", "example": "This rule is added because of event X that occurred on date xyz" } } }, "waf-rules-response": { "type": "object", "description": "WAF rule response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Array of Rules", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "ID", "type": "string", "example": "f939de3be84e66e757adcdcb87908023" }, "description": { "description": "Description", "type": "string", "example": "SQL-injection-prevention-for-SELECT-statements" }, "priority": { "description": "Priority", "type": "string", "example": 5 }, "group": { "description": "Group definition", "type": "object", "properties": { "id": { "description": "Group id", "type": "string", "example": "de677e5818985db1285d0e80225f06e5" }, "name": { "description": "Group name", "type": "string", "example": "Project abc" } } }, "package_id": { "description": "Package ID", "type": "string", "example": "a25a9a7e9c00afc1fb2e0245519d725b" }, "allowed_modes": { "description": "Allowed modes", "type": "array", "items": { "type": "string" }, "example": [ "on", "off" ] }, "mode": { "description": "Mode", "type": "string", "enum": [ "on", "off" ], "example": "on" } } } }, "result_info": { "$ref": "#/components/schemas/result_info" } } }, "waf-rule-response": { "type": "object", "description": "WAF rule response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Information about a Rule", "type": "object", "properties": { "id": { "description": "ID", "type": "string", "example": "f939de3be84e66e757adcdcb87908023" }, "description": { "description": "Description", "type": "string", "example": "SQL-injection-prevention-for-SELECT-statements" }, "priority": { "description": "Priority", "type": "string", "example": 5 }, "group": { "description": "Group definition", "type": "object", "properties": { "id": { "description": "Group id", "type": "string", "example": "de677e5818985db1285d0e80225f06e5" }, "name": { "description": "Group name", "type": "string", "example": "Project abc" } } }, "package_id": { "description": "Package ID", "type": "string", "example": "a25a9a7e9c00afc1fb2e0245519d725b" }, "allowed_modes": { "description": "Allowed modes", "type": "array", "items": { "type": "string" }, "example": [ "on", "off" ] }, "mode": { "description": "Mode", "type": "string", "enum": [ "on", "off" ], "example": "on" } } } } }, "waf-rule-body": { "type": "object", "description": "WAF rule body", "properties": { "cis": { "description": "Cis package", "type": "object", "required": [ "mode" ], "properties": { "mode": { "description": "Mode to choose from.", "type": "string", "enum": [ "default", "disable", "simulate", "block", "challenge" ] } }, "example": { "mode": "block" } }, "owasp": { "description": "Owasp package", "type": "object", "required": [ "mode" ], "properties": { "mode": { "description": "mode to choose from. 'owasp' limited modes - on and off", "type": "string", "enum": [ "on", "off" ] } }, "example": { "mode": "on" } } } }, "purgeAll-response": { "type": "object", "description": "Purge all response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "object", "description": "Purge object", "properties": { "id": { "type": "string", "description": "Purge ID", "example": "62d26b178b67c0eda0613891f3f51b0a" } } } } }, "purge_urls_body": { "type": "object", "description": "Purge URL object", "required": [ "files" ], "properties": { "files": { "type": "array", "description": "Purge URL array", "items": { "type": "string", "example": "http://www.example.com/cat_picture.jpg" } } } }, "purge_tags_body": { "type": "object", "description": "Purge tag", "required": [ "tags" ], "properties": { "tags": { "type": "array", "description": "Array of tags", "items": { "type": "string", "example": "some-tag" } } } }, "purge_hosts_body": { "type": "object", "description": "Host object", "required": [ "hosts" ], "properties": { "hosts": { "type": "array", "description": "Hosts name", "items": { "type": "string", "example": "www.example.com" } } } }, "purge_prefixes_body": { "description": "Purge prefixes body", "type": "object", "required": [ "prefixes" ], "properties": { "prefixes": { "description": "Prefixes", "type": "array", "items": { "type": "string", "example": "www.example.com/foo" } } } }, "cacheLevel-response": { "type": "object", "description": "Cache level response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "object", "description": "Result", "properties": { "id": { "type": "string", "description": "Cache level", "example": "cache_level" }, "value": { "type": "string", "description": "Cache level", "example": "aggressive" }, "editable": { "type": "boolean", "description": "Editable value", "example": true }, "modified_on": { "type": "string", "description": "Modified date", "example": "2014-01-01T05:20:00.12345Z" } } } } }, "cacheLevel-body": { "type": "object", "description": "Cache level object", "required": [ "value" ], "properties": { "value": { "type": "string", "description": "Cache level", "enum": [ "basic", "simplified", "aggressive" ], "example": "aggressive" } } }, "browserTTL-response": { "type": "object", "description": "Browser ttl response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "object", "description": "Result object", "properties": { "id": { "type": "string", "description": "TTL type", "example": "browser_cache_ttl" }, "value": { "type": "integer", "description": "TTL value", "example": 14400 }, "editable": { "type": "boolean", "description": "Editable", "example": true }, "modified_on": { "type": "string", "description": "Modified date", "example": "2014-01-01T05:20:00.12345Z" } } } } }, "browserTTL-body": { "type": "object", "description": "Browser ttl object", "required": [ "value" ], "properties": { "value": { "type": "integer", "description": "TTL value", "minimum": 0, "maximum": 31536000, "example": 14400 } } }, "serveStaleContent-response": { "type": "object", "description": "Serve stale conent response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "object", "description": "Result object", "properties": { "id": { "type": "string", "description": "Serve stale content cache id", "example": "serve_stale_content" }, "value": { "type": "string", "description": "On/off value", "example": "on" }, "editable": { "type": "boolean", "description": "Editable value", "example": true }, "modified_on": { "type": "string", "description": "Modified date", "example": "2014-01-01T05:20:00.12345Z" } } } } }, "serveStaleContent-body": { "type": "object", "description": "Serve stale content body object", "required": [ "value" ], "properties": { "value": { "type": "string", "description": "On/off value", "enum": [ "on", "off" ], "example": "on" } } }, "deveopmentMode-response": { "type": "object", "description": "Development mode response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "object", "description": "Result object", "properties": { "id": { "type": "string", "description": "Object id", "example": "development_mode" }, "value": { "type": "string", "description": "On/off value", "example": "off" }, "editable": { "type": "boolean", "description": "Editable value", "example": true }, "modified_on": { "type": "string", "description": "Modified date", "example": "2014-01-01T05:20:00.12345Z" } } } } }, "developmentMode-body": { "type": "object", "description": "Development mode object", "required": [ "value" ], "properties": { "value": { "type": "string", "description": "On/off value", "enum": [ "on", "off" ], "example": "off" } } }, "enableQueryStringSort-response": { "type": "object", "description": "Sort query string response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "object", "description": "Result of sort query string", "properties": { "id": { "type": "string", "description": "Cache id", "example": "sort_query_string_for_cache" }, "value": { "type": "string", "description": "On/off value", "example": "off" }, "editable": { "type": "boolean", "description": "Editable propery", "example": true }, "modified_on": { "type": "string", "description": "Modified date", "example": "2014-01-01T05:20:00.12345Z" } } } } }, "enableQueryStringSort-body": { "type": "object", "description": "Query string sort enable body", "required": [ "value" ], "properties": { "value": { "type": "string", "description": "On/off property value", "enum": [ "on", "off" ], "example": "off" } } }, "delete_dnsrecord_resp": { "type": "object", "description": "Dns record delete response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "object", "description": "Result", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Dns record id", "example": "f1aba936b94213e5b8dca0c0dbf1f9cc" } } } } }, "list_dnsrecords_resp": { "type": "object", "description": "Dns records list response", "required": [ "success", "errors", "messages", "result", "result_info" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/dnsrecord_list" }, "result_info": { "$ref": "#/components/schemas/result_info" } } }, "dnsrecord_resp": { "type": "object", "description": "Dns record response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/dnsrecord_details" } } }, "dnsrecord_details": { "type": "object", "description": "DNS record details", "properties": { "id": { "type": "string", "description": "DNS record identifier", "example": "f1aba936b94213e5b8dca0c0dbf1f9cc" }, "created_on": { "type": "string", "description": "Created on", "example": "2014-01-01T05:20:00.12345Z" }, "modified_on": { "type": "string", "description": "Modified date", "example": "2014-01-01T05:20:00.12345Z" }, "name": { "type": "string", "description": "DNS record name", "example": "host-1.test-example.com" }, "type": { "type": "string", "description": "DNS record type", "enum": [ "A", "AAAA", "CNAME", "NS", "MX", "TXT", "LOC", "SRV", "PTR", "CAA", "DS" ], "example": "A" }, "content": { "type": "string", "description": "DNS record content", "example": "169.154.10.10" }, "zone_id": { "type": "string", "description": "zone identifier", "example": "023e105f4ecef8ad9ca31a8372d0c353" }, "zone_name": { "type": "string", "description": "zone name", "example": "test-example.com" }, "proxiable": { "type": "boolean", "description": "Proxiable", "example": true }, "proxied": { "type": "boolean", "description": "Proxied", "example": false }, "ttl": { "type": "integer", "description": "DNS record TTL value", "example": 120 }, "priority": { "type": "integer", "description": "Relevant only to MX type records.", "example": 5 }, "data": { "type": "object", "description": "Data details for the DNS record. Only for LOC, SRV, CAA, DS records." } } }, "batch_dns_record_details": { "type": "object", "description": "dns record details as returned by the batch API", "properties": { "id": { "type": "string", "description": "dns record identifier", "example": "f1aba936b94213e5b8dca0c0dbf1f9cc" }, "created_on": { "type": "string", "description": "created on", "example": "2014-01-01T05:20:00.12345Z" }, "modified_on": { "type": "string", "description": "modified date", "example": "2014-01-01T05:20:00.12345Z" }, "name": { "type": "string", "description": "dns record name", "example": "host-1.test-example.com" }, "type": { "type": "string", "description": "dns record type", "enum": [ "A", "AAAA", "CNAME", "NS", "MX", "TXT", "LOC", "SRV", "PTR", "CAA", "DS" ], "example": "A" }, "content": { "type": "string", "description": "dns record content", "example": "1.2.3.4" }, "proxiable": { "type": "boolean", "description": "proxiable", "example": false }, "proxied": { "type": "boolean", "description": "proxied", "example": false }, "ttl": { "type": "integer", "description": "dns record ttl value", "example": 120 }, "priority": { "type": "integer", "description": "Relevant only to MX type records.", "example": 5 }, "data": { "type": "object", "description": "Data details for the DNS record. Only for LOC, SRV, CAA records." }, "settings": { "type": "object", "description": "DNS record settings" }, "meta": { "type": "object", "description": "DNS record metadata" }, "comment": { "type": "string", "description": "Optional comment for the DNS record", "nullable": true }, "comment_modified_on": { "type": "string", "description": "When the comment was last modified", "example": "2024-01-01T05:20:00.12345Z" }, "tags": { "type": "array", "description": "Tags associated with the DNS record", "items": { "type": "string" } }, "tags_modified_on": { "type": "string", "description": "When the tags were last modified", "example": "2025-01-01T05:20:00.12345Z" } } }, "dnsrecord_input": { "type": "object", "description": "DNS record input", "required": [ "type", "name", "content" ], "properties": { "name": { "type": "string", "description": "Required for all record types except SRV.", "example": "host-1.test-example.com" }, "type": { "type": "string", "description": "DNS record type", "enum": [ "A", "AAAA", "CNAME", "NS", "MX", "TXT", "LOC", "SRV", "PTR", "CAA", "DS" ], "example": "A" }, "ttl": { "type": "integer", "description": "DNS record TTL value", "example": 120 }, "content": { "type": "string", "description": "DNS record content", "example": "1.2.3.4" }, "priority": { "type": "integer", "description": "For MX records only", "example": 5 }, "proxied": { "type": "boolean", "description": "proxied", "example": false }, "data": { "type": "object", "description": "For LOC, SRV, CAA, DS records only" } } }, "dnsrecord_update_input": { "type": "object", "description": "DNS record update input", "required": [ "type", "name", "content" ], "properties": { "name": { "type": "string", "description": "Required for all record types except SRV.", "example": "host-1.test-example.com" }, "type": { "type": "string", "description": "DNS record type", "enum": [ "A", "AAAA", "CNAME", "NS", "MX", "TXT", "LOC", "SRV", "PTR", "CAA", "DS" ], "example": "A" }, "ttl": { "type": "integer", "description": "DNS record TTL value", "example": 120 }, "content": { "type": "string", "description": "Content of the DNS record", "example": "1.2.3.4" }, "priority": { "type": "integer", "description": "For MX records only", "example": 5 }, "proxied": { "type": "boolean", "description": "Proxied", "example": false }, "data": { "type": "object", "description": "For LOC, SRV, CAA, DS records only" } } }, "dnsrecord_list": { "type": "array", "description": "DNS record list", "items": { "$ref": "#/components/schemas/dnsrecord_details" } }, "batch_dns_records_request": { "type": "object", "description": "Batch DNS records request. At least one of deletes, patches, puts, or posts must be provided. Operations execute in order: deletes, patches, puts, posts.", "minProperties": 1, "properties": { "deletes": { "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "DNS record ID to delete" } } } }, "patches": { "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "DNS record ID to patch" }, "name": { "type": "string", "description": "Required for all record types except SRV.", "example": "host-1.test-example.com" }, "type": { "type": "string", "description": "dns record type", "enum": [ "A", "AAAA", "CNAME", "NS", "MX", "TXT", "LOC", "SRV", "PTR", "CAA", "DS" ], "example": "A" }, "ttl": { "type": "integer", "description": "dns record ttl value", "example": 120 }, "content": { "type": "string", "description": "content of dns record", "example": "1.2.3.4" }, "priority": { "type": "integer", "description": "For MX records only", "example": 5 }, "proxied": { "type": "boolean", "description": "proxied", "example": false }, "data": { "type": "object", "description": "For LOC, SRV, CAA, DS records only" } } } }, "posts": { "type": "array", "items": { "$ref": "#/components/schemas/dnsrecord_input" } }, "puts": { "type": "array", "items": { "type": "object", "required": [ "id", "type", "name", "content", "ttl" ], "properties": { "id": { "type": "string", "description": "DNS record ID to update" }, "name": { "type": "string", "description": "Required for all record types except SRV.", "example": "host-1.test-example.com" }, "type": { "type": "string", "description": "dns record type", "enum": [ "A", "AAAA", "CNAME", "NS", "MX", "TXT", "LOC", "SRV", "PTR", "CAA", "DS" ], "example": "A" }, "ttl": { "type": "integer", "description": "dns record ttl value", "example": 120 }, "content": { "type": "string", "description": "dns record content", "example": "1.2.3.4" }, "priority": { "type": "integer", "description": "For MX records only", "example": 5 }, "proxied": { "type": "boolean", "description": "proxied", "example": false }, "data": { "type": "object", "description": "For LOC, SRV, CAA, DS records only" } } } } } }, "batch_dns_records_response": { "type": "object", "description": "Batch DNS records response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "type": "boolean", "description": "success response", "example": true }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "object", "properties": { "deletes": { "type": "array", "items": { "$ref": "#/components/schemas/batch_dns_record_details" } }, "patches": { "type": "array", "items": { "$ref": "#/components/schemas/batch_dns_record_details" } }, "posts": { "type": "array", "items": { "$ref": "#/components/schemas/batch_dns_record_details" } }, "puts": { "type": "array", "items": { "$ref": "#/components/schemas/batch_dns_record_details" } } } } } }, "waf-groups-request": { "type": "object", "description": "WAF groups request", "properties": { "mode": { "description": "Whether or not the rules contained within this group are configurable/usable", "type": "string", "example": "on", "default": "on", "enum": [ "on", "off" ] } } }, "waf-groups-response": { "type": "object", "description": "WAF groups response", "required": [ "success", "errors", "messages", "result", "result_info" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "array", "items": { "$ref": "#/components/schemas/waf-rule-properties" } }, "result_info": { "$ref": "#/components/schemas/result_info" } } }, "waf-group-response": { "type": "object", "description": "WAF group response", "required": [ "success", "errors", "messages", "result", "result_info" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/waf-rule-properties" }, "result_info": { "$ref": "#/components/schemas/result_info" } } }, "waf-rule-properties": { "type": "object", "description": "WAF rule properties", "properties": { "id": { "description": "ID", "type": "string", "example": "a25a9a7e9c00afc1fb2e0245519d725b" }, "name": { "description": "Name", "type": "string", "example": "Project Honey Pot" }, "description": { "description": "Description", "type": "string", "example": "Group designed to protect against IP addresses that are a threat and typically used to launch DDoS attacks" }, "rules_count": { "description": "Number of rules", "type": "integer", "example": "10" }, "modified_rules_count": { "description": "Number of modified rules", "type": "integer", "example": "10" }, "package_id": { "description": "Package ID", "type": "string", "example": "a25a9a7e9c00afc1fb2e0245519d725b" }, "mode": { "description": "Mode", "type": "string", "example": "on" }, "allowed_modes": { "description": "Allowed Modes", "type": "array", "items": { "type": "string" } } } }, "custom_pages": { "description": "Custom pages array", "type": "array", "items": { "$ref": "#/components/schemas/custom_page_object" }, "example": [ { "id": "basic_challenge", "description": "Basic Challenge", "required_tokens": [ "::CAPTCHA_BOX::" ], "preview_target": "block:basic-sec-captcha", "created_on": null, "modified_on": null, "url": null, "state": "default" }, { "id": "waf_challenge", "description": "WAF Challenge", "required_tokens": [ "::CAPTCHA_BOX::" ], "preview_target": "block:adv-sec-captcha", "created_on": null, "modified_on": null, "url": null, "state": "default" }, { "id": "waf_block", "description": "WAF Block", "required_tokens": [], "preview_target": "block:waf", "created_on": null, "modified_on": null, "url": null, "state": "default" }, { "id": "ratelimit_block", "description": "Rate limit Block", "required_tokens": [], "preview_target": "block:rate-limit", "created_on": null, "modified_on": null, "url": null, "state": "default" }, { "id": "country_challenge", "description": "Country Challenge", "required_tokens": [ "::CAPTCHA_BOX::" ], "preview_target": "block:country-captcha", "created_on": null, "modified_on": null, "url": null, "state": "default" }, { "id": "ip_block", "description": "IP or IP range block", "required_tokens": [], "preview_target": "block:ip-ban", "created_on": null, "modified_on": null, "url": null, "state": "default" }, { "id": "under_attack", "description": "I'm Under Attack Mode", "required_tokens": [ "::IM_UNDER_ATTACK_BOX::" ], "preview_target": "block:iuam-basic", "created_on": null, "modified_on": null, "url": null, "state": "default" }, { "id": "500_errors", "description": "5XX Errors", "required_tokens": [ "::CLOUDFLARE_ERROR_500S_BOX::" ], "preview_target": "cf-error:500s", "created_on": null, "modified_on": null, "url": null, "state": "default" }, { "id": "1000_errors", "description": "10XX Errors", "required_tokens": [ "::CLOUDFLARE_ERROR_1000S_BOX::" ], "preview_target": "cf-error:1000s", "created_on": null, "modified_on": null, "url": null, "state": "default" }, { "id": "always_online", "description": "Always online", "required_tokens": [ "::ALWAYS_ONLINE_NO_COPY_BOX::" ], "preview_target": "always-online:no-copy", "created_on": null, "modified_on": null, "url": null, "state": "default" } ] }, "list_custom_pages_resp": { "type": "object", "description": "List of custom pages response", "required": [ "success", "errors", "messages", "result", "result_info" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/custom_pages" }, "result_info": { "$ref": "#/components/schemas/result_info" } } }, "url": { "description": "A URL that is associated with the Custom Page", "type": "string", "example": "https://www.example.com/basic_challenge_error.html" }, "state": { "description": "The Custom Page state", "type": "string", "enum": [ "default", "customized" ], "example": "customized" }, "custom_page_request": { "type": "object", "description": "Custom page request", "required": [ "url", "state" ], "properties": { "url": { "$ref": "#/components/schemas/url" }, "state": { "$ref": "#/components/schemas/state" } } }, "page_identifier": { "description": "Custom page identifier", "type": "string", "enum": [ "basic_challenge", "waf_challenge", "waf_block", "ratelimit_block", "country_challenge", "ip_block", "under_attack", "500_errors", "1000_errors", "always_online" ], "example": "basic_challenge" }, "custom_page_object": { "type": "object", "description": "Custom page object", "required": [ "id", "description", "required_tokens", "preview_target", "created_on", "modified_on", "url", "state" ], "properties": { "id": { "$ref": "#/components/schemas/page_identifier" }, "description": { "description": "Description of custom page", "type": "string", "example": "Basic Challenge" }, "required_tokens": { "type": "array", "description": "Array of page tokens", "items": { "type": "string", "enum": [ "::CAPTCHA_BOX::", "::IM_UNDER_ATTACK_BOX::", "::CLOUDFLARE_ERROR_500S_BOX::", "::CLOUDFLARE_ERROR_1000S_BOX::", "::ALWAYS_ONLINE_NO_COPY_BOX::" ], "example": "::CAPTCHA_BOX::" } }, "preview_target": { "description": "Preview target", "type": "string", "example": "block:basic-sec-captcha" }, "created_on": { "description": "Created date", "type": "string", "format": "date-time", "example": "2019-03-28T02:39:06.656Z" }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2019-04-01T07:17:18.358Z" }, "url": { "$ref": "#/components/schemas/url" }, "state": { "$ref": "#/components/schemas/state" } } }, "custom_page_specific_resp": { "type": "object", "description": "Custom page specific response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/custom_page_object" } } }, "security_events": { "type": "object", "description": "Security events objects", "required": [ "result", "result_info", "success", "messages", "errors" ], "properties": { "result": { "description": "Container for response information", "type": "array", "items": { "$ref": "#/components/schemas/security_event_object" } }, "result_info": { "$ref": "#/components/schemas/result_info" }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "security_event_object": { "description": "Security event object", "type": "object", "required": [ "ray_id", "kind", "source", "action", "rule_id", "ip", "ip_class", "country", "colo", "host", "method", "proto", "scheme", "ua", "uri", "matches", "occurred_at" ], "properties": { "ray_id": { "description": "Ray ID of the request", "type": "string", "example": "4c6392789858b224" }, "kind": { "description": "Kind of events. Now it is only firewall.", "type": "string", "enum": [ "firewall" ], "example": "firewall" }, "source": { "description": "Source of the event", "type": "string", "enum": [ "unknown", "asn", "country", "ip", "ipRange", "securityLevel", "zoneLockdown", "waf", "uaBlock", "rateLimit", "firewallRules", "bic", "hot", "l7ddos" ], "example": "rateLimit" }, "action": { "description": "What type of action was taken", "type": "string", "enum": [ "unknown", "allow", "drop", "challenge", "jschallenge", "simulate", "connectionClose", "log" ], "example": "drop" }, "rule_id": { "description": "The ID of the rule that triggered the event, should be considered in the context of source.", "type": "string", "example": "fe38bd35ca284de69b5ecbaa6db87dc3" }, "ip": { "description": "The IPv4 or IPv6 address from which the request originated", "type": "string", "example": "192.168.1.1" }, "ip_class": { "description": "IP class is a map of client IP to visitor classification", "type": "string", "enum": [ "unknown", "clean", "badHost", "searchEngine", "whitelist", "greylist", "monitoringService", "securityScanner", "noRecord", "scan", "backupService", "mobilePlatform", "tor" ], "example": "noRecord" }, "country": { "description": "The 2-digit country code in which the request originated", "type": "string", "example": "CN" }, "colo": { "description": "The 3-letter CF PoP code", "type": "string", "example": "HKG" }, "host": { "description": "The hostname the request attempted to access", "type": "string", "example": "www.example.com" }, "method": { "description": "The HTTP method of the request", "type": "string", "enum": [ "GET", "POST", "DELETE", "PUT", "HEAD", "PURGE", "OPTIONS", "PROPFIND", "MKCOL", "PATCH", "ACL", "BCOPY", "BDELETE", "BMOVE", "BPROPFIND", "BPROPPATCH", "CHECKIN", "CHECKOUT", "CONNECT", "COPY", "LABEL", "LOCK", "MERGE", "MKACTIVITY", "MKWORKSPACE", "MOVE", "NOTIFY", "ORDERPATCH", "POLL", "PROPPATCH", "REPORT", "SEARCH", "SUBSCRIBE", "TRACE", "UNCHECKOUT", "UNLOCK", "UNSUBSCRIBE", "UPDATE", "VERSION-CONTROL", "BASELINE-CONTROL", "X-MS-ENUMATTS", "RPC_OUT_DATA", "RPC_IN_DATA", "JSON", "COOK", "TRACK" ], "example": "GET" }, "proto": { "description": "The protocol of the request", "type": "string", "enum": [ "UNK", "HTTP/1.0", "HTTP/1.1", "HTTP/1.2", "HTTP/2", "SPDY/3.1" ], "example": "HTTP/2" }, "scheme": { "description": "The scheme of the uri", "type": "string", "enum": [ "unknown", "http", "https" ], "example": "https" }, "ua": { "description": "The client user agent that initiated the request", "type": "string", "example": "curl/7.61.1" }, "uri": { "description": "The URI requested from the hostname", "type": "string", "example": "/" }, "occurred_at": { "description": "The time that the event occurred", "type": "string", "format": "date-time", "example": "2019-04-12T07:43:56.000Z" }, "matches": { "description": "The firewall rules those the event matches", "type": "array", "items": { "type": "object", "required": [ "rule_id", "source", "action", "metadata" ], "properties": { "rule_id": { "description": "The ID of the rule that triggered the event, should be considered in the context of source.", "type": "string", "example": "fe38bd35ca284de69b5ecbaa6db87dc3" }, "source": { "description": "Source of the event", "type": "string", "example": "rateLimit" }, "action": { "description": "What type of action was taken", "type": "string", "example": "drop" }, "metadata": { "type": "object", "description": "Metadata", "example": { "ruleSrc": "user" } } } } } } }, "edge_functions_trigger_req": { "type": "object", "description": "Edge functions triiger request", "required": [ "pattern" ], "properties": { "pattern": { "type": "string", "description": "A string pattern", "example": "example.net/*" }, "script": { "type": "string", "description": "Name of the script to apply when the route is matched. The route is skipped when this is blank/missing.", "example": "this-is_my_script-01" } } }, "create_edge_functions_trigger_resp": { "type": "object", "description": "Create an edge funtions trigger response", "properties": { "result": { "$ref": "#/components/schemas/edge_functions_trigger_id" }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "delete_edge_functions_action_resp": { "type": "object", "description": "Create an edge funtions trigger response", "properties": { "result": { "$ref": "#/components/schemas/edge_functions_action_id" }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "list_edge_functions_actions_resp": { "type": "object", "description": "Edge funtions actions response", "properties": { "result": { "$ref": "#/components/schemas/edge_functions_actions_resp" }, "success": { "type": "boolean", "description": "Success", "example": true }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "get_edge_functions_action_resp": { "type": "object", "description": "Edge funtions action response", "properties": { "result": { "$ref": "#/components/schemas/edge_functions_action_resp" }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "edge_functions_actions_resp": { "type": "array", "description": "An array with items in the list response", "items": { "$ref": "#/components/schemas/edge_functions_action_resp" } }, "list_edge_functions_triggers_resp": { "type": "object", "description": "Edge funtions triggers response", "properties": { "result": { "$ref": "#/components/schemas/edge_functions_triggers_resp" }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "get_edge_functions_trigger_resp": { "type": "object", "description": "Edge funtions trigger response", "properties": { "result": { "$ref": "#/components/schemas/edge_functions_trigger_resp" }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "edge_functions_triggers_resp": { "type": "array", "description": "An array with items in the list response", "items": { "$ref": "#/components/schemas/edge_functions_trigger_resp" } }, "edge_functions_trigger_resp": { "type": "object", "description": "Edge function trigger ID", "properties": { "id": { "type": "string", "description": "Edge functions trigger identifier tag", "example": "9a7806061c88ada191ed06f989cc3dac" }, "pattern": { "type": "string", "description": "A string pattern", "example": "example.net/*" }, "script": { "type": "string", "description": "Name of the script to apply when the route is matched. The route is skipped when this is blank/missing.", "example": "this-is_my_script-01" }, "request_limit_fail_open": { "type": "boolean", "description": "Request limit fail open or not.", "example": false } } }, "edge_functions_trigger_id": { "type": "object", "description": "Edge function trigger id", "properties": { "id": { "type": "string", "description": "Edge functions trigger identifier tag", "example": "9a7806061c88ada191ed06f989cc3dac" } } }, "edge_functions_action_id": { "type": "object", "description": "Edge function action id", "properties": { "id": { "type": "string", "description": "Edge functions action identifier tag", "example": "9a7806061c88ada191ed06f989cc3dac" } } }, "edge_functions_action_resp": { "type": "object", "description": "Edge function script", "properties": { "script": { "type": "string", "description": "Raw script content, as a string", "example": "addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })" }, "etag": { "type": "string", "description": "Hashed script content, can be used in a If-None-Match header when updating", "example": "ea95132c15732412d22c1476fa83f27a" }, "handlers": { "type": "array", "description": "Handlers", "items": { "type": "string", "example": "fetch" } }, "modified_on": { "type": "string", "format": "date-time", "description": "The time when the script was last modified", "example": "2100-01-01T05:20:00Z" }, "created_on": { "type": "string", "format": "date-time", "description": "The time when the script was last created", "example": "2100-01-01T05:20:00Z" }, "routes": { "type": "array", "description": "An array with items in the list response", "items": { "$ref": "#/components/schemas/edge_functions_trigger_resp" } } } }, "range_app_req": { "required": [ "dns", "protocol" ], "type": "object", "description": "Range application request", "properties": { "protocol": { "type": "string", "description": "Defines the protocol (and optionally port) for this application. The currently supported protocols are `tcp`, `udp`, `ssh`, `rdp`, and `minecraft`.", "example": "tcp/22" }, "dns": { "type": "object", "properties": { "type": { "type": "string", "description": "DNS record type", "example": "CNAME" }, "name": { "type": "string", "description": "DNS record name", "example": "ssh.example.com" } }, "description": "Name and type of the DNS record for this application" }, "origin_direct": { "type": "array", "description": "IP address and port of the origin for this Range application. If configuring a load balancer, use\\ \\ 'origin_dns' and 'origin_port'. This cannot be combined with 'origin_dns' and 'origin_port'.", "example": [ "tcp://192.0.2.1:22" ], "items": { "type": "string" } }, "origin_dns": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the origin.", "example": "origin.net" } }, "description": "DNS record pointing to the origin for this Range application. This is used for configuring a load\\ \\ balancer. When specifying an individual IP address, use 'origin_direct'. This requires 'origin_port' and\\ \\ cannot be combined with 'origin_direct'." }, "origin_port": { "type": "integer", "description": "Port at the origin that listens to traffic from this Range application. Requires 'origin_dns' and\\ \\ cannot be combined with 'origin_direct'.", "example": 22 }, "ip_firewall": { "type": "boolean", "description": "Enables the IP Firewall for this application. Only available for TCP applications.", "example": true }, "proxy_protocol": { "type": "string", "description": "Allows for the true client IP to be passed to the service", "default": "off", "enum": [ "off", "v1", "v2", "simple" ] }, "edge_ips": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of edge IP configuration.", "enum": [ "dynamic" ] }, "connectivity": { "type": "string", "description": "Specifies the IP version (or all)", "example": "all", "enum": [ "ipv4", "ipv6", "all" ] } }, "description": "Configures IP version for the hostname of this application. Default is {\\\"type\\\":\\\"dynamic\\\", \\\"connectivity\\\"\\ :\\\"all\\\"}." }, "traffic_type": { "type": "string", "description": "Configure how traffic is handled at the edge. If set to \"direct\" traffic is passed through to the service. In the case of \"http\" or \"https\" HTTP/s features at the edge are applied ot this traffic.", "default": "direct", "enum": [ "direct", "http", "https" ] }, "tls": { "type": "string", "description": "Configure if and how TLS connections are terminated at the edge.", "default": "off", "enum": [ "off", "flexible", "full", "strict" ] } } }, "range_applications": { "required": [ "errors", "messages", "result", "success" ], "type": "object", "description": "Range application", "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "array", "description": "Container for Range application objects", "items": { "$ref": "#/components/schemas/range_application_object" } } } }, "range_application_resp": { "required": [ "errors", "messages", "result", "success" ], "type": "object", "description": "Range application response", "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/range_application_object" } } }, "range_application_object": { "type": "object", "description": "Range application object", "properties": { "id": { "type": "string", "description": "Application identifier", "example": "ea95132c15732412d22c1476fa83f27a" }, "protocol": { "type": "string", "description": "Protocol and port configuration", "example": "tcp/22" }, "dns": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of DNS record associated with the application.", "enum": [ "CNAME" ] }, "name": { "type": "string", "description": "The name of the DNS record associated with the application.", "example": "ssh.example.com" } }, "description": "The name and type of DNS record for the Range application" }, "origin_direct": { "type": "array", "description": "A list of destination addresses to the origin.", "items": { "type": "string", "description": "Destination origin URI" } }, "ip_firewall": { "type": "boolean", "description": "Enables the IP Firewall for this application.", "example": true }, "proxy_protocol": { "type": "string", "description": "Allows for the true client IP to be passed to the service", "example": "v1", "enum": [ "off", "v1", "v2", "simple" ] }, "edge_ips": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of edge IP configuration.", "enum": [ "dynamic" ] }, "connectivity": { "type": "string", "description": "Specifies the IP version (or all)", "enum": [ "ipv4", "ipv6", "all" ] } }, "description": "Configures IP version for the hostname of this application." }, "tls": { "type": "string", "description": "Specifies the TLS termination at the edge.", "example": "flexible", "enum": [ "off", "flexible", "full", "strict" ] }, "traffic_type": { "type": "string", "description": "Configure how traffic is handled at the edge. If set to \"direct\" traffic is passed through to the service. In the case of \"http\" or \"https\" HTTP/s features at the edge are applied ot this traffic.", "example": "direct", "enum": [ "direct", "http", "https" ] }, "created_on": { "type": "string", "description": "When the Application was created.", "format": "date-time", "example": "2019-01-02T02:20:00.000Z" }, "modified_on": { "type": "string", "description": "When the Application was last modified.", "format": "date-time", "example": "2019-01-02T02:20:00.000Z" } } }, "range_application_delete": { "type": "object", "description": "Range application delete response", "properties": { "id": { "type": "string", "description": "Application identifier", "example": "ea95132c15732412d22c1476fa83f27a" } } }, "certificate": { "type": "object", "description": "Certificate", "required": [ "id", "hosts", "status" ], "properties": { "id": { "type": "object", "description": "Identifier", "example": "436627" }, "hosts": { "$ref": "#/components/schemas/hostnames" }, "status": { "type": "string", "description": "Status", "example": "active" } } }, "certificate_req": { "type": "object", "description": "Certificate request", "required": [ "type", "hosts" ], "properties": { "type": { "type": "string", "description": "Priorities", "enum": [ "dedicated" ], "example": "dedicated" }, "hosts": { "$ref": "#/components/schemas/hostnames" } } }, "custom_cert_req": { "type": "object", "description": "Custom certificate request", "required": [ "certificate", "private_key" ], "properties": { "certificate": { "type": "string", "description": "Certificates" }, "private_key": { "type": "string", "description": "Private key" }, "bundle_method": { "type": "string", "enum": [ "ubiquitous", "optimal", "force" ], "example": "ubiquitous", "description": "Methods shown in UI mapping to API: Compatible(ubiquitous), Modern(optimal), User Defined(force)" }, "geo_restrictions": { "type": "object", "description": "Geo restrictions", "required": [ "label" ], "properties": { "label": { "type": "string", "description": "Properties", "enum": [ "us", "eu", "highest_security" ], "example": "us" } } } } }, "cert_priority_req": { "type": "object", "description": "Certificate priority request", "required": [ "certificates" ], "properties": { "certificates": { "type": "array", "description": "Certificates array", "items": { "type": "object", "description": "Certificate items", "required": [ "id", "priority" ], "properties": { "id": { "type": "string", "description": "Identifier", "example": "5a7805061c76ada191ed06f989cc3dac" }, "priority": { "type": "integer", "description": "Certificate priority", "example": 1 } } } } } }, "universal_cert_toggle_req": { "type": "object", "description": "Universal certificate toggle request", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Enabled", "example": true } } }, "tls_1_2_setting_req": { "type": "object", "description": "TLS 1.2 setting request", "required": [ "value" ], "properties": { "value": { "type": "string", "description": "Value", "enum": [ "on", "off" ], "example": "on" } } }, "tls_1_3_setting_req": { "type": "object", "description": "TLS 1.3 setting request", "required": [ "value" ], "properties": { "value": { "type": "string", "description": "Value", "enum": [ "on", "off" ], "example": "on" } } }, "dedicated_certificate_resp": { "type": "object", "description": "Certificate response", "required": [ "result", "result_info", "success", "errors", "messages" ], "properties": { "result": { "$ref": "#/components/schemas/dedicated_certificate_pack" }, "result_info": { "$ref": "#/components/schemas/result_info" }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "list_certificate_resp": { "type": "object", "description": "Certificate response", "required": [ "result", "result_info", "success", "errors", "messages" ], "properties": { "result": { "$ref": "#/components/schemas/certificate_packs" }, "result_info": { "$ref": "#/components/schemas/result_info" }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "list_custom_certs_resp": { "type": "object", "description": "Custom certificate response", "required": [ "result", "result_info", "success", "errors", "messages" ], "properties": { "result": { "$ref": "#/components/schemas/custom_certificate_packs" }, "result_info": { "$ref": "#/components/schemas/result_info" }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "custom_cert_resp": { "type": "object", "description": "Custom certificate response", "required": [ "result", "success", "errors", "messages" ], "properties": { "result": { "$ref": "#/components/schemas/custom_cert_pack" }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "universal_setting_resp": { "type": "object", "description": "Universal setting response", "required": [ "result", "success", "errors", "messages" ], "properties": { "result": { "type": "object", "description": "Result", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Enabled", "example": true } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "tls_1_2_setting_resp": { "type": "object", "description": "TLS 1.2 setting response", "required": [ "result", "success", "errors", "messages" ], "properties": { "result": { "type": "object", "description": "Result", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "type": "string", "description": "Identifier", "enum": [ "tls_1_2_only" ] }, "value": { "type": "string", "description": "Value", "example": "on" }, "editable": { "type": "boolean", "description": "Editable", "example": true }, "modified_on": { "type": "string", "description": "Modified date", "format": "date-time", "example": "2014-01-01T05:20:00.12345Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "tls_1_3_setting_resp": { "type": "object", "description": "TLS 1.3 setting response", "required": [ "result", "success", "errors", "messages" ], "properties": { "result": { "type": "object", "description": "Result", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "type": "string", "description": "Identifier", "enum": [ "tls_1_3" ] }, "value": { "type": "string", "description": "Value", "example": "on" }, "editable": { "type": "boolean", "description": "Editable", "example": true }, "modified_on": { "type": "string", "description": "Modified date", "format": "date-time", "example": "2014-01-01T05:20:00.12345Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "hostnames": { "type": "array", "description": "Host name", "items": { "type": "string", "example": "example.com" } }, "dedicated_certificate_pack": { "type": "object", "description": "Dedicated certificate packs", "required": [ "id", "type", "hosts", "certificates", "primary_certificate", "status" ], "properties": { "id": { "type": "string", "description": "Identifier", "example": "0f405ba2-8c18-49eb-a30b-28b85427780f" }, "type": { "type": "string", "description": "Certificate type, the `dedicated` and `dedicated_custom` are deprecated; use `advanced`.\"", "example": "advanced" }, "hosts": { "$ref": "#/components/schemas/hostnames" }, "certificates": { "type": "array", "description": "Certificates", "items": { "$ref": "#/components/schemas/certificate" } }, "primary_certificate": { "type": "object", "description": "Primary certificate", "example": 0 }, "status": { "type": "string", "example": "active", "description": "Status" } } }, "custom_certificate_packs": { "type": "array", "description": "Custom certificate packs", "items": { "$ref": "#/components/schemas/custom_cert_pack" } }, "custom_cert_pack": { "type": "object", "description": "Custom certificate pack", "required": [ "id", "hosts", "issuer", "signature", "status", "bundle_method", "zone_id", "uploaded_on", "modified_on", "expires_on", "priority" ], "properties": { "id": { "type": "string", "description": "Identifier", "example": "0f405ba2-8c18-49eb-a30b-28b85427780f" }, "hosts": { "$ref": "#/components/schemas/hostnames" }, "issuer": { "type": "string", "description": "Issuer", "example": "/Country=US/Organization=Lets Encrypt/CommonName=Lets Encrypt Authority X3" }, "signature": { "type": "string", "description": "Signature", "example": "SHA256WithRSA" }, "status": { "type": "string", "example": "active", "description": "Status" }, "bundle_method": { "type": "string", "description": "Bundle method" }, "zone_id": { "type": "string", "description": "zone identifier" }, "uploaded_on": { "type": "string", "description": "Uploaded date" }, "modified_on": { "type": "string", "description": "Modified date" }, "expires_on": { "type": "string", "description": "Expire date" }, "priority": { "type": "number", "description": "Priority" } } }, "total_tls_req": { "type": "object", "description": "Total TLS request", "required": [ "enabled", "certificate_authority" ], "properties": { "enabled": { "type": "boolean", "description": "Enabled/disabled", "example": true }, "certificate_authority": { "type": "string", "description": "Certificate authority value", "enum": [ "lets_encrypt", "google", "ssl_com" ], "example": "google" } } }, "total_tls_resp": { "type": "object", "description": "Total TLS response", "required": [ "success", "result", "errors", "messages" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "result": { "$ref": "#/components/schemas/total_tls" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "total_tls": { "type": "object", "description": "Total TLS", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "enabled": { "type": "boolean", "description": "Enabled/disabled", "example": true }, "certificate_authority": { "type": "string", "description": "Certificate authority value", "enum": [ "lets_encrypt", "google", "ssl_com" ], "example": "google" } } }, "ssl_setting_req": { "type": "object", "description": "SSL setting request", "required": [ "value" ], "properties": { "value": { "type": "string", "description": "Value", "enum": [ "off", "flexible", "full", "strict" ], "example": "off" } } }, "ssl_setting_resp": { "type": "object", "description": "SSL setting response", "required": [ "success", "result", "errors", "messages" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "result": { "$ref": "#/components/schemas/ssl_setting" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "ssl_setting": { "type": "object", "description": "SSL setting", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "type": "string", "description": "Identifier", "example": "ssl" }, "value": { "type": "string", "description": "Value", "example": "off" }, "editable": { "type": "boolean", "description": "Editable", "example": true }, "modified_on": { "type": "string", "description": "Modified date", "example": "2017-01-01T05:20:00.12345Z" } } }, "certificate_packs": { "type": "array", "description": "Certificate packs", "items": { "$ref": "#/components/schemas/dedicated_certificate_pack" } }, "list_access_certs_resp": { "description": "List access certificate response", "type": "object", "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/cert_result" } } } }, "cert_result": { "description": "Access certificate details", "type": "object", "properties": { "id": { "description": "Access certificate ID", "type": "string", "example": "21a41336-9001-42c4-8440-c79e0cb86e1f" }, "name": { "description": "Access certificate name", "type": "string", "example": "test-cert" }, "fingerprint": { "description": "Fingerprint of the certificate", "type": "string", "example": "MD5 Fingerprint=38:38:B4:FB:3C:33:CE:2C:8E:8E:D1:1B:94:70:C1:5F" }, "associated_hostnames": { "$ref": "#/components/schemas/associated_hostnames" }, "created_at": { "description": "Created time of the access certificate", "type": "string", "example": "2021-04-19T11:09:11Z" }, "updated_at": { "description": "Updated time of the access certificate", "type": "string", "example": "2021-04-19T11:09:11Z" }, "expires_on": { "description": "Expire time of the access certificate", "type": "string", "example": "2026-04-18T06:26:00Z" } } }, "access_cert_resp": { "description": "Access certificate response", "type": "object", "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/cert_result" } } }, "delete_access_cert_resp": { "description": "Delete access certificate response", "type": "object", "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "object", "properties": { "id": { "description": "Certificate ID", "type": "string", "example": "21a41336-9001-42c4-8440-c79e0cb86e1f" } } } } }, "access_cert_input": { "description": "Create access certificate request", "type": "object", "required": [ "name", "certificate" ], "properties": { "name": { "description": "Access certificate name", "type": "string", "example": "test-cert" }, "certificate": { "description": "Access certificate", "type": "string", "example": "-----BEGIN CERTIFICATE-----\nMIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10\nDrUtmu/B\n-----END CERTIFICATE-----" }, "associated_hostnames": { "$ref": "#/components/schemas/associated_hostnames" } } }, "associated_hostnames": { "description": "The hostnames that are prompted for this certificate", "type": "array", "items": { "type": "string", "format": "hostname", "example": "test.example.com" } }, "update_access_cert_input": { "description": "Update access certificate request", "type": "object", "required": [ "name", "certificate" ], "properties": { "name": { "description": "Access certificate name", "type": "string", "example": "test-cert" }, "associated_hostnames": { "$ref": "#/components/schemas/associated_hostnames" } } }, "list_access_apps_resp": { "description": "List access applications response", "type": "object", "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/app_result" } } } }, "app_result": { "description": "Access application details", "type": "object", "properties": { "id": { "description": "Application ID", "type": "string", "example": "de4526d6-d125-4f95-906f-1757510a9cd8" }, "name": { "description": "Application name", "type": "string", "example": "mtls-test-app" }, "domain": { "description": "The domain and path that Access blocks", "type": "string", "example": "test.example.com" }, "aud": { "type": "string", "example": "f8e1744453ea3679d919fdc6db58cff648f2b14b33a729f780fc02e75a42a008" }, "policies": { "description": "Policies of the application", "type": "array", "items": { "$ref": "#/components/schemas/policy_result" } }, "allowed_idps": { "description": "The identity providers selected for application", "type": "array", "items": { "type": "string", "example": "699d98642c564d2e855e9661899b7252" } }, "auto_redirect_to_identity": { "description": "Option to skip identity provider selection if only one is configured in allowed_idps.", "type": "boolean", "example": false }, "session_duration": { "description": "The amount of time that the tokens issued for this application are valid.", "type": "string", "example": "24h" }, "type": { "description": "Application type", "type": "string", "example": "self_hosted" }, "uid": { "description": "UUID, same as ID", "type": "string", "example": "de4526d6-d125-4f95-906f-1757510a9cd8" }, "created_at": { "description": "Created time of the application", "type": "string", "example": "2021-04-19T07:59:49Z" }, "updated_at": { "description": "Updated time of the application", "type": "string", "example": "2021-04-19T07:59:49Z" } } }, "access_app_resp": { "description": "Access application response", "type": "object", "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/app_result" } } }, "create_access_app_resp": { "description": "Create access application response", "type": "object", "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Access application details", "type": "object", "properties": { "id": { "type": "string", "example": "de4526d6-d125-4f95-906f-1757510a9cd8" }, "name": { "type": "string", "example": "mtls-test-app" }, "domain": { "type": "string", "example": "test.example.com" }, "aud": { "type": "string", "example": "f8e1744453ea3679d919fdc6db58cff648f2b14b33a729f780fc02e75a42a008" }, "policies": { "type": "array", "items": { "type": "object" }, "example": [] }, "allowed_idps": { "type": "array", "items": { "type": "string" }, "example": [] }, "auto_redirect_to_identity": { "type": "boolean", "example": false }, "session_duration": { "type": "string", "example": "24h" }, "type": { "type": "string", "example": "self_hosted" }, "uid": { "type": "string", "example": "de4526d6-d125-4f95-906f-1757510a9cd8" }, "created_at": { "type": "string", "example": "2021-04-19T07:59:49Z" }, "updated_at": { "type": "string", "example": "2021-04-19T07:59:49Z" } } } } }, "delete_access_app_resp": { "description": "Delete access application response", "type": "object", "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "object", "properties": { "id": { "description": "Application ID", "type": "string", "example": "de4526d6-d125-4f95-906f-1757510a9cd8" } } } } }, "access_app_input": { "description": "Create access application request", "type": "object", "required": [ "name", "domain" ], "properties": { "name": { "description": "Application name", "type": "string", "example": "mtls-test-app" }, "domain": { "description": "The domain and path that Access blocks", "type": "string", "example": "test.example.com" }, "session_duration": { "description": "The amount of time that the tokens issued for this application are valid.", "type": "string", "enum": [ "30m", "6h", "12h", "24h", "168h", "730h" ], "example": "24h" } } }, "list_access_policies_resp": { "description": "List access policies response", "type": "object", "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/policy_result" } } } }, "policy_result": { "description": "Access policies information", "type": "object", "properties": { "id": { "description": "Policy ID", "type": "string", "example": "acabcdb1-afb3-4f61-9dae-d1a353a93661" }, "name": { "description": "Policy name", "type": "string", "example": "mtls-test-policy" }, "decision": { "description": "The action Access takes if the policy matches the user", "type": "string", "example": "non_identity" }, "include": { "description": "The include policy works like an OR logical operator", "type": "array", "items": { "$ref": "#/components/schemas/policy_rule" } }, "exclude": { "description": "The exclude policy works like a NOT logical operator", "type": "array", "items": { "$ref": "#/components/schemas/policy_rule" }, "example": [] }, "precedence": { "description": "The unique precedence for policies on a single application", "type": "integer", "example": 1 }, "require": { "description": "The require policy works like a AND logical operator", "type": "array", "items": { "$ref": "#/components/schemas/policy_rule" }, "example": [] }, "uid": { "description": "UUID, same as ID", "type": "string", "example": "acabcdb1-afb3-4f61-9dae-d1a353a93661" }, "created_at": { "description": "Created time of the policy", "type": "string", "example": "2021-04-19T08:01:21Z" }, "updated_at": { "description": "Updated time of the policy", "type": "string", "example": "2021-04-19T08:01:21Z" } } }, "access_policy_resp": { "description": "Access policy response", "type": "object", "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/policy_result" } } }, "delete_access_policy_resp": { "description": "Delete access policy response", "type": "object", "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "object", "properties": { "id": { "description": "Policy ID", "type": "string", "example": "acabcdb1-afb3-4f61-9dae-d1a353a93661" } } } } }, "access_policy_input": { "description": "Create/update policy request", "type": "object", "required": [ "name", "decision", "include" ], "properties": { "name": { "description": "Policy name", "type": "string", "example": "mtls-test-policy" }, "decision": { "description": "Defines the action Access takes if the policy matches the user", "type": "string", "enum": [ "non_identity" ], "example": "non_identity" }, "include": { "description": "The include policy works like an OR logical operator. The user must satisfy one of the rules in includes.", "type": "array", "items": { "$ref": "#/components/schemas/policy_rule" } } } }, "policy_rule": { "description": "Policy rule", "oneOf": [ { "$ref": "#/components/schemas/policy_cert_rule" }, { "$ref": "#/components/schemas/policy_cn_rule" } ] }, "policy_cert_rule": { "description": "Policy rule of certificate", "type": "object", "properties": { "certificate": { "type": "object", "example": {} } } }, "policy_cn_rule": { "description": "Policy rule of common name", "type": "object", "required": [ "common_name" ], "properties": { "common_name": { "type": "object", "required": [ "common_name" ], "properties": { "common_name": { "description": "Common name of client certificate", "type": "string", "example": "Access Testing CA" } } } } }, "access_cert_settings_resp": { "description": "Access certificates settings response", "type": "object", "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/cert_settings_result" } } } }, "cert_settings_result": { "type": "object", "properties": { "hostname": { "type": "string", "format": "hostname", "example": "test.example.com" }, "china_network": { "type": "boolean", "example": false }, "client_certificate_forwarding": { "type": "boolean", "example": true } } }, "access_cert_settings_input": { "description": "Access certificates settings request", "type": "object", "required": [ "hostname", "client_certificate_forwarding" ], "properties": { "hostname": { "type": "string", "format": "hostname", "example": "test.example.com" }, "client_certificate_forwarding": { "description": "Whether to forward the client certificate", "type": "boolean", "example": true } } }, "filter_object": { "type": "object", "required": [ "id", "paused", "description", "expression", "created_on", "modified_on" ], "properties": { "id": { "description": "Identifier of the filter", "type": "string", "example": "6f58318e7fa2477a23112e8118c66f61" }, "paused": { "description": "Indicates if the filter is active.", "type": "boolean", "example": true }, "description": { "description": "To briefly describe the filter, omitted from object if empty.", "type": "string", "example": "Login from office" }, "expression": { "description": "A filter expression.", "type": "string", "example": "ip.src eq 93.184.216.0 and (http.request.uri.path ~ \\\\\"^.*/wp-login.php$\\\\\" or http.request.uri.path ~ \\\\\"^.*/xmlrpc.php$\\\\\")" }, "created_on": { "description": "The creation date-time of the filter.", "type": "string", "format": "dateTime", "example": "2018-01-01T05:20:00.123Z" }, "modified_on": { "description": "The modification date-time of the filter.", "type": "string", "format": "dateTime", "example": "2018-01-01T05:20:00.123Z" } } }, "delete_filters_resp": { "type": "object", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "description": "Identifier of the filter", "type": "string", "example": "b7ff25282d394be7b945e23c7106ce8a" } } } } } }, "delete_filter_resp": { "type": "object", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "object", "required": [ "id" ], "properties": { "id": { "description": "Identifier of the filter", "type": "string", "example": "b7ff25282d394be7b945e23c7106ce8a" } } } } }, "list_filters_resp": { "type": "object", "required": [ "success", "errors", "messages", "result", "result_info" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "array", "items": { "$ref": "#/components/schemas/filter_object" } }, "result_info": { "$ref": "#/components/schemas/result_info" } } }, "filter_resp": { "type": "object", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/filter_object" } } }, "filters_resp": { "type": "object", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "array", "items": { "$ref": "#/components/schemas/filter_object" } } } }, "filters_input": { "type": "array", "items": { "$ref": "#/components/schemas/filter_input" } }, "filter_input": { "description": "JSON objects which are used to create filters.", "type": "object", "required": [ "expression" ], "properties": { "expression": { "type": "string", "description": "A filter expression", "example": "not http.request.uri.path matches \"^/api/.*$\"" }, "paused": { "description": "Indicates if the filter is active.", "type": "boolean", "example": false }, "description": { "type": "string", "description": "To briefly describe the filter, omitted from object if empty.", "example": "not /api" } } }, "filters_update_input": { "type": "array", "items": { "$ref": "#/components/schemas/filter_update_input" } }, "filter_update_input": { "type": "object", "required": [ "id", "expression" ], "properties": { "id": { "type": "string", "description": "Identifier of the filter", "example": "f2a64520581a4209aab12187a0081364" }, "expression": { "description": "A filter expression.", "type": "string", "example": "not http.request.uri.path matches \"^/api/.*$\"" }, "description": { "description": "To briefly describe the filter.", "type": "string", "example": "not /api" }, "paused": { "description": "Indicates if the filter is active.", "type": "boolean", "example": false } } }, "firewall_rule_object": { "type": "object", "required": [ "id", "paused", "description", "action", "filter", "created_on", "modified_on" ], "properties": { "id": { "description": "Identifier of the firewall rule", "type": "string", "example": "52161eb6af4241bb9d4b32394be72fdf" }, "paused": { "description": "Indicates if the firewall rule is active.", "type": "boolean", "example": false }, "description": { "description": "To briefly describe the firewall rule, omitted from object if empty.", "type": "string", "example": "JS challenge site" }, "action": { "description": "The firewall action to perform, \"log\" action is only available for enterprise plan instances.", "type": "string", "enum": [ "log", "allow", "challenge", "js_challenge", "block" ], "example": "js_challenge" }, "filter": { "description": "An existing filter", "type": "object", "required": [ "id", "paused", "description", "expression", "created_on", "modified_on" ], "properties": { "id": { "description": "Identifier of the filter", "type": "string", "example": "6f58318e7fa2477a23112e8118c66f61" }, "paused": { "description": "Indicates if the filter is active.", "type": "boolean", "example": true }, "description": { "description": "To briefly describe the filter, omitted from object if empty.", "type": "string", "example": "Login from office" }, "expression": { "description": "A filter expression.", "type": "string", "example": "ip.src eq 93.184.216.0 and (http.request.uri.path ~ \\\\\"^.*/wp-login.php$\\\\\" or http.request.uri.path ~ \\\\\"^.*/xmlrpc.php$\\\\\")" } } }, "created_on": { "description": "The creation date-time of the filter.", "type": "string", "format": "dateTime", "example": "2019-01-01T05:20:00.123Z" }, "modified_on": { "description": "The modification date-time of the filter.", "type": "string", "format": "dateTime", "example": "2019-01-01T05:20:00.123Z" } } }, "delete_firewall_rules_resp": { "type": "object", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "description": "Identifier of firewall rules", "type": "string", "example": "f2d427378e7542acb295380d352e2ebd" } } } } } }, "delete_firewall_rule_resp": { "type": "object", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "object", "required": [ "id" ], "properties": { "id": { "description": "Identifier of the firewall rule", "type": "string", "example": "f2d427378e7542acb295380d352e2ebd" } } } } }, "list_firewall_rules_resp": { "type": "object", "required": [ "success", "errors", "messages", "result", "result_info" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "array", "items": { "$ref": "#/components/schemas/firewall_rule_object" } }, "result_info": { "$ref": "#/components/schemas/result_info" } } }, "firewall_rule_resp": { "type": "object", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/firewall_rule_object" } } }, "firewall_rules_resp": { "type": "object", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "array", "items": { "$ref": "#/components/schemas/firewall_rule_object" } } } }, "firewall_rules_input_with_filter_id": { "type": "array", "items": { "$ref": "#/components/schemas/firewall_rule_input_with_filter_id" } }, "firewall_rules_input_without_filter_id": { "type": "array", "items": { "$ref": "#/components/schemas/firewall_rule_input_without_filter_id" } }, "firewall_rule_input_with_filter_id": { "description": "JSON objects which are used to create firewall rule.", "type": "object", "required": [ "filter", "action" ], "properties": { "filter": { "description": "An existing filter", "type": "object", "required": [ "id" ], "properties": { "id": { "description": "Identifier of the filter", "type": "string", "example": "6f58318e7fa2477a23112e8118c66f61" } } }, "action": { "description": "The firewall action to perform, \"log\" action is only available for enterprise plan instances.", "type": "string", "enum": [ "log", "allow", "challenge", "js_challenge", "block" ], "example": "js_challenge" }, "description": { "description": "To briefly describe the firewall rule, omitted from object if empty.", "type": "string", "example": "JS challenge site" } } }, "firewall_rule_input_without_filter_id": { "description": "JSON objects which are used to create firewall rule.", "type": "object", "required": [ "expression" ], "properties": { "expression": { "type": "string", "description": "A filter expression", "example": "not http.request.uri.path matches \"^/api/.*$\"" }, "paused": { "description": "Indicates if the filter is active.", "type": "boolean", "example": false }, "description": { "type": "string", "description": "To briefly describe the filter, omitted from object if empty.", "example": "not /api" } } }, "firewall_rules_update_input": { "type": "array", "items": { "type": "object", "required": [ "id", "action" ], "properties": { "id": { "type": "string", "description": "Identifier of the firewall rule", "example": "52161eb6af4241bb9d4b32394be72fdf" }, "action": { "description": "The firewall action to perform, \"log\" action is only available for enterprise plan instances", "type": "string", "enum": [ "log", "allow", "challenge", "js_challenge", "block" ], "example": "js_challenge" }, "paused": { "description": "Indicates if the firewall rule is active.", "type": "boolean", "example": false }, "description": { "description": "To briefly describe the firewall rule, omitted from object if empty.", "type": "string", "example": "JS challenge site" }, "filter": { "description": "An existing filter", "type": "object", "required": [ "id" ], "properties": { "id": { "description": "Identifier of the filter", "type": "string", "example": "6f58318e7fa2477a23112e8118c66f61" } } } } } }, "firewall_rule_update_input": { "type": "object", "required": [ "action" ], "properties": { "action": { "description": "The firewall action to perform, \"log\" action is only available for enterprise plan instances.", "type": "string", "enum": [ "log", "allow", "challenge", "js_challenge", "block" ], "example": "js_challenge" }, "paused": { "description": "Indicates if the firewall rule is active.", "type": "boolean", "example": false }, "description": { "description": "To briefly describe the firewall rule, omitted from object if empty.", "type": "string", "example": "JS challenge site" }, "filter": { "description": "An existing filter", "type": "object", "required": [ "id" ], "properties": { "id": { "description": "Identifier of the filter", "type": "string", "example": "6f58318e7fa2477a23112e8118c66f61" } } } } }, "list_alert_policies_resp": { "type": "object", "description": "List Alert Policies Response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "array", "items": { "type": "object", "required": [ "id", "name", "description", "enabled", "alert_type", "mechanisms", "created", "modified", "conditions", "filters" ], "properties": { "id": { "description": "Policy ID", "type": "string", "example": "f0413b106d2c4aa9b1553d5d0209c522" }, "name": { "description": "Policy Name", "type": "string", "example": "My Alert Policy" }, "description": { "description": "Alert Policy description", "type": "string", "example": "Description for my alert policy" }, "enabled": { "description": "Is the alert enabled", "type": "boolean", "example": true }, "alert_type": { "type": "string", "description": "Condition for the alert", "enum": [ "dos_attack_l7", "g6_pool_toggle_alert", "clickhouse_alert_fw_anomaly", "clickhouse_alert_fw_ent_anomaly", "universal_ssl_event_type", "dedicated_ssl_certificate_event_type", "health_check_status_notification", "web_analytics_metrics_update", "maintenance_event_notification" ], "example": "dos_attack_l7" }, "mechanisms": { "type": "object", "description": "Delivery mechanisms for the alert, can include an email, a webhook, or both", "properties": { "email": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } } }, "example": [ { "id": "mynotifications@email.com" } ] }, "webhooks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } } }, "example": [ { "id": "f0413b106d2c4aa9b1553d5d0209c522" } ] } } }, "created": { "type": "string", "description": "When was the policy first created", "example": "2021-09-15T16:33:31.834209Z" }, "modified": { "type": "string", "description": "When was the policy last modified", "example": "2021-09-15T16:33:31.834209Z" }, "conditions": { "description": "Optional conditions depending for the alert type", "type": "object" }, "filters": { "description": "Optional filters depending for the alert type", "type": "object" } } } } } }, "get_alert_policy_resp": { "type": "object", "description": "Get Alert Policies Response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "object", "required": [ "id", "name", "description", "enabled", "alert_type", "mechanisms", "created", "modified", "conditions", "filters" ], "properties": { "id": { "description": "Policy ID", "type": "string", "example": "f0413b106d2c4aa9b1553d5d0209c522" }, "name": { "description": "Policy Name", "type": "string", "example": "My Alert Policy" }, "description": { "description": "Alert Policy description", "type": "string", "example": "Description for my alert policy" }, "enabled": { "description": "Is the alert enabled", "type": "boolean", "example": true }, "alert_type": { "type": "string", "description": "Condition for the alert", "enum": [ "dos_attack_l7", "g6_pool_toggle_alert", "clickhouse_alert_fw_anomaly", "clickhouse_alert_fw_ent_anomaly", "universal_ssl_event_type", "dedicated_ssl_certificate_event_type", "health_check_status_notification", "web_analytics_metrics_update", "maintenance_event_notification" ], "example": "dos_attack_l7" }, "mechanisms": { "type": "object", "description": "Delivery mechanisms for the alert, can include an email, a webhook, or both", "properties": { "email": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } } }, "example": [ { "id": "mynotifications@email.com" } ] }, "webhooks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } } }, "example": [ { "id": "f0413b106d2c4aa9b1553d5d0209c522" } ] } } }, "created": { "type": "string", "description": "When was the policy first created", "example": "2021-09-15T16:33:31.834209Z" }, "modified": { "type": "string", "description": "When was the policy last modified", "example": "2021-09-15T16:33:31.834209Z" }, "conditions": { "description": "Optional conditions depending for the alert type", "type": "object" }, "filters": { "description": "Optional filters depending for the alert type", "type": "object" } } } } }, "alert_success_resp": { "type": "object", "description": "Alert Policies Response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "object", "required": [ "id" ], "properties": { "id": { "description": "Policy ID", "type": "string", "example": "f0413b106d2c4aa9b1553d5d0209c522" } } } } }, "create_alert_policy_input": { "type": "object", "description": "Create alert policy input", "required": [ "name", "enabled", "alert_type", "mechanisms" ], "properties": { "name": { "description": "Policy name", "type": "string", "example": "My Alert Policy" }, "description": { "description": "Policy description", "type": "string", "example": "A description for my alert policy" }, "enabled": { "type": "boolean", "description": "Is the alert policy active", "example": true }, "alert_type": { "type": "string", "description": "Condition for the alert", "enum": [ "dos_attack_l7", "g6_pool_toggle_alert", "clickhouse_alert_fw_anomaly", "clickhouse_alert_fw_ent_anomaly", "universal_ssl_event_type", "dedicated_ssl_certificate_event_type", "health_check_status_notification", "web_analytics_metrics_update", "maintenance_event_notification" ], "example": "dos_attack_l7" }, "mechanisms": { "type": "object", "description": "Delivery mechanisms for the alert", "properties": { "email": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } } }, "example": [ { "id": "mynotifications@email.com" } ] }, "webhooks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } } }, "example": [ { "id": "f0413b106d2c4aa9b1553d5d0209c522" } ] } } }, "filters": { "description": "Optional filters depending for the alert type", "type": "object" }, "conditions": { "type": "object", "description": "Conditions depending on the alert type. HTTP DDOS Attack Alerter does not have any conditions. The Load Balancing Pool Enablement Alerter takes conditions that describe for all pools whether the pool is being enabled, disabled, or both. This field is not required when creating a new alert.", "example": {} } } }, "update_alert_policy_input": { "type": "object", "description": "Update alert policy input", "required": [ "name", "enabled", "alert_type", "mechanisms", "conditions" ], "properties": { "name": { "description": "Policy name", "type": "string", "example": "My Alert Policy" }, "description": { "description": "Policy description", "type": "string", "example": "A description for my alert policy" }, "enabled": { "type": "boolean", "description": "Is the alert policy active", "example": true }, "alert_type": { "type": "string", "description": "Condition for the alert. Use 'dos_attack_l7' to set up an HTTP DDOS Attack Alerter, use 'g6_pool_toggle_alert' to set up Load Balancing Pool Enablement Alerter, use 'clickhouse_alert_fw_anomaly' to set up WAF Alerter and 'clickhouse_alert_fw_ent_anomaly' to set up Advanced Security Alerter", "enum": [ "dos_attack_l7", "g6_pool_toggle_alert", "clickhouse_alert_fw_anomaly", "clickhouse_alert_fw_ent_anomaly", "universal_ssl_event_type", "dedicated_ssl_certificate_event_type", "health_check_status_notification", "web_analytics_metrics_update", "maintenance_event_notification" ], "example": "dos_attack_l7" }, "mechanisms": { "type": "object", "description": "Delivery mechanisms for the alert, can include an email, a webhook, or both", "properties": { "email": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } } }, "example": [ { "id": "mynotifications@email.com" } ] }, "webhooks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } } }, "example": [ { "id": "f0413b106d2c4aa9b1553d5d0209c522" } ] } } }, "conditions": { "type": "object", "description": "Conditions depending on the alert type. HTTP DDOS Attack Alerter does not have any conditions. The Load Balancing Pool Enablement Alerter takes conditions that describe for all pools whether the pool is being enabled, disabled, or both.", "example": {} }, "filters": { "description": "Optional filters depending for the alert type. HTTP DDOS Attack Alerter does not require any filters. The Load Balancing Pool Enablement Alerter requires a list of IDs for the pools and their corresponding alert trigger (set whether alerts are recieved on disablement, enablement, or both). The basic WAF Alerter requires a list of zones to be monitored. The Advanced Security Alerter requires a list of zones to be monitored as well as a list of services to monitor.", "type": "object" } } }, "test_alert_policy_input": { "type": "object", "description": "Test alert policy input", "example": {} }, "test_alert_success_resp": { "type": "object", "description": "Test alert policy response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "boolean", "example": true } } }, "list_alert_webhooks_resp": { "type": "object", "description": "List Alert Webhooks Response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "array", "items": { "type": "object", "required": [ "id", "name", "url", "type", "created_at", "last_success", "last_failure" ], "properties": { "id": { "description": "Webhook ID", "type": "string", "example": "6d16fcab-3e80-44b3-b59b-a3716237832e" }, "name": { "description": "Webhook Name", "type": "string", "example": "My Slack Alert Webhook" }, "url": { "description": "Webhook url", "type": "string", "example": "https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd" }, "type": { "type": "string", "description": "Webhook type", "example": "generic" }, "created_at": { "type": "string", "description": "When was the webhook created", "example": "2021-09-15T16:33:31.834209Z" }, "last_success": { "type": "string", "description": "When was the webhook last used successfully", "example": "2021-09-15T16:33:31.834209Z" }, "last_failure": { "type": "string", "description": "When was the webhook last used and failed", "example": "2021-09-15T16:33:31.834209Z" } } } } } }, "get_alert_webhook_resp": { "type": "object", "description": "Get Alert Webhooks Response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "object", "required": [ "id", "name", "url", "type", "created_at", "last_success", "last_failure" ], "properties": { "id": { "description": "Webhook ID", "type": "string", "example": "6d16fcab-3e80-44b3-b59b-a3716237832e" }, "name": { "description": "Webhook Name", "type": "string", "example": "My Slack Alert Webhook" }, "url": { "description": "Webhook url", "type": "string", "example": "https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd" }, "type": { "type": "string", "description": "Webhook type", "example": "generic" }, "created_at": { "type": "string", "description": "When was the webhook created", "example": "2021-09-15T16:33:31.834209Z" }, "last_success": { "type": "string", "description": "When was the webhook last used successfully", "example": "2021-09-15T16:33:31.834209Z" }, "last_failure": { "type": "string", "description": "When was the webhook last used and failed", "example": "2021-09-15T16:33:31.834209Z" } } } } }, "webhook_success_resp": { "type": "object", "description": "Alert Webhooks Response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "object", "required": [ "id" ], "properties": { "id": { "description": "Webhook ID", "type": "string", "example": "6d16fcab-3e80-44b3-b59b-a3716237832e" } } } } }, "proxy_read_timeout_resp": { "type": "object", "description": "Proxy read timeout response", "required": [ "success", "result", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "object", "required": [ "id", "value", "editable", "modified_on" ], "properties": { "id": { "description": "ID", "type": "string", "example": "proxy_read_timeout" }, "value": { "description": "Value", "type": "number", "example": 100 }, "editable": { "description": "Editable", "type": "boolean", "example": true }, "modified_on": { "description": "Modified date", "type": "string", "format": "date-time", "example": "2018-12-08T18:57:52.826Z" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "alert_webhook_input": { "type": "object", "description": "Create alert webhook input", "required": [ "name", "url" ], "properties": { "name": { "description": "Webhook Name", "type": "string", "example": "My Slack Alert Webhook" }, "url": { "description": "Webhook url", "type": "string", "example": "https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd" }, "secret": { "description": "The optional secret or API key needed to use the webhook", "type": "string", "example": "ff1d9b80-b51d-4a06-bf67-6752fae1eb74" } } }, "list_logpush_jobs_resp": { "type": "object", "description": "List Logpush Jobs Response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/logpush_job_result" } } }, "ownership_challenge_resp": { "type": "object", "description": "Get Logpush Ownership Challenge Response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/ownership_challenge_result" } } }, "ownership_challenge_validate_resp": { "type": "object", "description": "Get Logpush Ownership Challenge Response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/ownership_challenge_validate_result" } } }, "logpush_jobs_resp": { "type": "object", "description": "Logpush job response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/logpush_job_pack" } } }, "list_fields_resp": { "type": "object", "description": "List fields response.", "required": [ "success", "errors", "messages" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "object", "description": "Result", "example": {} } } }, "logpush_jobs_req": { "type": "object", "description": "Create logpush job input.", "required": [ "destination_conf", "ownership_challenge" ], "properties": { "name": { "description": "Logpush job name", "type": "string", "example": "My log push job" }, "enabled": { "description": "Indicates whether the logpush job is enabled or not.", "type": "boolean", "example": false }, "logpull_options": { "description": "Configuration string", "type": "string", "example": "fields=RayID,CacheResponseBytes×tamps=rfc3339" }, "destination_conf": { "description": "Uniquely identifies a resource (such as an s3 bucket) where the data will be pushed.", "type": "string", "example": "cos://cos-bucket001?region=us-south&instance-id=231f5467-3072-4cb9-9e39-a906fa3032ea" }, "ownership_challenge": { "description": "Ownership challenge token to prove destination ownership.", "type": "string", "example": "00000000000000000000000000000000" }, "dataset": { "description": "Dataset to be pulled.", "type": "string", "enum": [ "http_requests", "range_events", "firewall_events", "dns_logs" ], "example": "firewall_events" }, "frequency": { "description": "The frequency at which CIS sends batches of logs to your destination.", "type": "string", "enum": [ "high", "low" ], "example": "high" } } }, "logpush_job_cos_req": { "type": "object", "description": "Create COS logpush job input.", "required": [ "cos", "ownership_challenge" ], "properties": { "name": { "description": "Logpush job name", "type": "string", "example": "My log push job" }, "enabled": { "description": "Indicates whether the logpush job is enabled or not.", "type": "boolean", "example": false }, "logpull_options": { "description": "Configuration string", "type": "string", "example": "fields=RayID,CacheResponseBytes×tamps=rfc3339" }, "cos": { "description": "Information to identify the COS bucket where the data will be pushed.", "type": "object", "example": { "bucket_name": "cos-bucket001", "region": "us-south", "id": "231f5467-3072-4cb9-9e39-a906fa3032ea" } }, "ownership_challenge": { "description": "Ownership challenge token to prove destination ownership.", "type": "string", "example": "00000000000000000000000000000000" }, "dataset": { "description": "Dataset to be pulled.", "type": "string", "enum": [ "http_requests", "range_events", "firewall_events", "dns_logs" ], "example": "http_requests" }, "frequency": { "description": "The frequency at which CIS sends batches of logs to your destination.", "type": "string", "enum": [ "high", "low" ], "example": "high" } } }, "log_retention_resp": { "type": "object", "description": "Log retention result", "properties": { "result": { "type": "object", "properties": { "flag": { "type": "boolean", "example": true } } }, "success": { "type": "boolean", "description": "Success response", "example": true }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "log_retention_req": { "type": "object", "required": [ "flag" ], "properties": { "flag": { "type": "boolean", "example": false } } }, "logs_rayid_resp": { "type": "object", "description": "Logs RayID Response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "type": "boolean", "description": "Success response", "example": true }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "array", "description": "Array of log events matching the RayID", "items": { "$ref": "#/components/schemas/log_event" } } } }, "log_event": { "type": "object", "description": "Log event data", "properties": { "RayID": { "type": "string", "description": "Unique identifier for the request", "example": "7e8b4c5d6f7a8b9c" }, "ClientIP": { "type": "string", "description": "Client IP address", "example": "192.0.2.1" }, "EdgeStartTimestamp": { "type": "string", "description": "Timestamp when the edge received the request", "example": "2026-01-15T10:30:00Z" }, "EdgeEndTimestamp": { "type": "string", "description": "Timestamp when the edge finished processing the request", "example": "2026-01-15T10:30:01Z" }, "ClientRequestHost": { "type": "string", "description": "Host header from the client request", "example": "example.com" }, "ClientRequestMethod": { "type": "string", "description": "HTTP method of the client request", "example": "GET" }, "ClientRequestURI": { "type": "string", "description": "URI of the client request", "example": "/v1/status" }, "EdgeResponseStatus": { "type": "integer", "description": "HTTP status code returned by the edge", "example": 200 }, "EdgeResponseBytes": { "type": "integer", "description": "Number of bytes returned by the edge", "example": 1234 }, "ClientASN": { "type": "integer", "description": "Client autonomous system number", "example": 15169 }, "ClientCountry": { "type": "string", "description": "Two-letter country code of the client", "example": "US" } } }, "logpush_job_logdna_req": { "type": "object", "description": "Create LogDNA logpush job input.", "required": [ "logdna" ], "properties": { "name": { "description": "Logpush job name", "type": "string", "example": "My log push job" }, "enabled": { "description": "Indicates whether the logpush job is enabled or not.", "type": "boolean", "example": false }, "logpull_options": { "description": "Configuration string", "type": "string", "example": "fields=RayID,CacheResponseBytes×tamps=rfc3339" }, "logdna": { "description": "Information to identify the LogDNA instance the data will be pushed.", "type": "object", "example": { "ingress_key": "8aef12bcd5e5af42", "region": "us-south", "hostname": "www.example.com" } }, "dataset": { "description": "Dataset to be pulled.", "type": "string", "enum": [ "http_requests", "range_events", "firewall_events", "dns_logs" ], "example": "http_requests" }, "frequency": { "description": "The frequency at which CIS sends batches of logs to your destination.", "type": "string", "enum": [ "high", "low" ], "example": "high" } } }, "logpush_job_ibmcl_req": { "type": "object", "description": "Create IBM Cloud Logs logpush job input.", "required": [ "ibmcl" ], "properties": { "name": { "description": "Logpush job name", "type": "string", "example": "My log push job" }, "enabled": { "description": "Indicates whether the logpush job is enabled or not.", "type": "boolean", "example": false }, "logpull_options": { "description": "Configuration string", "type": "string", "example": "fields=RayID,CacheResponseBytes×tamps=rfc3339" }, "ibmcl": { "description": "Required information to push logs to your IBM Cloud Logs instance.", "required": [ "instance_id", "region", "api_key" ], "type": "object", "properties": { "instance_id": { "description": "GUID of the IBM Cloud Logs instance where you want to send logs.", "type": "string", "example": "90d208cc-e1dd-4fb2-a938-358e5996f056" }, "region": { "description": "Region where the IBM Cloud Logs instance is located.", "type": "string", "example": "eu-es" }, "api_key": { "description": "IBM Cloud API key used to generate a token for pushing to your IBM Cloud Logs instance.", "type": "string", "example": "XXXXXXXXXXXXXX" } } }, "ibmcl_names": { "type": "object", "description": "Create custom application and subsystem names.", "properties": { "application_name": { "description": "Name of application to be used.", "type": "string", "example": "cis-edge-logs" }, "subsystem_name": { "description": "Name of subsystem to be used.", "type": "string", "example": "prod-firewall-logs" } } }, "dataset": { "description": "Dataset to be pulled.", "type": "string", "enum": [ "http_requests", "range_events", "firewall_events", "dns_logs" ], "example": "http_requests" }, "frequency": { "description": "The frequency at which CIS sends batches of logs to your destination.", "type": "string", "enum": [ "high", "low" ], "example": "high" } } }, "logpush_job_splunk_req": { "type": "object", "description": "Create Splunk logpush job input", "required": [ "splunk" ], "properties": { "name": { "description": "Logpush job name", "type": "string", "example": "My log push job" }, "enabled": { "description": "Indicates whether the logpush job is enabled or not.", "type": "boolean", "example": false }, "logpull_options": { "description": "Configuration string", "type": "string", "example": "fields=RayID,CacheResponseBytes×tamps=rfc3339" }, "splunk": { "description": "Required information to push logs to Splunk.", "required": [ "endpoint_url", "channel_id", "skip_verify", "source_type", "auth_token" ], "type": "object", "properties": { "endpoint_url": { "description": "The Splunk raw HTTP Event Collector URL with port.", "type": "string", "example": "splunk.cis-analytics.com:8088/services/collector/raw" }, "channel_id": { "description": "A unique channel ID. This is a random GUID that you can generate.", "type": "string", "example": "def3c136-7a01-4655-b17f-8e25a780ef2c" }, "skip_verify": { "description": "Push logs even if verification of server's certificate fails. Certificates generated by Splunk/third-party certificates should have the Common Name field in the certificate match the Splunk server’s domain name.", "type": "boolean", "example": false }, "source_type": { "description": "The Splunk source type", "example": "cloudflare:json" }, "auth_token": { "description": "The Splunk authorization token", "example": "Splunk fake3585-0f38-4d62-8b43-c4b78584fake" } } }, "dataset": { "description": "Dataset to be pulled.", "type": "string", "enum": [ "http_requests", "range_events", "firewall_events", "dns_logs" ], "example": "http_requests" }, "frequency": { "description": "The frequency at which CIS sends batches of logs to your destination.", "type": "string", "enum": [ "high", "low" ], "example": "high" } } }, "logpush_job_generic_req": { "type": "object", "description": "Create logpush job for a generic destination.", "required": [ "destination_conf" ], "properties": { "name": { "description": "Logpush job name", "type": "string", "example": "My log push job" }, "enabled": { "description": "Indicates whether the logpush job is enabled or not.", "type": "boolean", "example": false }, "logpull_options": { "description": "Configuration string", "type": "string", "example": "timestamps=rfc3339×tamps=rfc3339" }, "destination_conf": { "description": "Uniquely identifies a resource where data will be pushed. Additional configuration parameters supported by the destination can be included.", "example": "https://logs.example.com?header_Authorization=Basic%20REDACTED", "type": "string" }, "dataset": { "description": "Dataset to be pulled", "type": "string", "enum": [ "http_requests", "range_events", "firewall_events", "dns_logs" ], "example": "http_requests" }, "frequency": { "description": "The frequency at which CIS sends batches of logs to your destination.", "type": "string", "enum": [ "high", "low" ], "example": "high" } } }, "logpush_jobs_update_req": { "type": "object", "description": "Update logpush job input", "properties": { "enabled": { "description": "Indicates whether the logpush job is enabled or not.", "type": "boolean", "example": false }, "logpull_options": { "description": "Configuration string", "type": "string", "example": "fields=RayID,CacheResponseBytes×tamps=rfc3339" }, "destination_conf": { "description": "Uniquely identifies a resource (such as an s3 bucket) where the data will be pushed.", "type": "string", "example": "cos://cos-bucket001?region=us-south&instance-id=231f5467-3072-4cb9-9e39-a906fa3032ea" }, "ownership_challenge": { "description": "Ownership challenge token to prove destination ownership.", "type": "string", "example": "00000000000000000000000000000000" }, "frequency": { "description": "The frequency at which CIS sends batches of logs to your destination.", "type": "string", "enum": [ "high", "low" ], "example": "high" } } }, "logpush_jobs_update_cos_req": { "type": "object", "description": "Update COS logpush job input", "properties": { "enabled": { "description": "Indicates whether the logpush job is enabled or not.", "type": "boolean", "example": false }, "logpull_options": { "description": "Configuration string", "type": "string", "example": "fields=RayID,CacheResponseBytes×tamps=rfc3339" }, "cos": { "description": "Information to identify the COS bucket where the data will be pushed.", "type": "object", "example": { "bucket_name": "cos-bucket001", "region": "us-south", "id": "231f5467-3072-4cb9-9e39-a906fa3032ea" } }, "ownership_challenge": { "description": "Ownership challenge token to prove destination ownership.", "type": "string", "example": "00000000000000000000000000000000" }, "frequency": { "description": "The frequency at which CIS sends batches of logs to your destination.", "type": "string", "enum": [ "high", "low" ], "example": "high" } } }, "logpush_jobs_update_logdna_req": { "type": "object", "description": "Update LogDNA logpush job input.", "properties": { "enabled": { "description": "Indicates whether the logpush job is enabled or not.", "type": "boolean", "example": false }, "logpull_options": { "description": "Configuration string", "type": "string", "example": "fields=RayID,CacheResponseBytes×tamps=rfc3339" }, "logdna": { "description": "Information to identify the LogDNA instance where the data will be pushed.", "type": "object", "example": { "ingress_key": "8aef12bcd5e5af42", "region": "us-south", "hostname": "www.example.com" } }, "frequency": { "description": "The frequency at which CIS sends batches of logs to your destination.", "type": "string", "enum": [ "high", "low" ], "example": "high" } } }, "logpush_jobs_update_ibmcl_req": { "type": "object", "description": "Update IBM Cloud Logs logpush job input.", "properties": { "enabled": { "description": "Indicates whether the logpush job is enabled or not.", "type": "boolean", "example": false }, "logpull_options": { "description": "Configuration string", "type": "string", "example": "fields=RayID,CacheResponseBytes×tamps=rfc3339" }, "ibmcl": { "description": "Required information to push logs to your IBM Cloud Logs instance.", "type": "object", "properties": { "instance_id": { "description": "GUID of the IBM Cloud Logs instance where you want to send logs.", "type": "string", "example": "90d208cc-e1dd-4fb2-a938-358e5996f056" }, "region": { "description": "Region where the IBM Cloud Logs instance is located.", "type": "string", "example": "eu-es" }, "api_key": { "description": "IBM Cloud API key used to generate a token for pushing to your IBM Cloud Logs instance.", "type": "string", "example": "XXXXXXXXXXXXXX" } } }, "ibmcl_names": { "type": "object", "description": "Create custom application and subsystem names.", "properties": { "application_name": { "description": "Name of application to be used.", "type": "string", "example": "cis-edge-logs" }, "subsystem_name": { "description": "Name of subsystem to be used.", "type": "string", "example": "prod-firewall-logs" } } }, "frequency": { "description": "The frequency at which CIS sends batches of logs to your destination.", "type": "string", "enum": [ "high", "low" ], "example": "high" } } }, "logpush_jobs_update_splunk_req": { "type": "object", "description": "Update Splunk logpush job input", "properties": { "name": { "description": "Logpush job name", "type": "string", "example": "My log push job" }, "enabled": { "description": "Indicates whether the logpush job is enabled or not.", "type": "boolean", "example": false }, "logpull_options": { "description": "Configuration string", "type": "string", "example": "fields=RayID,CacheResponseBytes×tamps=rfc3339" }, "splunk": { "description": "Required information to push logs to Splunk.", "required": [ "endpoint_url", "channel_id", "skip_verify", "source_type", "auth_token" ], "type": "object", "properties": { "endpoint_url": { "description": "The Splunk raw HTTP Event Collector URL with port.", "type": "string", "example": "splunk.cis-analytics.com:8088/services/collector/raw" }, "channel_id": { "description": "A unique channel ID. This is a random GUID that you can generate.", "type": "string", "example": "def3c136-7a01-4655-b17f-8e25a780ef2c" }, "skip_verify": { "description": "Push logs even if verification of server's certificate fails. Certificates generated by Splunk/third-party certificates should have the Common Name field in the certificate match the Splunk server’s domain name.", "type": "boolean", "example": false }, "source_type": { "description": "The Splunk source type", "example": "cloudflare:json" }, "auth_token": { "description": "The Splunk authorization token", "example": "Splunk fake3585-0f38-4d62-8b43-c4b78584fake" } } }, "dataset": { "description": "Dataset to be pulled", "type": "string", "enum": [ "http_requests", "range_events", "firewall_events", "dns_logs" ], "example": "http_requests" }, "frequency": { "description": "The frequency at which CIS sends batches of logs to your destination.", "type": "string", "enum": [ "high", "low" ], "example": "high" } } }, "logpush_jobs_update_generic_req": { "type": "object", "description": "Create logpush job for a generic destination.", "properties": { "name": { "description": "Logpush job name", "type": "string", "example": "My log push job" }, "enabled": { "description": "Indicates whether the logpush job is enabled or not.", "type": "boolean", "example": false }, "logpull_options": { "description": "Configuration string", "type": "string", "example": "timestamps=rfc3339×tamps=rfc3339" }, "destination_conf": { "description": "Uniquely identifies a resource where data will be pushed. Additional configuration parameters supported by the destination can be included.", "example": "https://logs.example.com?header_Authorization=Basic%20REDACTED", "type": "string" }, "dataset": { "description": "Dataset to be pulled", "type": "string", "enum": [ "http_requests", "range_events", "firewall_events", "dns_logs" ], "example": "http_requests" }, "frequency": { "description": "The frequency at which CIS sends batches of logs to your destination.", "type": "string", "enum": [ "high", "low" ], "example": "high" } } }, "logpush_ownership_req": { "type": "object", "description": "Get Ownership Challenge", "properties": { "destination_conf": { "description": "Uniquely identifies a resource (such as an s3 bucket) where the data will be pushed.", "type": "string", "example": "cos://cos-bucket001?region=us-south&instance-id=231f5467-3072-4cb9-9e39-a906fa3032ea" } } }, "logpush_ownership_cos_req": { "type": "object", "description": "Send Ownership Challenge for COS instance logpush job.", "properties": { "cos": { "description": "Information to identify the COS bucket where the data will be pushed.", "type": "object", "example": { "bucket_name": "cos-bucket001", "region": "us-south", "id": "231f5467-3072-4cb9-9e39-a906fa3032ea" } } } }, "ownership_validate_req": { "type": "object", "description": "Validate Ownership Challenge", "properties": { "destination_conf": { "description": "Uniquely identifies a resource (such as an s3 bucket) where the data will be pushed.", "type": "string", "example": "cos://cos-bucket001?region=us-south&instance-id=231f5467-3072-4cb9-9e39-a906fa3032ea" }, "ownership_challenge": { "description": "Ownership challenge token to prove destination ownership.", "type": "string", "example": "00000000000000000000" } } }, "ownership_validate_cos_req": { "type": "object", "description": "Validate Ownership Challenge to a COS instance logpush job.", "properties": { "cos": { "description": "Information to identify the COS bucket where the data will be pushed.", "type": "object", "example": { "bucket_name": "cos-bucket001", "region": "us-south", "id": "231f5467-3072-4cb9-9e39-a906fa3032ea" } }, "ownership_challenge": { "description": "Ownership challenge token to prove destination ownership.", "type": "string", "example": "00000000000000000000" } } }, "logpush_job_result": { "type": "array", "description": "Result", "items": { "$ref": "#/components/schemas/logpush_job_pack" } }, "logpush_job_pack": { "type": "object", "description": "Logpush job pack", "required": [ "id", "enabled", "name", "dataset", "frequency", "logpull_options", "destination_conf" ], "properties": { "id": { "description": "Logpush job ID", "type": "integer", "example": 5850 }, "name": { "description": "Logpush job name", "type": "string", "example": "My log push job" }, "enabled": { "description": "Indicates whether the logpush job is enabled or not.", "type": "boolean", "example": false }, "dataset": { "description": "Dataset to be pulled.", "type": "string", "example": "firewall_events" }, "frequency": { "description": "The frequency at which CIS sends batches of logs to your destination.", "type": "string", "example": "high" }, "logpull_options": { "description": "Configuration string", "type": "string", "example": "timestamps=rfc3339×tamps=rfc3339" }, "destination_conf": { "description": "Uniquely identifies a resource (such as an s3 bucket) where the data will be pushed.", "type": "string", "example": "cos://cos-bucket001?region=us-south&instance-id=231f5467-3072-4cb9-9e39-a906fa3032ea" }, "last_complete": { "type": "string", "nullable": true, "description": "Records the last time that logs were successfully pushed.", "example": "2022-01-15T16:33:31.834209Z" }, "last_error": { "type": "string", "nullable": true, "description": "Records the last time the job failed.", "example": "2022-01-15T16:33:31.834209Z" }, "error_message": { "type": "string", "nullable": true, "description": "The last failure.", "example": null } } }, "delete_logpush_job_resp": { "type": "object", "description": "Delete logpush job response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "object", "description": "Result" } } }, "ownership_challenge_result": { "type": "object", "description": "Ownership Challenge result", "required": [ "filename", "valid", "message" ], "properties": { "filename": { "description": "File name", "type": "string", "example": "logs/challenge-filename.txt" }, "valid": { "description": "Valid", "type": "boolean", "example": true }, "messages": { "description": "Message", "type": "string", "example": "" } } }, "ownership_challenge_validate_result": { "type": "object", "description": "Ownership Challenge validate result", "required": [ "valid" ], "properties": { "valid": { "description": "Valid", "type": "boolean", "example": true } } }, "advanced_cert_req": { "type": "object", "description": "Certificate request", "required": [ "type", "hosts", "validation_method", "validity_days", "certificate_authority" ], "properties": { "type": { "type": "string", "description": "Certificate type", "enum": [ "advanced" ], "example": "advanced" }, "hosts": { "$ref": "#/components/schemas/hostnames" }, "validation_method": { "type": "string", "description": "Validation Method selected for the order.", "enum": [ "txt", "http", "email" ], "example": "txt" }, "validity_days": { "type": "integer", "description": "Validity Days selected for the order.", "enum": [ 14, 30, 90, 365 ], "example": 90 }, "certificate_authority": { "type": "string", "description": "Certificate Authority selected for the order. Selecting Let's Encrypt reduces customization of other fields: validation_method must be 'txt', validity_days must be 90, `cloudflare_branding` must be omitted, and hosts must contain only 2 entries, one for the zone name and one for the subdomain wildcard of the zone name (for example, example.com, *.example.com).", "enum": [ "lets_encrypt", "google", "ssl_com" ], "example": "lets_encrypt" }, "cloudflare_branding": { "type": "boolean", "description": "Indicates whether or not to add Cloudflare Branding for the order. This will add sni.cloudflaressl.com as the Common Name if set to `true`.", "example": false } } }, "advanced_cert_init_resp": { "type": "object", "description": "Certificate response", "required": [ "result", "success", "errors", "messages" ], "properties": { "result": { "type": "object", "description": "Result of ordering advanced certificate pack", "properties": { "id": { "type": "string", "description": "Advanced certificate pack ID", "example": "a58ceb22-f3c8-422c-a2b0-5787381007c5" }, "type": { "type": "string", "description": "Certificate type", "example": "advanced" }, "hosts": { "$ref": "#/components/schemas/hostnames" }, "validation_method": { "type": "string", "description": "Validation Method selected for the order.", "example": "txt" }, "validity_days": { "type": "integer", "description": "Validity Days selected for the order.", "example": 90 }, "certificate_authority": { "type": "string", "description": "Certificate Authority selected for the order.", "example": "lets_encrypt" }, "cloudflare_branding": { "type": "boolean", "description": "Whether or not to add Cloudflare branding for the order.", "example": false }, "status": { "type": "string", "description": "Certificate status", "example": "initializing" } } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "ssl_verification_resp": { "type": "object", "description": "SSL verification response", "required": [ "result", "success", "errors", "messages" ], "properties": { "result": { "type": "array", "description": "SSL verification result", "items": { "$ref": "#/components/schemas/ssl_verification_info" } }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "ssl_verification_info": { "description": "SSL verification details", "type": "object", "properties": { "certificate_status": { "type": "string", "description": "Current status of certificate", "example": "active" }, "validation_method": { "type": "string", "description": "Validation method in use for a certificate pack order", "example": "txt" }, "verification_type": { "type": "string", "description": "Method of certificate verification", "example": "cname" }, "cert_pack_uuid": { "type": "string", "description": "Certificate pack identifier", "example": "a77f8bd7-3b47-46b4-a6f1-75cf98109948" }, "verification_status": { "type": "boolean", "description": "Status of the required verification information", "example": true }, "verification_info": { "type": "object", "description": "Certificate's required verification information", "properties": { "record_name": { "type": "string", "description": "Name of CNAME record", "example": "b3b90cfedd89a3e487d3e383c56c4267.example.com" }, "record_target": { "type": "string", "description": "Target of CNAME record", "example": "6979be7e4cfc9e5c603e31df7efac9cc60fee82d.comodoca.com" } } }, "brand_check": { "type": "boolean", "description": "Whether or not Certificate Authority is manually reviewing the order", "example": false } } }, "origin_certificate_req": { "type": "object", "description": "Origin certificate request", "required": [ "hostnames", "request_type" ], "properties": { "hostnames": { "description": "Array of hostnames or wildcard names (for example, *.example.com) bound to the certificate", "type": "array", "items": { "type": "string", "example": "example.com" } }, "request_type": { "description": "Signature type desired on certificate", "type": "string", "enum": [ "origin-rsa", "origin-ecc" ], "example": "origin-rsa" }, "requested_validity": { "description": "The number of days that the certificate should be valid.", "type": "integer", "enum": [ 7, 30, 90, 365, 730, 1095, 5475 ], "example": 5475 }, "csr": { "description": "The Certificate Signing Request (CSR)", "type": "string", "example": "-----BEGIN CERTIFICATE REQUEST-----\n...\n-----END CERTIFICATE REQUEST-----" } } }, "list_origin_certificates_resp": { "type": "object", "description": "Response of list origin certificates", "required": [ "result", "result_info", "success", "errors", "messages" ], "properties": { "result": { "description": "Container for response information", "type": "array", "items": { "$ref": "#/components/schemas/origin_certificate" } }, "result_info": { "$ref": "#/components/schemas/result_info" }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "origin_certificate_resp": { "type": "object", "description": "Response of origin certificate", "required": [ "result", "success", "errors", "messages" ], "properties": { "result": { "$ref": "#/components/schemas/origin_certificate" }, "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "origin_certificate": { "type": "object", "description": "Origin certificate", "required": [ "id", "certificate", "hostnames", "expires_on", "request_type", "requested_validity", "csr" ], "properties": { "id": { "description": "ID", "type": "string", "example": 3664634374038616000 }, "certificate": { "description": "A CIS-signed certificate", "type": "string", "example": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----" }, "hostnames": { "description": "Array of hostnames or wildcard names (for example, *.example.com) bound to the certificate", "type": "array", "items": { "type": "string", "example": "example.com" } }, "expires_on": { "description": "The expiration date for this certificate", "type": "string", "example": "2014-01-01T05:20:00.12345Z" }, "request_type": { "description": "Signature type desired on certificate", "type": "string", "enum": [ "origin-rsa", "origin-ecc" ], "example": "origin-rsa" }, "requested_validity": { "description": "The number of days that the certificate should be valid.", "type": "integer", "enum": [ 7, 30, 90, 365, 730, 1095, 5475 ], "example": 5475 }, "csr": { "description": "The Certificate Signing Request (CSR)", "type": "string", "example": "-----BEGIN CERTIFICATE REQUEST-----\n...\n-----END CERTIFICATE REQUEST-----" }, "private_key": { "description": "The private key", "type": "string", "example": "-----BEGIN EC PRIVATE KEY-----\n...\n-----END EC PRIVATE KEY----- \n" } } }, "revoke_origin_certificate_resp": { "type": "object", "description": "Response of revoke origin certificate", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "object", "required": [ "id" ], "properties": { "id": { "description": "ID", "type": "string", "example": "3664634374038615934" } } } } }, "ruleset_kind": { "type": "string", "enum": [ "managed", "custom", "root", "zone" ] }, "ruleset_phase": { "type": "string", "description": "The phase of the ruleset.", "enum": [ "ddos_l4", "ddos_l7", "http_config_settings", "http_custom_errors", "http_log_custom_fields", "http_ratelimit", "http_request_cache_settings", "http_request_dynamic_redirect", "http_request_firewall_custom", "http_request_firewall_managed", "http_request_late_transform", "http_request_origin", "http_request_redirect", "http_request_sanitize", "http_request_sbfm", "http_request_select_configuration", "http_request_transform", "http_response_compression", "http_response_firewall_managed", "http_response_headers_transform" ] }, "ruleset_create": { "type": "object", "required": [ "description", "kind", "name", "phase" ], "properties": { "description": { "type": "string", "description": "Description of the ruleset", "example": "Custom instance ruleset" }, "kind": { "$ref": "#/components/schemas/ruleset_kind" }, "name": { "type": "string", "description": "Human readable name of the ruleset." }, "phase": { "$ref": "#/components/schemas/ruleset_phase" }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/rule_create" } } } }, "ruleset_update": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the ruleset", "example": "Custom instance ruleset" }, "kind": { "$ref": "#/components/schemas/ruleset_kind" }, "name": { "type": "string", "description": "Human readable name of the ruleset." }, "phase": { "$ref": "#/components/schemas/ruleset_phase" }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/rule_create" } } } }, "rule_create": { "type": "object", "required": [ "action", "expression" ], "properties": { "action": { "$ref": "#/components/schemas/action" }, "action_parameters": { "$ref": "#/components/schemas/action_parameters" }, "description": { "type": "string" }, "enabled": { "type": "boolean" }, "expression": { "$ref": "#/components/schemas/expression" }, "id": { "type": "string" }, "logging": { "$ref": "#/components/schemas/logging" }, "ref": { "$ref": "#/components/schemas/ref" }, "position": { "$ref": "#/components/schemas/position" } } }, "rule_update": { "type": "object", "properties": { "action": { "$ref": "#/components/schemas/action" }, "action_parameters": { "$ref": "#/components/schemas/action_parameters" }, "description": { "type": "string" }, "enabled": { "type": "boolean" }, "expression": { "$ref": "#/components/schemas/expression" }, "id": { "type": "string" }, "logging": { "$ref": "#/components/schemas/logging" }, "ref": { "$ref": "#/components/schemas/ref" }, "position": { "$ref": "#/components/schemas/position" } } }, "ref": { "type": "string", "description": "The reference of the rule (the rule ID by default).", "example": "my_ref", "minLength": 1 }, "logging": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "example": true } } }, "listed_ruleset": { "type": "object", "required": [ "description", "id", "kind", "last_updated", "name", "phase", "version" ], "properties": { "description": { "type": "string", "description": "Description of the ruleset", "example": "Custom instance ruleset" }, "id": { "type": "string", "description": "Unique ID of the ruleset." }, "kind": { "$ref": "#/components/schemas/ruleset_kind" }, "last_updated": { "$ref": "#/components/schemas/last_updated" }, "name": { "type": "string", "description": "Human readable name of the ruleset." }, "phase": { "$ref": "#/components/schemas/ruleset_phase" }, "version": { "type": "string", "description": "The version of the ruleset", "example": 1 } } }, "ruleset_details": { "type": "object", "required": [ "description", "id", "kind", "last_updated", "name", "phase", "version", "rules" ], "properties": { "description": { "type": "string", "description": "Description of the ruleset", "example": "Custom instance ruleset" }, "id": { "type": "string", "description": "Unique ID of the ruleset." }, "kind": { "$ref": "#/components/schemas/ruleset_kind" }, "last_updated": { "$ref": "#/components/schemas/last_updated" }, "name": { "type": "string", "description": "Human readable name of the ruleset." }, "phase": { "$ref": "#/components/schemas/ruleset_phase" }, "version": { "type": "string", "description": "The version of the ruleset", "example": 1 }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/rule_details" } } } }, "overrides": { "type": "object", "properties": { "action": { "$ref": "#/components/schemas/action" }, "enabled": { "type": "boolean" }, "sensitivity_level": { "$ref": "#/components/schemas/sensitivity_level" }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/rules_override" } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/categories_override" } } } }, "categories_override": { "type": "object", "properties": { "category": { "description": "The category tag name to override", "type": "string" }, "enabled": { "type": "boolean" }, "action": { "$ref": "#/components/schemas/action" } } }, "rules_override": { "type": "object", "properties": { "id": { "type": "string" }, "enabled": { "type": "boolean" }, "action": { "$ref": "#/components/schemas/action" }, "sensitivity_level": { "$ref": "#/components/schemas/sensitivity_level" } } }, "action_parameters": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique ID of the ruleset" }, "overrides": { "$ref": "#/components/schemas/overrides" }, "version": { "type": "string", "description": "The version of the ruleset. Use \"latest\" to get the latest version." }, "ruleset": { "type": "string", "description": "Ruleset ID of the ruleset to apply action to. Use \"current\" to apply to the current ruleset." }, "rulesets": { "type": "array", "description": "List of ruleset ids to apply action to. Use \"current\" to apply to the current ruleset.", "items": { "type": "string" } }, "response": { "type": "object", "required": [ "content", "content_type", "status_code" ], "properties": { "content": { "type": "string", "description": "The content to return", "example": "{\"success\": false, \"error\": \"you have been blocked\"}", "minLength": 1 }, "content_type": { "type": "string", "example": "application/json", "minLength": 1 }, "status_code": { "type": "integer", "description": "The status code to return", "minimum": 400, "maximum": 499 } } } } }, "rule_details": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Unique ID of rule" }, "version": { "type": "string", "description": "The version of the rule" }, "action": { "$ref": "#/components/schemas/action" }, "action_parameters": { "$ref": "#/components/schemas/action_parameters" }, "categories": { "$ref": "#/components/schemas/categories" }, "enabled": { "$ref": "#/components/schemas/enabled" }, "description": { "type": "string", "description": "Description of the rule" }, "expression": { "$ref": "#/components/schemas/expression" }, "ref": { "$ref": "#/components/schemas/ref" }, "logging": { "$ref": "#/components/schemas/logging" }, "last_updated": { "$ref": "#/components/schemas/last_updated" } } }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of categories for the rule" }, "enabled": { "type": "boolean", "description": "Is the rule enabled", "example": true }, "last_updated": { "type": "string", "description": "The timestamp of when the resource was last modified.", "example": "2000-01-01T00:00:00.000000Z" }, "expression": { "type": "string", "description": "The expression defining which traffic will match the rule.", "example": "ip.src ne 1.1.1.1", "minLength": 1 }, "action": { "type": "string", "description": "What happens when there is a match for the rule expression", "pattern": "^[a-z]+$" }, "sensitivity_level": { "type": "string", "description": "The sensitivity level of the rule", "enum": [ "high", "medium", "low" ] }, "position": { "type": "object", "properties": { "before": { "type": "string", "description": "The rule ID to place this rule before" }, "after": { "type": "string", "description": "The rule ID to place this rule after" }, "index": { "type": "integer", "description": "The index to place this rule at", "minimum": 0 } } }, "list_rulesets_resp": { "type": "object", "description": "List rulesets response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "array", "items": { "$ref": "#/components/schemas/listed_ruleset" } } } }, "ruleset_resp": { "type": "object", "description": "Ruleset response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/ruleset_details" } } }, "rule_resp": { "type": "object", "description": "List rules response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/rule_details" } } }, "analytics_summary_response": { "type": "object", "description": "Analytics summary", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "description": "Was the operation successful?", "type": "boolean", "example": true }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/analytics_summary_object" } } }, "analytics_summary_object": { "type": "object", "description": "Analytics summary", "properties": { "rows": { "description": "The total number of rows in the result.", "type": "integer", "example": 2 }, "data": { "type": "array", "description": "Data", "items": { "type": "string", "description": "The list of metrics returned by the query." } }, "totals": { "type": "object", "description": "The total results for metrics across all data." }, "min": { "type": "object", "description": "The minimum results for each metric." }, "max": { "type": "object", "description": "The maximum results for each metric." }, "data_lag": { "type": "number", "description": "The number of seconds between the current time and the last processed event. In other words, how many seconds of data might be missing." }, "query": { "type": "object", "description": "Query", "properties": { "metrics": { "description": "The metrics included in the query.", "type": "array", "items": { "type": "string", "enum": [ "count", "bytesIngress", "bytesEgress", "durationAvg", "durationMedian", "duration90th", "duration99th" ] } }, "dimensions": { "description": "The dimensions included in the query.", "type": "array", "items": { "type": "string", "enum": [ "event", "appID", "coloName", "ipVersion" ] } }, "filters": { "type": "string", "description": "The filter string included in the query.", "example": "event==connect AND coloName!=SFO" }, "sort": { "description": "The sort order for the result set.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The name of the sort parameter." }, "desc": { "type": "boolean", "description": "The flag that indicates if the sort was ascending or descending." } } } }, "since": { "type": "string", "format": "date-time", "description": "The start of the time interval to query, which defaults to `until -6 hours`.", "example": "2014-01-02T02:20:00.000Z" }, "until": { "type": "string", "format": "date-time", "description": "The end of the time interval to query, which defaults to the current time.", "example": "2014-01-02T03:20:00.000Z" }, "limit": { "type": "integer", "description": "Sets the limit number of returned metrics, which defaults to 10000.", "example": 10000 } } } } }, "analytics_by_time_response": { "type": "object", "description": "The analytics by time response.", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "description": "Was the operation successful?", "type": "boolean", "example": true }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/analytics_by_time_object" } } }, "analytics_by_time_object": { "type": "object", "description": "The analytics by time object.", "properties": { "rows": { "description": "The total number of rows in the result.", "type": "integer", "example": 2 }, "data": { "type": "array", "description": "Data", "items": { "type": "string" } }, "totals": { "type": "object", "description": "The total results for metrics across all data." }, "min": { "type": "object", "description": "The minimum results for each metric." }, "max": { "type": "object", "description": "The maximum results for each metric." }, "data_lag": { "type": "number", "description": "The number of seconds between the current time and the last processed event In other words, how many seconds of data might be missing." }, "time_intervals": { "description": "Each entry represents the interval of time corresponding to each entry in 'metrics'.", "type": "array", "items": { "type": "string", "format": "date-time" } }, "query": { "type": "object", "description": "Query", "properties": { "metrics": { "description": "The metrics included in the query.", "type": "array", "items": { "type": "string", "enum": [ "count", "bytesIngress", "bytesEgress", "durationAvg", "durationMedian", "duration90th", "duration99th" ] } }, "dimensions": { "description": "The dimensions included in the query.", "type": "array", "items": { "type": "string", "enum": [ "event", "appID", "coloName", "ipVersion" ] } }, "filters": { "type": "string", "description": "The filter string included in the query.", "example": "event==connect AND coloName!=SFO" }, "sort": { "description": "The sort order for the result set.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The name of the sort parameter." }, "desc": { "type": "boolean", "description": "The flag that indicates if the sort was ascending or descending." } } } }, "since": { "type": "string", "format": "date-time", "description": "The start of the time interval to query, which defaults to `until -6 hours`.", "example": "2014-01-02T02:20:00.000Z" }, "until": { "type": "string", "format": "date-time", "description": "The end of the time interval to query, which defaults to the current time.", "example": "2014-01-02T03:20:00.000Z" }, "limit": { "type": "integer", "description": "Sets the limit number of returned metrics, which defaults to 10000.", "example": 10000 } } } } }, "list_instant_logs_resp": { "type": "object", "description": "List instant logs response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "array", "items": { "$ref": "#/components/schemas/listed_instant_log" } } } }, "listed_instant_log": { "type": "object", "properties": { "fields": { "type": "string", "description": "Comma-separated list of fields.", "example": "ClientIP,ClientRequestHost,ClientRequestMethod,ClientRequestURI,EdgeEndTimestamp,EdgeResponseBytes,EdgeResponseStatus,EdgeStartTimestamp,RayID" }, "sample": { "type": "integer", "description": "The sample parameter is the sample rate of the records set by the client: \"sample\": 1 is 100% of records \"sample\": 10 is 10% and so on.", "example": 1 }, "filter": { "type": "string", "description": "Filters to drill down into specific events.", "example": "{\"where\":{\"and\":[{\"key\":\"ClientCountry\",\"operator\":\"neq\",\"value\":\"ca\"}]}}" }, "session_id": { "type": "string", "description": "Unique session ID of the job.", "example": "8bb292b93b985c48154d5097996cf78f" } } }, "instant_logs_create": { "type": "object", "required": [ "fields", "filter", "sample", "kind" ], "properties": { "fields": { "type": "string", "description": "Comma-separated list of fields.", "example": "ClientIP,ClientRequestHost,ClientRequestMethod,ClientRequestURI,EdgeEndTimestamp,EdgeResponseBytes,EdgeResponseStatus,EdgeStartTimestamp,RayID" }, "filter": { "type": "string", "description": "Filters to drill down into specific events.", "example": "{\"where\":{\"and\":[{\"key\":\"ClientCountry\",\"operator\":\"neq\",\"value\":\"ca\"}]}}" }, "sample": { "type": "integer", "description": "The sample parameter is the sample rate of the records set by the client: \"sample\": 1 is 100% of records \"sample\": 10 is 10% and so on.", "example": 1 }, "kind": { "type": "string", "description": "Type of instant logs job", "enum": [ "instant-logs" ], "example": "instant-logs" } } }, "instant_logs_create_resp": { "type": "object", "description": "Create instant logs response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "description": "Container for response information", "type": "array", "items": { "$ref": "#/components/schemas/created_instant_log" } } } }, "created_instant_log": { "type": "object", "properties": { "fields": { "type": "string", "description": "Comma-separated list of fields.", "example": "ClientIP,ClientRequestHost,ClientRequestMethod,ClientRequestURI,EdgeEndTimestamp,EdgeResponseBytes,EdgeResponseStatus,EdgeStartTimestamp,RayID" }, "sample": { "type": "integer", "description": "The sample parameter is the sample rate of the records set by the client: \"sample\": 1 is 100% of records \"sample\": 10 is 10% and so on.", "example": 1 }, "filter": { "type": "string", "description": "Filters to drill down into specific events.", "example": "{\"where\":{\"and\":[{\"key\":\"ClientCountry\",\"operator\":\"neq\",\"value\":\"ca\"}]}}" }, "session_id": { "type": "string", "description": "Unique session ID of the job.", "example": "8bb292b93b985c48154d5097996cf78f" }, "destination_conf": { "description": "Unique WebSocket address that will receive messages from the edge.", "type": "string", "example": "wss://logs.cloudflare.com/instant-logs/ws/sessions/99d471b1ca3c23cc8e30b6acec5db987" } } }, "managed_lists_resp": { "type": "object", "description": "List Managed Lists Response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/managed_lists_result" } } }, "managed_lists_result": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the list to be referenced by rule expressions.", "example": "cf.malware" }, "description": { "type": "string", "description": "Describes the contents of the managed list." }, "kind": { "type": "string", "description": "The type of resource this list contains.", "example": "ip" } } } }, "custom_list_resp": { "type": "object", "description": "Create Custom List Response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/custom_list_result" } } }, "custom_lists_resp": { "type": "object", "description": "List Custom Lists Response", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/custom_lists_result" } } }, "custom_lists_result": { "type": "array", "items": { "$ref": "#/components/schemas/custom_list_result" } }, "custom_list_result": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the list to be referenced by rule expressions.", "example": "good_ips" }, "id": { "type": "string", "description": "The unique ID of the list." }, "description": { "type": "string", "description": "Describes the contents of the list." }, "kind": { "type": "string", "description": "The type of resource this list contains.", "example": "ip" }, "num_items": { "type": "number", "description": "How many items the list contains.", "example": 10 }, "num_referencing_filters": { "type": "number", "description": "How many times the list is used by rule expressions", "example": 5 } } }, "create_custom_list_req": { "type": "object", "required": [ "kind", "name" ], "properties": { "kind": { "type": "string", "description": "The type of list. Each type supports specific list items based on plan type (IP addresses, ASNs, or hostnames).", "enum": [ "ip", "hostname", "asn" ] }, "name": { "type": "string", "description": "An informative name for the list. Use this name in rule expressions." }, "description": { "type": "string", "description": "An informative summary of the list." } } }, "update_custom_list_req": { "type": "object", "properties": { "description": { "type": "string", "description": "An informative summary of the list." } } }, "delete_resource_resp": { "type": "object", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "object", "properties": { "id": { "type": "string", "example": "34b12448945f11eaa1b71c4d701ab86e" } } } } }, "list_operation_resp": { "type": "object", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "object", "properties": { "operation_id": { "type": "string", "example": "53d73a83d33d4e3b8791764a9b9f2412" } } } } }, "create_list_items_req": { "type": "array", "items": { "type": "object", "properties": { "asn": { "type": "number", "description": "An autonomous system number.", "example": 19604 }, "comment": { "type": "string", "description": "An informative summary of the list item.", "example": "My list of developer IPs." }, "hostname": { "type": "string", "description": "Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).", "example": "cloud.ibm.com" }, "ip": { "type": "string", "description": "An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.", "example": "172.64.0.0/13" } } } }, "list_items_resp": { "type": "object", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/list_item" } }, "result_info": { "$ref": "#/components/schemas/list_items_result_info" } } }, "list_items_result_info": { "type": "object", "properties": { "cursors": { "$ref": "#/components/schemas/list_cursor" } } }, "list_cursor": { "type": "object", "properties": { "after": { "type": "string", "description": "The cursor token to fetch the next page of results.", "example": "yyy" }, "before": { "type": "string", "description": "The cursor token to fetch the previous page of results.", "example": "xxx" } } }, "list_item_resp": { "type": "object", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "$ref": "#/components/schemas/list_item" } } }, "list_item": { "type": "object", "properties": { "id": { "type": "string", "example": "70c2009751b24ffc9ed1ab462ba957b4" }, "asn": { "type": "number", "description": "An autonomous system number.", "example": 19604 }, "comment": { "type": "string", "description": "An informative summary of the list item.", "example": "My list of developer IPs." }, "hostname": { "type": "string", "description": "Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).", "example": "cloud.ibm.com" }, "ip": { "type": "string", "description": "An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.", "example": "172.64.0.0/13" }, "created_on": { "type": "string", "example": "2025-03-21T16:19:21Z" }, "modified_on": { "type": "string", "example": "2025-03-21T16:19:37Z" } } }, "delete_list_items_req": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "70c2009751b24ffc9ed1ab462ba957b4" } } } } } }, "operation_status_resp": { "type": "object", "required": [ "success", "errors", "messages", "result" ], "properties": { "success": { "$ref": "#/components/schemas/success" }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" }, "result": { "type": "object", "properties": { "id": { "type": "string", "example": "0147be950d5c42b8b47c07792c5015e3" }, "status": { "type": "string", "enum": [ "pending", "running", "completed", "failed" ], "example": "completed" }, "completed": { "type": "string", "example": "2025-03-21T16:07:41.782564Z" }, "error": { "type": "string", "description": "A message describing the error when the status is failed." } } } } }, "load_balancer_country": { "type": "object", "properties": { "country_code_a2": { "type": "string", "description": "ISO 3166-1 alpha-2 country code", "example": "IN" }, "country_name": { "type": "string", "description": "Full name of the country", "example": "India" } } }, "load_balancer_region": { "type": "object", "properties": { "region_code": { "type": "string", "description": "Region identifier code", "example": "SAS" }, "countries": { "type": "array", "items": { "$ref": "#/components/schemas/load_balancer_country" } } } }, "load_balancer_regions_result": { "type": "object", "properties": { "iso_standard": { "type": "string", "description": "ISO standard used for country and subdivision codes", "example": "Country and subdivision codes follow ISO 3166-1 alpha-2 and ISO 3166-2" }, "regions": { "type": "array", "items": { "$ref": "#/components/schemas/load_balancer_region" } } } }, "load_balancer_regions_response": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/load_balancer_regions_result" }, "success": { "type": "boolean", "example": true }, "errors": { "type": "array", "items": { "type": "string" }, "example": [] }, "messages": { "type": "array", "items": { "type": "string" }, "example": [] } } }, "origin_pull_cert_req": { "type": "object", "description": "authenticated origin pull certificate request", "required": [ "certificate", "private_key" ], "properties": { "certificate": { "type": "string", "description": "the zone's leaf certificate", "example": "-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n" }, "private_key": { "type": "string", "description": "the zone's private key", "example": "-----BEGIN RSA PRIVATE KEY-----\\n......\\n-----END RSA PRIVATE KEY-----\\n" } } }, "origin_pull_cert_priority_req": { "type": "object", "description": "certificate priority request", "required": [ "certificates" ], "properties": { "certificates": { "type": "array", "description": "certificates array", "items": { "type": "object", "description": "certificate items", "required": [ "id", "priority" ], "properties": { "id": { "type": "string", "description": "identifier", "example": "5a7805061c76ada191ed06f989cc3dac" }, "priority": { "type": "integer", "description": "certificate priority", "example": 1 } } } } } }, "zone_origin_pull_settings_req": { "type": "object", "description": "zone-level authenticated origin pull settings request", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "enabled", "example": true } } }, "hostname_origin_pull_settings_req": { "type": "object", "description": "hostname-level authenticated origin pull settings request", "required": [ "config" ], "properties": { "config": { "type": "array", "description": "An array with items in the settings request", "items": { "$ref": "#/components/schemas/hostname_origin_pull_settings" } } } }, "hostname_origin_pull_settings": { "type": "object", "description": "hostname-level authenticated origin pull settings request", "required": [ "hostname", "cert_id", "enabled" ], "properties": { "hostname": { "type": "string", "description": "the hostname on the origin for which the client certificate uploaded will be used", "example": "app.example.com" }, "cert_id": { "type": "string", "description": "certificate identifier tag", "example": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60" }, "enabled": { "type": "boolean", "nullable": true, "description": "enabled", "example": true } } }, "list_zone_origin_pull_certificates_resp": { "type": "object", "description": "certificate response", "properties": { "result": { "$ref": "#/components/schemas/origin_pull_certificate_packs" }, "success": { "type": "boolean", "description": "success", "example": true }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "get_zone_origin_pull_settings_resp": { "type": "object", "description": "zone level authenticated origin pull settings response", "properties": { "result": { "type": "object", "description": "result", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "enabled", "example": true } } }, "success": { "type": "boolean", "description": "success", "example": true }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "zone_origin_pull_certificate_resp": { "type": "object", "description": "zone level authenticated origin pull certificate response", "properties": { "result": { "$ref": "#/components/schemas/origin_pull_certificate_pack" }, "success": { "type": "boolean", "description": "success", "example": true }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "hostname_origin_pull_certificate_resp": { "type": "object", "description": "certificate response", "properties": { "result": { "$ref": "#/components/schemas/hostname_certificate_pack" }, "success": { "type": "boolean", "description": "success", "example": true }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "list_hostname_origin_pull_certificates_resp": { "type": "object", "description": "array of hostname level authenticated origin pull settings response", "properties": { "result": { "$ref": "#/components/schemas/hostname_certificates_resp" }, "success": { "type": "boolean", "description": "success", "example": true }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "list_hostname_origin_pull_settings_resp": { "type": "object", "description": "array of hostname level authenticated origin pull settings response", "properties": { "result": { "$ref": "#/components/schemas/hostnames_settings_resp" }, "success": { "type": "boolean", "description": "success", "example": true }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "get_hostname_origin_pull_settings_resp": { "type": "object", "description": "detail of the hostname level authenticated origin pull settings response", "properties": { "result": { "$ref": "#/components/schemas/hostname_settings_resp" }, "success": { "type": "boolean", "description": "success", "example": true }, "errors": { "$ref": "#/components/schemas/errors" }, "messages": { "$ref": "#/components/schemas/messages" } } }, "hostnames_settings_resp": { "type": "array", "description": "array of hostname settings response", "items": { "$ref": "#/components/schemas/hostname_settings_resp" } }, "hostname_settings_resp": { "type": "object", "description": "hostname level authenticated origin pull settings response", "properties": { "hostname": { "type": "string", "description": "the hostname on the origin for which the client certificate uploaded will be used", "example": "app.example.com" }, "cert_id": { "type": "string", "description": "certificate identifier tag", "example": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60" }, "enabled": { "type": "boolean", "nullable": true, "description": "enabled", "example": true }, "status": { "type": "string", "example": "active", "description": "status of the certificate activation" }, "created_at": { "type": "string", "format": "date-time", "description": "the time when the certificate was created", "example": "2100-01-01T05:20:00Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "the time when the certificate was updated", "example": "2100-01-01T05:20:00Z" }, "cert_status": { "type": "string", "example": "active", "description": "status of the certificate or the association" }, "issuer": { "type": "string", "example": "GlobalSign", "description": "the certificate authority that issued the certificate" }, "signature": { "type": "string", "description": "the type of hash used for the certificate", "example": "SHA256WithRSA" }, "serial_number": { "type": "string", "description": "the serial number on the uploaded certificate", "example": "6743787633689793699141714808227354901" }, "certificate": { "type": "string", "description": "the zone's leaf certificate", "example": "-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n" }, "cert_uploaded_on": { "type": "string", "format": "date-time", "description": "the time the certificate was uploaded", "example": "2019-10-28T18:11:23.37411Z" }, "cert_updated_at": { "type": "string", "format": "date-time", "description": "the time when the certificate was updated", "example": "2100-01-01T05:20:00Z" }, "expires_on": { "type": "string", "format": "date-time", "description": "the date when the certificate expires", "example": "2100-01-01T05:20:00Z" } } }, "origin_pull_certificate_packs": { "type": "array", "description": "list of origin pull certificate packs", "items": { "$ref": "#/components/schemas/origin_pull_certificate_pack" } }, "origin_pull_certificate_pack": { "type": "object", "description": "origin pull certificate pack", "properties": { "id": { "type": "string", "description": "certificate identifier tag", "example": "0f405ba2-8c18-49eb-a30b-28b85427780f" }, "certificate": { "type": "string", "description": "the zone's leaf certificate", "example": "-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n" }, "issuer": { "type": "string", "description": "the certificate authority that issued the certificate", "example": "GlobalSign" }, "signature": { "type": "string", "description": "the type of hash used for the certificate", "example": "SHA256WithRSA" }, "status": { "type": "string", "example": "active", "description": "status of the certificate activation" }, "expires_on": { "type": "string", "description": "when the certificate from the authority expires", "example": "2100-01-01T05:20:00Z" }, "uploaded_on": { "type": "string", "description": "the time the certificate was uploaded", "example": "2100-01-01T05:20:00Z" } } }, "hostname_certificates_resp": { "type": "array", "description": "array of hostname certificates response", "items": { "$ref": "#/components/schemas/hostname_certificate_pack" } }, "hostname_certificate_pack": { "type": "object", "description": "certificate pack", "properties": { "id": { "type": "string", "description": "certificate identifier tag", "example": "0f405ba2-8c18-49eb-a30b-28b85427780f" }, "certificate": { "type": "string", "description": "the zone's leaf certificate", "example": "-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n" }, "issuer": { "type": "string", "description": "the certificate authority that issued the certificate", "example": "GlobalSign" }, "signature": { "type": "string", "description": "the type of hash used for the certificate", "example": "SHA256WithRSA" }, "serial_number": { "type": "string", "description": "the serial number on the uploaded certificate", "example": "6743787633689793699141714808227354901" }, "status": { "type": "string", "example": "active", "description": "status of the certificate activation" }, "expires_on": { "type": "string", "description": "when the certificate from the authority expires", "example": "2100-01-01T05:20:00Z" }, "uploaded_on": { "type": "string", "description": "the time the certificate was uploaded", "example": "2100-01-01T05:20:00Z" } } } }, "examples": { "ddos_alerter_example": { "summary": "Create an HTTP DDoS Attack Alerter using a webhook", "value": { "name": "DDoS Alerter", "description": "Send a slack alert via webhook when a DDoS attack is detected", "enabled": true, "alert_type": "dos_attack_l7", "mechanisms": { "webhooks": [ { "id": "f0413b106d2c4aa9b1553d5d0209c522" } ] }, "filters": {} } }, "pool_enablement_alerter_example": { "summary": "Create a Load Balancing Pool Enablement Alerter that emails when pools are disabled", "value": { "name": "Pools Disabled Alerter", "description": "Send an email when our pools are disabled", "enabled": true, "alert_type": "g6_pool_toggle_alert", "mechanisms": { "email": [ { "id": "sreteam@techcompany.com" } ] }, "filters": { "enabled": [ "false" ], "pool_id": [ "1aaaa88437084848bbfaf6540f9c9fd6", "ac8dc6caf0d743bca2e6a9ca0774de72" ] } } }, "waf_alerter_example": { "summary": "Create a WAF Alerter that emails when there are spikes in firewall events across all services", "value": { "name": "WAF Alerter", "description": "Send an email on spike in firewall events for any service", "enabled": true, "alert_type": "clickhouse_alert_fw_anomaly", "mechanisms": { "email": [ { "id": "sreteam@techcompany.com" } ] }, "filters": { "zones": [ "7cff1aaf840c4708a1ed7f536089dee7" ] } } }, "advanced_waf_alerter_example": { "summary": "Create an advanced WAF Alerter that emails when there are spikes in firewall events for WAF and browser integrity check services", "value": { "name": "WAF Alerter", "description": "Send an email on spike in firewall events for WAF or browser integrity check", "enabled": true, "alert_type": "clickhouse_alert_fw_ent_anomaly", "mechanisms": { "email": [ { "id": "sreteam@techcompany.com" } ] }, "filters": { "services": [ "waf", "bic" ], "zones": [ "7cff1aaf840c4708a1ed7f536089dee7" ] } } }, "universal_ssl_alerter_example": { "summary": "Create a Universal SSL Alerter that emails when a Universal SSL edge certificate is validated, issued, or renewed", "value": { "name": "Universal SSL Alerter", "description": "Send an email on automatic cert events", "enabled": true, "alert_type": "universal_ssl_event_type", "mechanisms": { "email": [ { "id": "sreteam@techcompany.com" } ] }, "filters": {} } }, "dedicated_ssl_alerter_example": { "summary": "Create a Dedicated SSL Alerter that emails when an Advanced/Dedicated SSL edge certificate is validated, issued, renewed, or expires", "value": { "name": "Dedicated SSL Alerter", "description": "Send an email on dedicated cert events", "enabled": true, "alert_type": "dedicated_ssl_certificate_event_type", "mechanisms": { "email": [ { "id": "sreteam@techcompany.com" } ] }, "filters": {} } }, "lb_health_check_alerter_example": { "summary": "Create a Health Check Alerter that emails when a load balancer pool with a health check monitor attached to it changes its health status", "value": { "name": "LB Health Check Alerter", "description": "Send an email on pool health events", "enabled": true, "alert_type": "health_check_status_notification", "mechanisms": { "email": [ { "id": "sreteam@techcompany.com" } ] }, "filters": { "health_check_id": [ "ed9d68c99071bb6c971d840766b28924" ], "status": [ "Unhealthy", "Healthy" ] } } }, "lb_pool_enable_alerter_example": { "summary": "Alerts based on the pools' enable/disable toggle status", "value": { "name": "Pool Enablement Alert", "description": "Send email on pool enable or disable", "enabled": true, "alert_type": "load_balancing_pool_enablement_alert", "mechanisms": { "email": [ { "id": "sreteam@techcompany.com" } ] }, "filters": { "pool_id": [ "1aaaa88437084848bbfaf6540f9c9fd6", "ac8dc6caf0d743bca2e6a9ca0774de72" ], "enabled": [ true, false ] } } }, "web_traffic_reporter_example": { "summary": "Weekly summary with reports for the account web metrics", "value": { "name": "Web Metrics Report", "description": "Send weekly summary of account web metrics", "enabled": true, "alert_type": "web_analytics_metrics_update", "mechanisms": { "email": [ { "id": "sreteam@techcompany.com" } ] }, "filters": {} } }, "maintenance_alerter_example": { "summary": "Reports on upcoming Cloudflare maintenance", "value": { "name": "Cloudflare Maintenance Alert", "description": "Send alerts for upcoming Cloudflare maintenance windows", "enabled": true, "alert_type": "maintenance_event_notification", "mechanisms": { "email": [ { "id": "sreteam@techcompany.com" } ] }, "filters": { "event_type": [ "MAINTENANCE_EVENT_TYPE_SCHEDULED", "MAINTENANCE_EVENT_TYPE_CHANGED", "MAINTENANCE_EVENT_TYPE_CANCELED" ] } } } } } }