Annotations

Last updated 2 months ago

Was this helpful?

Read annotation

get

Path parameters

keystringrequired

Attestation value to annotate

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/auth/ratls/annotations/{key}'

200

{
  "auth": {},
  "data": {
    "created": 1,
    "key": "text",
    "value": "text"
  }
}

Delete annotation

delete

Path parameters

keystringrequired

Attestation value to annotate

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/v1/auth/ratls/annotations/{key}'

200

No body

List annotations

get

Query parameters

liststring · enumrequired

Must be set to true

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/auth/ratls/annotations/?list=true'

200

{
  "auth": {},
  "data": {
    "keys": [
      {}
    ]
  }
}

Create annotation

put

Body

createdinteger · int64required

Creation timestamp, set by the plugin

keystringrequired

Attestation value to annotate

valuestringrequired

Human-readable description for the attestation value

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/v1/auth/ratls/annotations' \
  --header 'Content-Type: application/json' \
  --data '{
    "created": 1,
    "key": "text",
    "value": "text"
  }'

200

{
  "auth": {},
  "data": {
    "created": 1,
    "key": "text",
    "value": "text"
  }
}