Chilkat Online Tools

TCL / Core Services API / UpdateInternetGateway

Back to Collection Items

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "definedTags": {},
#   "displayName": "mollit Duis ad consequat",
#   "freeformTags": {},
#   "isEnabled": false
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateNewObject $json "definedTags"
CkJsonObject_UpdateString $json "displayName" "mollit Duis ad consequat"
CkJsonObject_UpdateNewObject $json "freeformTags"
CkJsonObject_UpdateBool $json "isEnabled" 0

CkHttp_SetRequestHeader $http "Content-Type" "application/json"
CkHttp_SetRequestHeader $http "x-content-sha256" "{{content_sha256}}"
CkHttp_SetRequestHeader $http "Authorization" "{{signature}}"
CkHttp_SetRequestHeader $http "Date" "{{date}}"
CkHttp_SetRequestHeader $http "if-match" "officia sed"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PUT" "https://iaas.{{region}}.oraclecloud.com/20160918/internetGateways/:igId" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "id": "quis laborum eu",
#   "compartmentId": "sed",
#   "lifecycleState": "AVAILABLE",
#   "vcnId": "fugiat nostrud",
#   "definedTags": {},
#   "displayName": "Ut reprehend",
#   "freeformTags": {},
#   "isEnabled": true,
#   "timeCreated": "1994-01-17T22:51:32.949Z"
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

set id [CkJsonObject_stringOf $jResp "id"]
set compartmentId [CkJsonObject_stringOf $jResp "compartmentId"]
set lifecycleState [CkJsonObject_stringOf $jResp "lifecycleState"]
set vcnId [CkJsonObject_stringOf $jResp "vcnId"]
set displayName [CkJsonObject_stringOf $jResp "displayName"]
set isEnabled [CkJsonObject_BoolOf $jResp "isEnabled"]
set timeCreated [CkJsonObject_stringOf $jResp "timeCreated"]

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X PUT
	-H "if-match: officia sed"
	-H "Content-Type: application/json"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
	-H "x-content-sha256: {{content_sha256}}"
	-d '{
    "definedTags": {},
    "displayName": "mollit Duis ad consequat",
    "freeformTags": {},
    "isEnabled": false
}'
https://iaas.{{region}}.oraclecloud.com/20160918/internetGateways/:igId

Postman Collection Item JSON

{
  "name": "UpdateInternetGateway",
  "request": {
    "method": "PUT",
    "header": [
      {
        "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
        "key": "if-match",
        "value": "officia sed"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Date",
        "value": "{{date}}",
        "description": "(Required) Current Date",
        "type": "text"
      },
      {
        "key": "Authorization",
        "value": "{{signature}}",
        "description": "(Required) Signature Authentication on Authorization header",
        "type": "text"
      },
      {
        "key": "x-content-sha256",
        "value": "{{content_sha256}}",
        "description": "(Required) Content sha256 for POST, PUT and PATCH operations",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"mollit Duis ad consequat\",\n    \"freeformTags\": {},\n    \"isEnabled\": false\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/internetGateways/:igId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "internetGateways",
        ":igId"
      ],
      "variable": [
        {
          "key": "igId",
          "value": "ocid1.internetgateway.oc1....",
          "description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the internet gateway."
        }
      ]
    },
    "description": "Updates the specified internet gateway. You can disable/enable it, or change its display name\nor tags. Avoid entering confidential information.\n\nIf the gateway is disabled, that means no traffic will flow to/from the internet even if there's\na route rule that enables that traffic.\n"
  },
  "response": [
    {
      "name": "The internet gateway was updated.",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"mollit Duis ad consequat\",\n    \"freeformTags\": {},\n    \"isEnabled\": false\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/internetGateways/:igId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "internetGateways",
            ":igId"
          ],
          "variable": [
            {
              "key": "igId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "etag",
          "value": "officia sed",
          "description": "For optimistic concurrency control. See `if-match`.\n"
        },
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"id\": \"quis laborum eu\",\n \"compartmentId\": \"sed\",\n \"lifecycleState\": \"AVAILABLE\",\n \"vcnId\": \"fugiat nostrud\",\n \"definedTags\": {},\n \"displayName\": \"Ut reprehend\",\n \"freeformTags\": {},\n \"isEnabled\": true,\n \"timeCreated\": \"1994-01-17T22:51:32.949Z\"\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"mollit Duis ad consequat\",\n    \"freeformTags\": {},\n    \"isEnabled\": false\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/internetGateways/:igId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "internetGateways",
            ":igId"
          ],
          "variable": [
            {
              "key": "igId"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"mollit Duis ad consequat\",\n    \"freeformTags\": {},\n    \"isEnabled\": false\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/internetGateways/:igId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "internetGateways",
            ":igId"
          ],
          "variable": [
            {
              "key": "igId"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Not Found",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"mollit Duis ad consequat\",\n    \"freeformTags\": {},\n    \"isEnabled\": false\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/internetGateways/:igId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "internetGateways",
            ":igId"
          ],
          "variable": [
            {
              "key": "igId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Conflict",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"mollit Duis ad consequat\",\n    \"freeformTags\": {},\n    \"isEnabled\": false\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/internetGateways/:igId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "internetGateways",
            ":igId"
          ],
          "variable": [
            {
              "key": "igId"
            }
          ]
        }
      },
      "status": "Conflict",
      "code": 409,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Precondition Failed",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"mollit Duis ad consequat\",\n    \"freeformTags\": {},\n    \"isEnabled\": false\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/internetGateways/:igId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "internetGateways",
            ":igId"
          ],
          "variable": [
            {
              "key": "igId"
            }
          ]
        }
      },
      "status": "Precondition Failed",
      "code": 412,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Internal Server Error",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"mollit Duis ad consequat\",\n    \"freeformTags\": {},\n    \"isEnabled\": false\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/internetGateways/:igId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "internetGateways",
            ":igId"
          ],
          "variable": [
            {
              "key": "igId"
            }
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "An error has occurred.",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"mollit Duis ad consequat\",\n    \"freeformTags\": {},\n    \"isEnabled\": false\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/internetGateways/:igId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "internetGateways",
            ":igId"
          ],
          "variable": [
            {
              "key": "igId"
            }
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    }
  ]
}