Introduction

IBM 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.

IBM CIS gets you going quickly by establishing defaults for you, which you can change easily using the API or UI. Here are some commonly changed parameters:

  • DNS settings: you can use IBM CIS to host your DNS or you can create CNAME records.
  • Crypto settings (TLS): the default is flexible mode, which encrypts the connection between your host and the IBM CIS edge server, but does not encrypt the communication between the IBM CIS edge server and origin server.

For complete information about establishing and managing an IBM Cloud CIS instance, refer to our customer documentation.

API endpoint

https://api.cis.cloud.ibm.com

API Endpoint

https://api.cis.cloud.ibm.com

Error handling

This 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.

HTTP error code Description Recovery
200 Success The request was successful.
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.
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.
403 Forbidden The supplied authentication is not authorized to access '{namespace}'.
404 Not Found The requested resource could not be found.
408 Request Timeout The connection to the server timed out. Wait a few minutes, then try again.
409 Conflict The entity is already in the requested state.
500 Internal Server Error IBM Cloud Internet Services is currently unavailable. Your request could not be processed. Please wait a few minutes and try again.

Here are some model code examples for error handling in the IBM Cloud Internet Services API:

Success 200 Example Code

200 The API was completed successfully

{
  "success": true,
  "errors": [
    {}
  ],
  "messages": [
    {}
  ],
  "result": {
    "zones": [
      {
        "zone": {
          "status": null,
          "name": null,
          "security": null,
          "paused": false
        },
        "dns_record": {
          "count": 0
        },
        "load_balancer": {
          "monitor_count": 0,
          "pool_count": 0,
          "load_balancer_active_count": 0
        },
        "caching": {
          "edge_cache_ttl": 0,
          "cache_browser_ttl": 0,
          "development_mode": "off",
          "cache_level": "basic"
        },
        "pagerule": {
          "active_count": 0,
          "inactive_count": 0
        },
        "waf": {
          "status": null
        },
        "ssl": {
          "mode": null,
          "universal_ssl_certificate": "off",
          "dedicate_certificate_count": 0,
          "custom_upload_certificate_count": 0,
          "tls_1_2_only": "on"
        },
        "plan_details": {
          "plan_name": "Standard",
          "days_remaining": null
        },
        "firewall": {
          "security_level": "low"
        }
      }
    ],
    "service_maintenance": {
      "start_time": null,
      "end_time": null,
      "message": null
    }
  }
}

Failure 401 Example Code

401 Action unauthorized

{
  "trace": "be45687c-57f2-46e8-8717-32b3153a5886",
  "errors": [
    {
      "code": 401,
      "message": "Action is not authorized."
    }
  ]
}

Failure 404 Example:

404 API not found
{
  "trace": "c3c9f6af-a20f-4b73-8e3d-800a9284a07f",
  "errors": [
    {
      "code": null,
      "message": "404 Not Found"
    }
  ]
}

Methods

List rules.

Search, sort, and filter rules within a package.

GET /v1/{crn}/zones/{zone_id}/firewall/waf/packages/{package_id}/rules
Request

Custom Headers

  • bluemix user IAM token

Path Parameters

  • cloud resource name

  • zone id

  • package id

Query Parameters

  • The Rule Mode

  • The order in which the individual rule is executed within the related group

  • Whether to match all search requirements or at least one. default value: all. valid values: any, all

  • Field to order rules by. valid values: priority, group_id, description.

  • WAF group identifier tag. max length: 32; Read-only

  • Public description of the rule

  • Direction to order rules. valid values: asc, desc

  • Page number of paginated results. default value: 1; min value:1

  • Number of rules per page. default value: 50; min value:5; max value:100

Response

Status Code

  • success

  • Bad Request

  • Forbidden! User has no privilege to use IBM Cloud Internet Services

  • Resource not found

  • Internal Server Error

  • Gateway Timeout! Backendendpoint did not respond on time

Example responses

Rule info.

Individual information about a rule.

GET /v1/{crn}/zones/{zone_id}/firewall/waf/packages/{package_id}/rules/{identifier}
Request

Custom Headers

  • bluemix user IAM token

Path Parameters

  • cloud resource name

  • zone id

  • package id

  • rule identifier

Response

Status Code

  • success

  • Bad Request

  • Forbidden! User has no privilege to use IBM Cloud Internet Services

  • Resource not found

  • Internal Server Error

  • Gateway Timeout! Backendendpoint did not respond on time

Example responses

Update rule.

Update the action the rule will perform if triggered on the zone.

PATCH /v1/{crn}/zones/{zone_id}/firewall/waf/packages/{package_id}/rules/{identifier}
Request

Custom Headers

  • bluemix user IAM token

Path Parameters

  • cloud resource name

  • zone id

  • package id

  • rule identifier

The mode to use when the rule is triggered. Value is restricted based on the allowed_modes of the rule

Response

Status Code

  • success

  • Bad Request

  • Forbidden! User has no privilege to use IBM Cloud Internet Services

  • Resource not found

  • Internal Server Error

  • Gateway Timeout! Backendendpoint did not respond on time

Example responses