Patch Connector - Cloud Security API

{"type":"api","title":"Patch Connector","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/d2a1854d5c0ed9069a7f0bc54a9b813f3075ddc9/285f00e0-2a84-3aa5-a063-4c30a2b82db0","info":{"title":"Cisco Secure Access Resource Connector Groups and Resource Connectors API","description":"Manage the Resource Connector Groups and Resource Connectors in the organization.\n","version":"1.0.0","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Connector Groups","description":"Manage the Resource Connector Groups."},{"name":"Connectors","description":"Manage the Resource Connectors."},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/deployments/connector-groups-overview.md","uri":"secure-access-api-reference-connector-groups-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"deployments/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"Client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.sse.cisco.com/auth/v2/token","scopes":{"deployments.resourceconnectors:read":"Read the Resource Connector Group or Connector resources","deployments.resourceconnectors:write":"Write the Resource Connector Group or Connector resources"}}}}}},"spec":{"tags":["Connectors","Secure Access"],"summary":"Patch Connector","description":"Update the properties on the Connector.","operationId":"patchConnector","security":[{"oauthFlow":["deployments.resourceconnectors:write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Connector.","schema":{"type":"integer"},"example":123455,"$$ref":"#/components/parameters/idConnector"}],"requestBody":{"description":"Update the properties on the Connector.","content":{"application/json":{"schema":{"type":"array","description":"Update the list of properties on the Connector.","items":{"type":"object","description":"The properties to set on the Connector.","properties":{"op":{"description":"The label that describes the type of operation.","type":"string","enum":["replace"],"example":"replace","$$ref":"#/components/schemas/op"},"path":{"type":"string","enum":["/enabled","/confirmed","/revoked"],"description":"The Connector property.\nYou can set the following properties on the Connector: `enabled`, `confirmed`, and `revoked`.","example":"/enabled"},"value":{"type":"boolean","description":"The value of the property. When the value of the `path` field is `confirmed` or `revoked`, set the `value` property to `true`.","example":true}}},"example":[{"op":"replace","path":"/confirmed","value":true}],"$$ref":"#/components/schemas/connectorPatchReq"},"example":[{"op":"replace","path":"/confirmed","value":true}]}}},"responses":{"200":{"description":"OK","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"Get the details about the Connector.","properties":{"id":{"type":"integer","description":"The ID of the Connector.","readOnly":true,"example":123456,"$$ref":"#/components/schemas/idConnector"},"groupId":{"description":"The ID of the Resource Connector Group.","type":"integer","readOnly":true,"example":1234557,"$$ref":"#/components/schemas/idConnectorGroup"},"instanceId":{"type":"string","description":"The globally unique ID of the Connector instance.","example":"i-04568b6cdaeedda25a"},"confirmed":{"type":"boolean","description":"Indicates whether the Connector exists.","default":false,"example":true},"enabled":{"type":"boolean","description":"Indicates whether the Connector can receive traffic.","default":false,"example":true},"version":{"type":"string","description":"The runtime version of the Connector image.","readOnly":true,"example":"v10.1"},"sha1":{"type":"string","description":"The unique ID of the Connector formatted as a hash string.","example":"2aae6c35c94fcfb415dbe95f408b9ce91ee846ed"},"hostname":{"type":"string","description":"The unique hostname of the device that manages the runtime of the Connector.","example":"i-0123456789abcdef.us-west-2.compute.internal"},"originIpAddress":{"type":"string","description":"The IP address of the Connector.","readOnly":true,"example":"10.45.102.214"},"baseVersion":{"type":"string","description":"The base OS version of the Connector image.\nUpdating the base OS version requires that you download and redeploy the latest Connector image.","readOnly":true,"example":"240127"},"isLatestBaseVersion":{"type":"boolean","description":"Indicates whether the Connector is using the latest available image.\nIf this value is false, a new image is available to download. We recommend that you redeploy this Connector with the latest image.","readOnly":true,"example":true},"upgradeStatus":{"type":"string","description":"Indicates the status of the latest over-the-air update for this Connector.\nOver-the-air updates modify the Connector agent software, which are made without downloading a new image and redeploying the Connector.","enum":["successful","in_progress","failed","unknown"],"readOnly":true,"example":"successful"},"status":{"type":"string","description":"The label that describes the status of the Connector.","enum":["disconnected","connected","announced","reachable","disabled"],"readOnly":true,"default":"announced"},"statusUpdatedAt":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the Connector was updated, specified in the ISO 8601 format.","example":"2023-03-14T18:34:25.412525046Z"},"controlStatusUpdatedAt":{"type":"string","description":"The date and time when the Connector's controller status was last updated, specified in the ISO 8601 format.","format":"date-time","readOnly":true,"example":"2023-03-15T01:22:45.915326851Z"},"revoked_at":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the Connector was removed, specified in the ISO 8601 format.","example":"2023-03-14T18:34:25.412525046Z"},"createdAt":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the Connector was created, specified in the ISO 8601 format.","example":"2023-03-14T18:34:25.412525046Z"},"modifiedAt":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the Connector was last modified, specified in the ISO 8601 format.","example":"2023-03-14T18:34:25.412525046Z"}},"example":{"id":123456,"groupId":123964,"instanceId":"i-04568b6cdaeedda25a","confirmed":true,"enabled":true,"version":"v10.1","sha1":"2aae6c35c94fcfb415dbe95f408b9ce91ee846ed","hostname":"i-0123456789abcdef.us-west-2.compute.internal","originIpAddress":"10.45.102.214","status":"connected","statusUpdatedAt":"2023-03-14T18:34:25.412525046Z","revoked_at":"2023-03-14T18:34:25.412525046Z","createdAt":"2023-03-14T18:34:25.412525046Z","modifiedAt":"2023-03-14T18:34:25.412525046Z","baseVersion":"240127","isLatestBaseVersion":true,"upgradeStatus":"successful"},"$$ref":"#/components/schemas/connectorResponse"},"example":{"id":123456,"groupId":123964,"instanceId":"i-04568b6cdaeedda25a","confirmed":true,"enabled":true,"version":"v10.1","sha1":"2aae6c35c94fcfb415dbe95f408b9ce91ee846ed","hostname":"i-0123456789abcdef.us-west-2.compute.internal","originIpAddress":"10.45.102.214","status":"connected","statusUpdatedAt":"2023-03-14T18:34:25.412525046Z","revoked_at":"2023-03-14T18:34:25.412525046Z","createdAt":"2023-03-14T18:34:25.412525046Z","modifiedAt":"2023-03-14T18:34:25.412525046Z","baseVersion":"240127","isLatestBaseVersion":true,"upgradeStatus":"successful"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"The organization ID is a numeric value."},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"},"validationErrors":{"type":"object","properties":{"enabled":{"type":"string","description":"Indicates the problem with \"enabled\" property in the payload.","example":"The property value is invalid."},"confirmed":{"type":"string","description":"Indicates the problem with \"confirmed\" property in the payload.","example":"The property value is invalid."}}}}}}},"headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"$$ref":"#/components/responses/400ConnectorAgentError"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Authorization token is invalid."},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Not Authorized"},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Not Found"},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Internal Server Error"},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"patchConnector","method":"patch","path":"/connectorAgents/{id}"}}