PUT
/
apl-starred-queries
/
{id}
curl --request PUT \
  --url https://api.axiom.co/v2/apl-starred-queries/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "dataset": "<string>",
  "kind": "apl",
  "metadata": {},
  "name": "<string>",
  "query": {
    "apl": "<string>",
    "cursor": "<string>",
    "defaultLimit": 123,
    "defaultOrder": [
      {
        "desc": true,
        "field": "<string>"
      }
    ],
    "endTime": "<string>",
    "includeCursor": true,
    "includeCursorField": true,
    "libraries": [
      "<string>"
    ],
    "queryOptions": {
      "disableCache": true,
      "disableStats": true,
      "disableTrace": true,
      "maxDataPoints": 123,
      "maxSeries": 123,
      "noAggregation": true,
      "noFill": true,
      "noInterpolation": true,
      "priority": "low",
      "resolution": "<string>"
    },
    "startTime": "<string>",
    "variables": {}
  },
  "who": "<string>"
}'
{
  "dataset": "<string>",
  "kind": "apl",
  "metadata": {},
  "name": "<string>",
  "query": {
    "apl": "<string>",
    "cursor": "<string>",
    "defaultLimit": 123,
    "defaultOrder": [
      {
        "desc": true,
        "field": "<string>"
      }
    ],
    "endTime": "<string>",
    "includeCursor": true,
    "includeCursorField": true,
    "libraries": [
      "<string>"
    ],
    "queryOptions": {
      "disableCache": true,
      "disableStats": true,
      "disableTrace": true,
      "maxDataPoints": 123,
      "maxSeries": 123,
      "noAggregation": true,
      "noFill": true,
      "noInterpolation": true,
      "priority": "low",
      "resolution": "<string>"
    },
    "startTime": "<string>",
    "variables": {}
  },
  "who": "<string>",
  "id": "<string>"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
id
string
required

Body

application/json
​
kind
enum<string>
required
Available options:
apl
​
metadata
object
required
​
name
string
required
​
query
object
required
​
who
string
required
​
dataset
string

Response

200 - application/json
StarredQueryWithId
​
kind
enum<string>
required
Available options:
apl
​
metadata
object
required
​
name
string
required
​
query
object
required
​
who
string
required
​
id
string
required
​
dataset
string

Was this page helpful?

Suggest editsRaise issue