Update Resource Connector Group - Cloud Security API

{"type":"api","title":"Update Resource Connector Group","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/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":["Connector Groups","Secure Access"],"summary":"Update Resource Connector Group","description":"Update the `name` and `location` properties on the Resource Connector Group.","operationId":"putConnectorGroup","security":[{"oauthFlow":["deployments.resourceconnectors:write"]}],"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Connector Group.","schema":{"type":"integer"},"example":123455,"$$ref":"#/components/parameters/idConnectorGroup"}],"requestBody":{"description":"Set the properties on the Resource Connector Group.","content":{"application/json":{"schema":{"type":"object","description":"Create the Connector Group object.","properties":{"name":{"type":"string","description":"The name of the Resource Connector Group.\nThe name may include alphanumeric characters, and the space (' ') and hyphen (-) characters.","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9- ]+$","example":"NYC Connector Group","$$ref":"#/components/schemas/name"},"location":{"type":"string","description":"The region where the Resource Connector Group is available.","example":"us-west-2","$$ref":"#/components/schemas/location"},"environment":{"type":"string","description":"The type of cloud-native runtime environment that hosts the Resource Connector Group.","enum":["aws","azure","container","esx"],"default":"aws","$$ref":"#/components/schemas/environment"},"forwardDNS":{"type":"array","description":"The DNS configuration for the Connector Group.","items":{"type":"object","properties":{"dnsResourceId":{"type":"integer","description":"The ID for the DNS server that is associated with the Connector Group.","example":123456},"domains":{"type":"string","description":"A comma-separated list of domains. DNS requests for these domains are sent to the DNS server that is identified by `dnsResourceId`.","example":"domain1.com,domain2.com"}}},"example":[{"dnsResourceId":123456,"domains":"domain1.com,domain2.com"}],"$$ref":"#/components/schemas/forwardDNS"}},"required":["name","location"],"example":{"name":"NYC Connector Group","location":"us-west-2","environment":"aws"},"$$ref":"#/components/schemas/connectorGroupReq"},"example":{"name":"NYC Connector Group","location":"us-west-2","environment":"aws"}}},"required":false},"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":"The Resource Connector Group response object.","properties":{"id":{"description":"The ID of the Resource Connector Group.","type":"integer","readOnly":true,"example":1234557,"$$ref":"#/components/schemas/idConnectorGroup"},"name":{"type":"string","description":"The name of the Resource Connector Group.\nThe name may include alphanumeric characters, and the space (' ') and hyphen (-) characters.","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9- ]+$","example":"NYC Connector Group","$$ref":"#/components/schemas/name"},"location":{"type":"string","description":"The region where the Resource Connector Group is available.","example":"us-west-2","$$ref":"#/components/schemas/location"},"environment":{"type":"string","description":"The type of cloud-native runtime environment that hosts the Resource Connector Group.","enum":["aws","azure","container","esx"],"default":"aws","$$ref":"#/components/schemas/environment"},"forwardDNS":{"type":"array","description":"The DNS configuration for the Connector Group.","items":{"type":"object","properties":{"dnsResourceId":{"type":"integer","description":"The ID for the DNS server that is associated with the Connector Group.","example":123456},"domains":{"type":"string","description":"A comma-separated list of domains. DNS requests for these domains are sent to the DNS server that is identified by `dnsResourceId`.","example":"domain1.com,domain2.com"}}},"example":[{"dnsResourceId":123456,"domains":"domain1.com,domain2.com"}],"$$ref":"#/components/schemas/forwardDNS"},"provisioningKey":{"type":"string","description":"The Resource Connector Group's provisioning key.","example":"Zm9vYmFyYmF6MTIzNDU2Nzg5MDpiYXJmb29iYXoxMjM0NTY3ODkw"},"provisioningKeyExpiresAt":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the Resource Connector Group's provisioning key expires, specified in the ISO 8601 format.","example":"2023-03-14T18:34:25.412525046Z"},"baseImageDownloadUrl":{"type":"string","description":"The URL of the Connector Group's base image.","readOnly":true,"example":"https://foo.bar.com/baseimage"},"status":{"type":"string","description":"The label that describes the status of the Resource Connector Group.","enum":["waiting","connected","overloaded","disabled","disconnected"],"example":"connected"},"statusUpdatedAt":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the Resource Connector Group's status was updated, specified in the ISO 8601 format.","example":"2023-03-14T18:34:25.412525046Z"},"connectorsCount":{"type":"integer","description":"The number of Connectors in the Resource Connector Group.","example":5},"resourceIds":{"type":"array","description":"The list of resource IDs.","items":{"type":"integer"},"example":[12,34]},"createdAt":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the Resource Connector Group 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 Resource Connector Group was modified, specified in the ISO 8601 format.","example":"2023-03-14T18:34:25.412525046Z"},"connectedConnectorsCount":{"type":"integer","description":"The number of Connectors in the Resource Connector Group that are synced and connected.","example":4},"disconnectedConnectorsCount":{"type":"integer","description":"The number of Connectors in the Resource Connector Group that are disconnected.","example":2},"unabledToSyncConnectorsCount":{"type":"integer","description":"The number of Connectors in the Resource Connector Group that are unabled to sync.","example":3},"needUpdateConnectorsCount":{"type":"integer","description":"The number of Connectors in the Resource Connector Group that require an update.","example":1}},"example":{"id":1234567,"name":"NYC Connector Group","location":"us-west-2","environment":"aws","provisioningKey":"Zm9vYmFyYmF6MTIzNDU2Nzg5MDpiYXJmb29iYXoxMjM0NTY3ODkw","provisioningKeyExpiresAt":"2023-03-14T18:34:25.412525046Z","baseImageDownloadUrl":"https://foo.bar.com/baseimage","status":"connected","statusUpdatedAt":"2023-03-14T18:34:25.412525046Z","connectorsCount":5,"resourceIds":[12,34],"createdAt":"2023-03-14T18:34:25.412525046Z","modifiedAt":"2023-03-14T18:34:25.412525046Z","disconnectedConnectorsCount":2},"$$ref":"#/components/schemas/connectorGroupResponse"},"example":{"id":1234567,"name":"NYC Connector Group","location":"us-west-2","environment":"aws","provisioningKey":"Zm9vYmFyYmF6MTIzNDU2Nzg5MDpiYXJmb29iYXoxMjM0NTY3ODkw","provisioningKeyExpiresAt":"2023-03-14T18:34:25.412525046Z","baseImageDownloadUrl":"https://foo.bar.com/baseimage","status":"connected","statusUpdatedAt":"2023-03-14T18:34:25.412525046Z","connectorsCount":5,"resourceIds":[12,34],"createdAt":"2023-03-14T18:34:25.412525046Z","modifiedAt":"2023-03-14T18:34:25.412525046Z","disconnectedConnectorsCount":2}}}},"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","description":"The validation error information.","properties":{"name":{"type":"string","description":"Indicates the problem with `name` property in the payload.","example":"The `name` property is a string with at least one character and no more than 50 characters."},"location":{"type":"string","description":"Indicates the problem with the `location` property in the payload.","example":"The property value is invalid."},"environment":{"type":"string","description":"Indicates the problem with `environment` 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/400ConnectorGroupError"},"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":"putConnectorGroup","method":"put","path":"/connectorGroups/{id}"}}