Network Site
Update Network Site
Endpoint to update an existing Network Site
put/network-site/{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 Network Site to update
Request body
Example request
{
"data": {
"name": "Example Text",
"healthRollupPolicy": "Example Text",
"offlineThresholdPercent": 42,
"shouldAlertWhenUnhealthy": 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",
"slug": "example-slug",
"description": "This is an example of longer text content that provides detailed information.",
"siteType": "Example Text",
"networkSiteType": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"networkSiteTypeId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"probe": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"probeId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"snmpCredentialProfile": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"snmpCredentialProfileId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"parentSite": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"parentSiteId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"materializedPath": "This is an example of longer text content that provides detailed information.",
"depth": 42,
"address": "Example Text",
"latitude": 42,
"longitude": 42,
"currentMonitorStatus": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"currentMonitorStatusId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"lastRollupAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"healthRollupPolicy": "Example Text",
"offlineThresholdPercent": 42,
"shouldAlertWhenUnhealthy": true,
"alertSeverity": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"alertSeverityId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"currentActiveAlertId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"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.