Telemetry Ingestion Key
Get Telemetry Ingestion Key
Endpoint to retrieve a single Telemetry Ingestion Key by ID
post/telemetry-ingestion-key/{id}/get-item
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 Telemetry Ingestion Key to retrieve
Request body
Example request
{
"select": {
"_id": true,
"createdAt": true,
"updatedAt": true,
"name": true,
"keyType": true,
"pinnedServiceName": true
}
}Response
Successful response
Example response
{
"data": {
"_id": "123e4567-e89b-12d3-a456-426614174000",
"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"
},
"version": 42,
"projectId": "123e4567-e89b-12d3-a456-426614174000",
"name": "Production Telemetry Key",
"description": "This key is used for ingesting telemetry data from production services",
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
"secretKey": "123e4567-e89b-12d3-a456-426614174000",
"keyType": "Server",
"allowedOrigins": {
"key": "value",
"nested": {
"data": 123
}
},
"pinnedServiceName": "checkout-web",
"isEnabled": true,
"expiresAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"lastUsedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"requestsPerMinuteLimit": 42
}
}Changes
No recorded changes to this operation across all 1 revision of this API.