Cloud Connection
Update Cloud Connection
Endpoint to update an existing Cloud Connection
put/cloud-connection/{id}
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring uuid required
ID of the Cloud Connection to update
Request body
Example request
{
"data": {
"name": "Example Text",
"secrets": "This is an example of longer text content that provides detailed information.",
"isEnabled": true
}
}Response
Updated successfully
Example response
{
"data": {
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"createdAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"updatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"deletedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"project": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"name": "Example Text",
"provider": "Example Text",
"config": {
"key": "value",
"nested": {
"data": 123
}
},
"isEnabled": true,
"service": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"serviceId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"nextPullAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"lastPulledAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"lastSuccessfulPullAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"lastPullResult": {
"key": "value",
"nested": {
"data": 123
}
},
"lastError": "This is an example of longer text content that provides detailed information.",
"streamKeyCreatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"streamSummary": {
"key": "value",
"nested": {
"data": 123
}
},
"createdByUser": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"deletedByUser": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"deletedByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.