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

Get zone DNSSEC.

Get DNSSEC setting for a given zone.

GET /v1/{crn}/zones/{zone_identifier}/dnssec
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier to identifiy the zone.

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/dnssec \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
  • Map<String, String> headers = new HashMap<>();
    headers.put("content-type", "application/json");
    headers.put("accept", "application/json");
    headers.put("x-auth-user-token", "Bearer xxxxxx");
    HttpResponse<String> response = Unirest.get("https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/dnssec")
      .headers(headers).asString();
  • var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "api.cis.cloud.ibm.com",
      "port": null,
      "path": "/v1/:crn/zones/:zone_id/dnssec",
      "headers": {
         "accept": "application/json",
         "content-type": "application/json",
         "x-auth-user-token": "Bearer xxxxxx"
      }
    };
    
    var req = http.request(options, function (res) {
      var chunks = [];
    
      res.on("data", function (chunk) {
        chunks.push(chunk);
      });
    
      res.on("end", function () {
        var body = Buffer.concat(chunks);
        console.log(body.toString());
      });
    });
    
    req.end();
    
  • import http.client
    
    conn = http.client.HTTPSConnection("api.cis.cloud.ibm.com")
    
    headers = {
        'accept': 'application/json'
        'content-type': 'application/json'
        'x-auth-user-token': 'Bearer xxxxxx'
    }
    conn.request("GET", "/v1/:crn/zones/:zone_id/dnssec", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Resource not found

  • Internal server error

Example responses
  • {
      "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.739728Z"
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update zone DNSSEC.

Update DNSSEC setting for given zone.

PATCH /v1/{crn}/zones/{zone_identifier}/dnssec
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Identifier of zone.

Update zone DNSSEC setting.

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/dnssec \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"status": "enabled"}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Resource not found

  • Internal server error

Example responses
  • {
      "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.739728Z"
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Get zone CNAME flattening.

Get CNAME flattening setting for a given zone.

GET /v1/{crn}/zones/{zone_identifier}/settings/cname_flattening
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier to identifiy the zone.

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/cname_flattening \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Resource not found

  • Internal server error

Example responses
  • {
      "result": {
        "id": "cname_flattening",
        "value": "flatten_at_root",
        "modified_on": null,
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update zone CNAME flattening.

Update CNAME flattening setting for given zone.

PATCH /v1/{crn}/zones/{zone_identifier}/settings/cname_flattening
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier to identifiy the zone.

Update zone CNAME flattening setting.

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/cname_flattening \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"value": "flatten_at_root"}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Resource not found

  • Internal server error

Example responses
  • {
      "result": {
        "id": "cname_flattening",
        "value": "flatten_at_root",
        "modified_on": null,
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

get opportunistic encryption setting

Get opportunistic encryption setting for a zone.

GET /v1/{crn}/zones/{zone_identifier}/settings/opportunistic_encryption
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/opportunistic_encryption \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "opportunistic_encryption",
        "value": "off",
        "modified_on": null,
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update opportunistic encryption setting

Update opportunistic encryption setting for a zone.

PATCH /v1/{crn}/zones/{zone_identifier}/settings/opportunistic_encryption
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

Update opportunistic encryption setting.

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/opportunistic_encryption \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"value": "on"}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "opportunistic_encryption",
        "value": "on",
        "modified_on": "2018-10-08T09:32:10.916480Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

get challenge TTL setting

Get challenge TTL setting for a zone.

GET /v1/{crn}/zones/{zone_identifier}/settings/challenge_ttl
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/challenge_ttl \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Resource not found

  • Internal server error

Example responses
  • {
      "result": {
        "id": "challenge_ttl",
        "value": 1800,
        "modified_on": null,
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update challenge TTL setting

Update challenge TTL setting for a zone.

PATCH /v1/{crn}/zones/{zone_identifier}/settings/challenge_ttl
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

Update challenge TTL setting

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/challenge_ttl \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"value": 1800}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Resource not found

  • Internal server error

Example responses
  • {
      "result": {
        "id": "challenge_ttl",
        "value": 1800,
        "modified_on": "2018-10-08T09:40:03.277303Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

get automatic https rewrites setting

Get automatic https rewrites setting for a zone.

GET /v1/{crn}/zones/{zone_identifier}/settings/automatic_https_rewrites
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/automatic_https_rewrites \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "automatic_https_rewrites",
        "value": "off",
        "modified_on": null,
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update automatic https rewrites setting

Update automatic https rewrites setting for a zone.

PATCH /v1/{crn}/zones/{zone_identifier}/settings/automatic_https_rewrites
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

Update automatic https rewrites setting

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/automatic_https_rewrites \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"value": "on"}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "automatic_https_rewrites",
        "value": "on",
        "modified_on": "2018-10-08T09:37:29.953507Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

get true client IP setting

Get true client IP setting for a zone.

GET /v1/{crn}/zones/{zone_identifier}/settings/true_client_ip_header
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/true_client_ip_header \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "true_client_ip_header",
        "value": "off",
        "modified_on": "2018-12-08T13:51:57.862285Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update true client IP setting

Update true client IP setting for a zone.

PATCH /v1/{crn}/zones/{zone_identifier}/settings/true_client_ip_header
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

Update true client IP setting

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/true_client_ip_header \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"value": "on"}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "true_client_ip_header",
        "value": "on",
        "modified_on": "2018-12-08T18:58:10.519787Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

get always use https setting

Get always use https setting for a zone.

GET /v1/{crn}/zones/{zone_identifier}/settings/always_use_https
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/always_use_https \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "always_use_https",
        "value": "off",
        "modified_on": null,
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update always use https setting

Update always use https setting for a zone.

PATCH /v1/{crn}/zones/{zone_identifier}/settings/always_use_https
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

Update true client IP setting

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/always_use_https \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"value": "on"}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "always_use_https",
        "value": "on",
        "modified_on": "2018-12-08T18:57:07.794484Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

get image size optimization setting

Get image size optimization setting for a zone.

GET /v1/{crn}/zones/{zone_identifier}/settings/image_size_optimization
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/image_size_optimization \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "modified_on": "2018-12-08T13:53:17.136858Z",
        "editable": true,
        "id": "image_size_optimization",
        "value": "off"
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update image size optimization setting

Update image size optimization setting for a zone.

PATCH /v1/{crn}/zones/{zone_identifier}/settings/image_size_optimization
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

Update image size optimization setting

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/image_size_optimization \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"value": "lossless"}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "modified_on": "2018-12-08T18:59:35.557924Z",
        "editable": true,
        "id": "image_size_optimization",
        "value": "lossless"
      },
      "success": true,
      "errors": [],
      "messages": []
    }

get script load optimization setting

Get script load optimization setting for a zone.

GET /v1/{crn}/zones/{zone_identifier}/settings/script_load_optimization
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/script_load_optimization \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "modified_on": "2018-12-08T13:51:51.231254Z",
        "editable": true,
        "id": "script_load_optimization",
        "value": "off"
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update script load optimization setting

Update script load optimization setting for a zone.

PATCH /v1/{crn}/zones/{zone_identifier}/settings/script_load_optimization
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

Update script load optimization setting

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/script_load_optimization \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"value": "on"}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "modified_on": "2018-12-08T18:58:03.362441Z",
        "editable": true,
        "id": "script_load_optimization",
        "value": "on"
      },
      "success": true,
      "errors": [],
      "messages": []
    }

get image load optimizationn setting

Get image load optimizationn setting for a zone.

GET /v1/{crn}/zones/{zone_identifier}/settings/image_load_optimization
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/image_load_optimization \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "image_load_optimization",
        "value": "off",
        "modified_on": "2018-12-08T13:51:38.150504Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update image load optimizationn setting

Update image load optimizationn setting for a zone.

PATCH /v1/{crn}/zones/{zone_identifier}/settings/image_load_optimization
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

Update image load optimizationn setting

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/image_load_optimization \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"value": "on"}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "image_load_optimization",
        "value": "on",
        "modified_on": "2018-12-08T18:57:49.315031Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

get minify setting

Get minify setting for a zone.

GET /v1/{crn}/zones/{zone_identifier}/settings/minify
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/minify \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "minify",
        "value": {
          "html": "off",
          "css": "off",
          "js": "off"
        },
        "modified_on": "2018-12-08T13:53:20.633325Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update minify setting

Update minify setting for a zone.

PATCH /v1/{crn}/zones/{zone_identifier}/settings/minify
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

Update minify setting

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/minify \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"value": {"html": "on", "css": "on", "js": "on"}}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "minify",
        "value": {
          "html": "on",
          "css": "on",
          "js": "on"
        },
        "modified_on": "2018-12-08T18:59:40.961815Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

get minimum TLS version setting

Get minimum TLS version setting for a zone.

GET /v1/{crn}/zones/{zone_identifier}/settings/min_tls_version
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/min_tls_version \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "min_tls_version",
        "value": "1.3",
        "modified_on": null,
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update minimum TLS version setting

Update minimum TLS version setting for a zone.

PATCH /v1/{crn}/zones/{zone_identifier}/settings/min_tls_version
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

Update minimum TLS version setting

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/min_tls_version \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"value": "1.0"}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "min_tls_version",
        "value": "1.0",
        "modified_on": null,
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

get IP geolocation setting

Get IP geolocation setting for a zone.

GET /v1/{crn}/zones/{zone_identifier}/settings/ip_geolocation
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/ip_geolocation \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "ip_geolocation",
        "value": "off",
        "modified_on": "2018-12-08T13:51:13.916331Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update IP geolocation setting

Update IP geolocation setting for a zone.

PATCH /v1/{crn}/zones/{zone_identifier}/settings/ip_geolocation
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

Update IP geolocation setting

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/ip_geolocation \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"value": "on"}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "ip_geolocation",
        "value": "on",
        "modified_on": "2018-12-08T18:57:25.025810Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

get server side exclude setting

Get server side exclude setting for a zone.

GET /v1/{crn}/zones/{zone_identifier}/settings/server_side_exclude
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/server_side_exclude \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "server_side_exclude",
        "value": "off",
        "modified_on": "2018-12-08T13:51:24.448345Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update server side exclude setting

Update server side exclude setting for a zone.

PATCH /v1/{crn}/zones/{zone_identifier}/settings/server_side_exclude
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

Update server side exclude setting

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/server_side_exclude \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"value": "on"}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "server_side_exclude",
        "value": "on",
        "modified_on": "2018-12-08T18:57:34.969884Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

get HTTP strict transport security setting

Get HTTP strict transport security setting for a zone.

GET /v1/{crn}/zones/{zone_identifier}/settings/security_header
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/security_header \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "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.178667Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update HTTP strict transport security setting

Update HTTP strict transport security setting for a zone.

PATCH /v1/{crn}/zones/{zone_identifier}/settings/security_header
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

Update HTTP strict transport security setting

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/security_header \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"value": {"strict_transport_security": {"preload": true, "max_age": 100, "enabled": true, "include_subdomains": true, "nosniff": true}}}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "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.507161Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

get mobile redirect setting

Get mobile redirect setting for a zone.

GET /v1/{crn}/zones/{zone_identifier}/settings/mobile_redirect
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/mobile_redirect \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "mobile_redirect",
        "value": {
          "status": "off",
          "strip_uri": false,
          "mobile_subdomain": null
        },
        "modified_on": null,
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update mobile redirect setting

Update mobile redirect setting for a zone.

PATCH /v1/{crn}/zones/{zone_identifier}/settings/mobile_redirect
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

Update mobile redirect setting

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/mobile_redirect \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"value": {"status":"off","mobile_subdomain":"m","strip_uri":false}}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "mobile_redirect",
        "value": {
          "status": "off",
          "mobile_subdomain": "m",
          "strip_uri": false
        },
        "modified_on": "2018-12-08T18:57:07.794484Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

get prefetch URLs from header setting

Get prefetch URLs from header setting for a zone.

GET /v1/{crn}/zones/{zone_identifier}/settings/prefetch_preload
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/prefetch_preload \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "prefetch_preload",
        "value": "off",
        "modified_on": "2018-12-08T13:51:44.767695Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update prefetch URLs from header setting

Update prefetch URLs from header setting for a zone.

PATCH /v1/{crn}/zones/{zone_identifier}/settings/prefetch_preload
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

Update prefetch URLs from header setting

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/prefetch_preload \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"value": "on"}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "prefetch_preload",
        "value": "on",
        "modified_on": "2018-12-08T18:57:56.421999Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

get http/2 setting

Get http/2 setting for a zone.

GET /v1/{crn}/zones/{zone_identifier}/settings/http2
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/http2 \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "http2",
        "value": "off",
        "modified_on": "2018-12-08T13:51:10.216094Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update http/2 setting

Update http/2 setting for a zone.

PATCH /v1/{crn}/zones/{zone_identifier}/settings/http2
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

Update http/2 setting

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/http2 \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"value": "on"}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "http2",
        "value": "on",
        "modified_on": "2018-12-08T18:57:21.423386Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

get IPv6 compatibility setting

Get IPv6 compatibility setting for a zone.

GET /v1/{crn}/zones/{zone_identifier}/settings/ipv6
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/ipv6 \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "ipv6",
        "value": "off",
        "modified_on": "2018-12-08T13:51:17.639073Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update IPv6 compatibility setting

Update IPv6 compatibility setting for a zone.

PATCH /v1/{crn}/zones/{zone_identifier}/settings/ipv6
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

Update IPv6 compatibility setting

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/ipv6 \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"value": "on"}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "ipv6",
        "value": "on",
        "modified_on": "2018-12-08T18:57:28.494069Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

get web sockets setting

Get web sockets setting for a zone.

GET /v1/{crn}/zones/{zone_identifier}/settings/websockets
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/websockets \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "websockets",
        "value": "off",
        "modified_on": "2018-12-08T13:51:34.312911Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update web sockets setting

Update web sockets setting for a zone.

PATCH /v1/{crn}/zones/{zone_identifier}/settings/websockets
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

Update web sockets setting

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/websockets \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"value": "on"}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "websockets",
        "value": "on",
        "modified_on": "2018-12-08T18:57:45.781083Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

get pseudo IPv4 setting

Get pseudo IPv4 setting for a zone.

GET /v1/{crn}/zones/{zone_identifier}/settings/pseudo_ipv4
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/pseudo_ipv4 \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "pseudo_ipv4",
        "value": "off",
        "modified_on": "2018-12-08T13:53:12.222507Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update pseudo IPv4 setting

Update pseudo IPv4 setting for a zone.

PATCH /v1/{crn}/zones/{zone_identifier}/settings/pseudo_ipv4
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

Update pseudo IPv4 setting

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/pseudo_ipv4 \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"value": "add_header"}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "pseudo_ipv4",
        "value": "add_header",
        "modified_on": "2018-12-08T18:59:30.268371Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

get response buffering setting

Get response buffering setting for a zone.

GET /v1/{crn}/zones/{zone_identifier}/settings/response_buffering
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/response_buffering \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "response_buffering",
        "value": "off",
        "modified_on": "2018-12-08T13:51:47.993787Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update response buffering setting

Update response buffering setting for a zone.

PATCH /v1/{crn}/zones/{zone_identifier}/settings/response_buffering
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

Update response buffering setting

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/response_buffering \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"value": "on"}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "response_buffering",
        "value": "on",
        "modified_on": "2018-12-08T18:57:59.799664Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Get hotlink protection setting for a zone.

GET /v1/{crn}/zones/{zone_identifier}/settings/hotlink_protection
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/hotlink_protection \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "hotlink_protection",
        "value": "off",
        "modified_on": "2018-12-08T13:51:06.923808Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update hotlink protection setting for a zone.

PATCH /v1/{crn}/zones/{zone_identifier}/settings/hotlink_protection
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

Update hotlink protection setting

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/hotlink_protection \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"value": "on"}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "hotlink_protection",
        "value": "on",
        "modified_on": "2018-12-08T18:57:17.898906Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

get maximum upload size setting

Get maximum upload size setting for a zone.

GET /v1/{crn}/zones/{zone_identifier}/settings/max_upload
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/max_upload \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "max_upload",
        "value": 200,
        "modified_on": "2018-12-08T13:52:56.515443Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update maximum upload size setting

Update maximum upload size setting for a zone.

PATCH /v1/{crn}/zones/{zone_identifier}/settings/max_upload
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

Update maximum upload size setting

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/max_upload \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"value": 100}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "max_upload",
        "value": 100,
        "modified_on": "2018-12-08T18:58:39.110789Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

get TLS Client Auth setting

Get TLS Client Auth setting for a zone.

GET /v1/{crn}/zones/{zone_identifier}/settings/tls_client_auth
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

  • curl -X GET \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/tls_client_auth \
      -H 'content-type: application/json' \
      -H 'accept: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "tls_client_auth",
        "value": "off",
        "modified_on": "2018-12-08T13:51:54.514896Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }

Update TLS Client Auth setting

Update TLS Client Auth setting for a zone.

PATCH /v1/{crn}/zones/{zone_identifier}/settings/tls_client_auth
Request

Custom Headers

  • IBM Cloud user IAM token

Path Parameters

  • Full url-encoded cloud resource name (CRN) of resource instance

  • Zone identifier

Update TLS Client Auth setting

  • curl -X PATCH \
      https://api.cis.cloud.ibm.com/v1/:crn/zones/:zone_id/settings/tls_client_auth \
      -H 'content-type: application/json' \
      -H 'x-auth-user-token: Bearer xxxxxx' \
      -d '{"value": "on"}'
    
Response

Status Code

  • Success

  • Bad Request

  • Unauthorized

  • Forbidden! User has no privilege

  • Internal server error

Example responses
  • {
      "result": {
        "id": "tls_client_auth",
        "value": "on",
        "modified_on": "2018-12-08T18:58:06.627838Z",
        "editable": true
      },
      "success": true,
      "errors": [],
      "messages": []
    }