PureBasic / Core Services API / UpdateIPSecConnection
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "cpeLocalIdentifier": "in consectetur irure",
; "cpeLocalIdentifierType": "HOSTNAME",
; "definedTags": {},
; "displayName": "adipisicing pariatur culpa enim",
; "freeformTags": {},
; "staticRoutes": [
; "dolor dolore do",
; "ut tempor labo"
; ]
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"cpeLocalIdentifier","in consectetur irure")
CkJsonObject::ckUpdateString(json,"cpeLocalIdentifierType","HOSTNAME")
CkJsonObject::ckUpdateNewObject(json,"definedTags")
CkJsonObject::ckUpdateString(json,"displayName","adipisicing pariatur culpa enim")
CkJsonObject::ckUpdateNewObject(json,"freeformTags")
CkJsonObject::ckUpdateString(json,"staticRoutes[0]","dolor dolore do")
CkJsonObject::ckUpdateString(json,"staticRoutes[1]","ut tempor labo")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"x-content-sha256","{{content_sha256}}")
CkHttp::ckSetRequestHeader(http,"Authorization","{{signature}}")
CkHttp::ckSetRequestHeader(http,"Date","{{date}}")
CkHttp::ckSetRequestHeader(http,"if-match","officia sed")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PUT","https://iaas.{{region}}.oraclecloud.com/20160918/ipsecConnections/:ipscId",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "compartmentId": "magna proident dolor",
; "id": "proident ipsum Excepteur",
; "drgId": "amet velit fugiat",
; "cpeId": "et enim exercitation voluptate ut",
; "lifecycleState": "TERMINATED",
; "staticRoutes": [
; "n",
; "i"
; ],
; "cpeLocalIdentifier": "anim est in reprehenderit",
; "cpeLocalIdentifierType": "HOSTNAME",
; "definedTags": {},
; "displayName": "sit",
; "freeformTags": {},
; "timeCreated": "1953-03-10T14:08:02.379Z"
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
strVal.s
compartmentId.s = CkJsonObject::ckStringOf(jResp,"compartmentId")
id.s = CkJsonObject::ckStringOf(jResp,"id")
drgId.s = CkJsonObject::ckStringOf(jResp,"drgId")
cpeId.s = CkJsonObject::ckStringOf(jResp,"cpeId")
lifecycleState.s = CkJsonObject::ckStringOf(jResp,"lifecycleState")
cpeLocalIdentifier.s = CkJsonObject::ckStringOf(jResp,"cpeLocalIdentifier")
cpeLocalIdentifierType.s = CkJsonObject::ckStringOf(jResp,"cpeLocalIdentifierType")
displayName.s = CkJsonObject::ckStringOf(jResp,"displayName")
timeCreated.s = CkJsonObject::ckStringOf(jResp,"timeCreated")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"staticRoutes")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"staticRoutes[i]")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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 '{
"cpeLocalIdentifier": "in consectetur irure",
"cpeLocalIdentifierType": "HOSTNAME",
"definedTags": {},
"displayName": "adipisicing pariatur culpa enim",
"freeformTags": {},
"staticRoutes": [
"dolor dolore do",
"ut tempor labo"
]
}'
https://iaas.{{region}}.oraclecloud.com/20160918/ipsecConnections/:ipscId
Postman Collection Item JSON
{
"name": "UpdateIPSecConnection",
"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 \"cpeLocalIdentifier\": \"in consectetur irure\",\n \"cpeLocalIdentifierType\": \"HOSTNAME\",\n \"definedTags\": {},\n \"displayName\": \"adipisicing pariatur culpa enim\",\n \"freeformTags\": {},\n \"staticRoutes\": [\n \"dolor dolore do\",\n \"ut tempor labo\"\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/ipsecConnections/:ipscId",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections",
":ipscId"
],
"variable": [
{
"key": "ipscId",
"value": "amet ut",
"description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
}
]
},
"description": "Updates the specified IPSec connection.\n\nTo update an individual IPSec tunnel's attributes, use\n[UpdateIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/UpdateIPSecConnectionTunnel).\n"
},
"response": [
{
"name": "The IPSec connection 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 \"cpeLocalIdentifier\": \"veniam\",\n \"cpeLocalIdentifierType\": \"HOSTNAME\",\n \"definedTags\": {},\n \"displayName\": \"aute nostrud\",\n \"freeformTags\": {},\n \"staticRoutes\": [\n \"sunt quis\",\n \"magna do\"\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/ipsecConnections/:ipscId",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections",
":ipscId"
],
"variable": [
{
"key": "ipscId"
}
]
}
},
"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 \"compartmentId\": \"magna proident dolor\",\n \"id\": \"proident ipsum Excepteur\",\n \"drgId\": \"amet velit fugiat\",\n \"cpeId\": \"et enim exercitation voluptate ut\",\n \"lifecycleState\": \"TERMINATED\",\n \"staticRoutes\": [\n \"n\",\n \"i\"\n ],\n \"cpeLocalIdentifier\": \"anim est in reprehenderit\",\n \"cpeLocalIdentifierType\": \"HOSTNAME\",\n \"definedTags\": {},\n \"displayName\": \"sit\",\n \"freeformTags\": {},\n \"timeCreated\": \"1953-03-10T14:08:02.379Z\"\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 \"cpeLocalIdentifier\": \"veniam\",\n \"cpeLocalIdentifierType\": \"HOSTNAME\",\n \"definedTags\": {},\n \"displayName\": \"aute nostrud\",\n \"freeformTags\": {},\n \"staticRoutes\": [\n \"sunt quis\",\n \"magna do\"\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/ipsecConnections/:ipscId",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections",
":ipscId"
],
"variable": [
{
"key": "ipscId"
}
]
}
},
"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 \"cpeLocalIdentifier\": \"veniam\",\n \"cpeLocalIdentifierType\": \"HOSTNAME\",\n \"definedTags\": {},\n \"displayName\": \"aute nostrud\",\n \"freeformTags\": {},\n \"staticRoutes\": [\n \"sunt quis\",\n \"magna do\"\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/ipsecConnections/:ipscId",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections",
":ipscId"
],
"variable": [
{
"key": "ipscId"
}
]
}
},
"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 \"cpeLocalIdentifier\": \"veniam\",\n \"cpeLocalIdentifierType\": \"HOSTNAME\",\n \"definedTags\": {},\n \"displayName\": \"aute nostrud\",\n \"freeformTags\": {},\n \"staticRoutes\": [\n \"sunt quis\",\n \"magna do\"\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/ipsecConnections/:ipscId",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections",
":ipscId"
],
"variable": [
{
"key": "ipscId"
}
]
}
},
"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 \"cpeLocalIdentifier\": \"veniam\",\n \"cpeLocalIdentifierType\": \"HOSTNAME\",\n \"definedTags\": {},\n \"displayName\": \"aute nostrud\",\n \"freeformTags\": {},\n \"staticRoutes\": [\n \"sunt quis\",\n \"magna do\"\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/ipsecConnections/:ipscId",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections",
":ipscId"
],
"variable": [
{
"key": "ipscId"
}
]
}
},
"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 \"cpeLocalIdentifier\": \"veniam\",\n \"cpeLocalIdentifierType\": \"HOSTNAME\",\n \"definedTags\": {},\n \"displayName\": \"aute nostrud\",\n \"freeformTags\": {},\n \"staticRoutes\": [\n \"sunt quis\",\n \"magna do\"\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/ipsecConnections/:ipscId",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections",
":ipscId"
],
"variable": [
{
"key": "ipscId"
}
]
}
},
"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 \"cpeLocalIdentifier\": \"veniam\",\n \"cpeLocalIdentifierType\": \"HOSTNAME\",\n \"definedTags\": {},\n \"displayName\": \"aute nostrud\",\n \"freeformTags\": {},\n \"staticRoutes\": [\n \"sunt quis\",\n \"magna do\"\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/ipsecConnections/:ipscId",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections",
":ipscId"
],
"variable": [
{
"key": "ipscId"
}
]
}
},
"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 \"cpeLocalIdentifier\": \"veniam\",\n \"cpeLocalIdentifierType\": \"HOSTNAME\",\n \"definedTags\": {},\n \"displayName\": \"aute nostrud\",\n \"freeformTags\": {},\n \"staticRoutes\": [\n \"sunt quis\",\n \"magna do\"\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/ipsecConnections/:ipscId",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections",
":ipscId"
],
"variable": [
{
"key": "ipscId"
}
]
}
},
"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}"
}
]
}
