--- title: "Update Cloud Connection" method: PUT path: "/cloud-connection/{id}" tags: ["Cloud Connection"] --- # Update Cloud Connection `PUT /cloud-connection/{id}` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/cloud-connection/{id}` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to update an existing Cloud Connection ## Path parameters - `id` string, uuid, required ## Request body - object - `data` CloudConnectionUpdateSchema, required: Update schema for CloudConnection model. Update - `name` string: Friendly name for this connection. Permissions - Create: [Project Owner, Project Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [Project Owner, Project Admin] - `config` object: The cloud's settings that are not secret, such as a role ARN, a tenant or the regions to read. Keys are defined by the cloud. Permissions - Create: [Project Owner, Project Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [Project Owner, Project Admin] - `secrets` string, password: The cloud's secrets (a secret access key, a client secret, a service account key) as a JSON object. Encrypted at rest and never returned by the API. Permissions - Create: [Project Owner, Project Admin], Read: [No access - you don't have permission for this operation], Update: [Project Owner, Project Admin] - `isEnabled` boolean: Whether this connection is read on its schedule. Permissions - Create: [Project Owner, Project Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [Project Owner, Project Admin] ## Response `200` Updated successfully - object - `data` CloudConnectionReadSchema: Read schema for CloudConnection model. Read - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [Project Owner, Project Admin] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [Project Owner, Project Admin] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [Project Owner, Project Admin] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [Project Owner, Project Admin] - `projectId` string, uuid: ID of the project this connection belongs to. Permissions - Create: [Project Owner, Project Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [No access - you don't have permission for this operation] - `name` string, required: Friendly name for this connection. Permissions - Create: [Project Owner, Project Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [Project Owner, Project Admin] - `provider` 'aws' | 'gcp' | 'azure', required: Which cloud this connection reads: 'aws', 'azure' or 'gcp'. Fixed once created. Permissions - Create: [Project Owner, Project Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [No access - you don't have permission for this operation] - `config` object: The cloud's settings that are not secret, such as a role ARN, a tenant or the regions to read. Keys are defined by the cloud. Permissions - Create: [Project Owner, Project Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [Project Owner, Project Admin] - `isEnabled` boolean: Whether this connection is read on its schedule. Permissions - Create: [Project Owner, Project Admin], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [Project Owner, Project Admin] - `serviceId` string, uuid: ID of the telemetry service the metrics this connection reads belong to. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [No access - you don't have permission for this operation] - `nextPullAt` object: When the connection is read next. Empty means as soon as possible. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [No access - you don't have permission for this operation] - `lastPulledAt` object: When the connection was last read. Empty means never. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [No access - you don't have permission for this operation] - `lastSuccessfulPullAt` object: When a read last finished without an error. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [No access - you don't have permission for this operation] - `lastPullResult` object: What the last read found: the accounts, the resources by type and region, and the metrics it wrote. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [No access - you don't have permission for this operation] - `lastError` string: Why the last read failed, with credentials removed. Cleared by the next read that works. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [No access - you don't have permission for this operation] - `streamKeyCreatedAt` object: When the connection's stream key was made. Empty means it streams nothing. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [No access - you don't have permission for this operation] - `streamSummary` object: What the connection's Firehose streams delivered: the accounts, Regions and namespaces of metrics, the log groups, and the last delivery refused. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [No access - you don't have permission for this operation] - `createdByUserId` string, uuid: ID of the user who created this connection. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [No access - you don't have permission for this operation] - `deletedByUserId` string, uuid: ID of the user who deleted this connection. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [No access - you don't have permission for this operation] ## Other responses - `400`: Bad request. This response indicates that the request was malformed or contained invalid data. - `401`: Unauthorized. This response indicates that the request requires user authentication. - `402`: Payment Required. This response indicates that the request requires payment or a valid subscription. - `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it. - `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each. - `405`: Project not found. This response indicates that the requested project does not exist or is not accessible. - `408`: Request Timeout. This response indicates that the server timed out waiting for the request. - `415`: Unable to reach server. This response indicates that the server is currently unreachable or down. - `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource. - `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. --- [API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)