Update saved query

PUT/v2/apl-starred-queries/{id}

Replaces the name, dataset, query, and metadata of a saved query. With a personal access token, you can only update queries you saved.

Parameters

Property	Type	Location	Description
`id`	`string`Required	`path`

Body

application/json

Property	Type	Description
`dataset`	`string`
`kind`	`string`Required
`metadata`	`object`Required
`name`	`string`Required
`query`	`object`Required
`apl`	`string`Required
`cursor`	`string`
`defaultLimit`	`integer<int64>`
`defaultOrder`	`object[]`
`desc`	`boolean`
`field`	`string`
`endTime`	`string`
`includeCursor`	`boolean`
`includeCursorField`	`boolean`
`libraries`	`string[]`
`queryOptions`	`object`
`disableCache`	`boolean`
`disableStats`	`boolean`
`disableTrace`	`boolean`
`maxDataPoints`	`integer<int64>`
`maxSeries`	`integer<int64>`
`noAggregation`	`boolean`
`noFill`	`boolean`
`noInterpolation`	`boolean`
`priority`	`string`
`resolution`	`string`
`displayNull`	`string`	Controls how empty intervals are rendered in time series charts. `auto` infers from the query, `null` leaves gaps, `span` connects adjacent points, `zero` fills with zero.
`overlayCharts`	`string`	When enabled, charts are overlaid on a single chart instead of stacked separately.
`shownColumns`	`string`
`timeSeriesVariant`	`string`
`timeSeriesView`	`string`
`startTime`	`string`
`variables`	`object`
`who`	`string`Required

Request

curl -X PUT 'https://api.axiom.co/v2/apl-starred-queries/ID' \
  -H 'Authorization: Bearer API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"dataset":"string","kind":"apl","metadata":{},"name":"string","query":{"apl":"string","cursor":"string","defaultLimit":0,"defaultOrder":[{"desc":true,"field":"string"}],"endTime":"string","includeCursor":true,"includeCursorField":true,"libraries":["string"],"queryOptions":{"disableCache":true,"disableStats":true,"disableTrace":true,"maxDataPoints":0,"maxSeries":0,"noAggregation":true,"noFill":true,"noInterpolation":true,"priority":"low","resolution":"string","displayNull":"auto","overlayCharts":"true","shownColumns":"string","timeSeriesVariant":"area","timeSeriesView":"charts"},"startTime":"string","variables":{}},"who":"string"}'

Try itRun this request against your Axiom organization

Credentials stay in this browser tab and are only sent to Axiom when you run the request.

API token Requiredid pathRequiredRequest body application/json

Response

200Updated saved query.

application/json

400Missing `name`, or no `dataset` given and none found in `query.apl`.

401The saved query belongs to another user.

403You don't have permission to update saved queries on the current or new dataset.

404Saved query not found.