Delete Samples By Range

Delete samples belonging to a single timeseries and metric, which occured between the specified start and end time.

URL

https://{{HOST}}/timeseries/timeseries/{timeseries_id}/samples

Method

DELETE

Required IMS Scopes

  • Read
  • Write

Required ACL Permissions

  • owner
  • admin

Versions Supported

  • 2.3

URL Path Parameters

Name Description Example Type
timeseries_id
required
Timeseries Id of the samples to be deleted fb6ec89e-f4dc-4f37-823e-c49b69f23cdb string

URL Query Parameters

Name Description Example Type
v
required
Version of the API to use v=2.3 string
metric
required
Metric from which to delete samples QuarterlyHourAverage string
startTime
optional
Starting time of the target period 1485812700000 Unix Timestamp
endTime
optional
Ending time of the target period 1485812800000 Unix Timestamp

Request Header Parameters

Type Value Description
Authentication
required
Bearer {access_token} Retrieve access token

Example

Request

curl -X DELETE 
  'https://{{HOST}}/timeseries/timeseries/fb6ec89e-f4dc-4f37-823e-c49b69f23cdb/samples?metric=QuarterlyHourAverage&startTime=1485812700000&endTime=1485725280000&v=2.3' 
  -H 'Authorization: Bearer {access_token} 

Errors

Error Description
400 Bad Request
403 Forbidden
404 Not Found
429 Server Too Busy
500 Internal Server Error