Annotations

List annotations

GET/v1/auth/ratls/annotations/

Query parameters

Response

200

OK

Body

application/json

authobject

dataobject

Request

JavaScriptCurlPython

const response = await fetch('/v1/auth/ratls/annotations/?list=true', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Create annotation

PUT/v1/auth/ratls/annotations

Body

application/json

created*integer (int64)

Creation timestamp, set by the plugin

key*string

Attestation value to annotate

value*string

Human-readable description for the attestation value

Response

200

OK

Body

application/json

authobject

dataobject

Request

JavaScriptCurlPython

const response = await fetch('/v1/auth/ratls/annotations', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "created": 0,
      "key": "text",
      "value": "text"
    }),
});
const data = await response.json();

Response

200

{
  "data": {
    "created": 0,
    "key": "text",
    "value": "text"
  }
}

Read annotation

GET/v1/auth/ratls/annotations/{key}

Path parameters

key*string

Attestation value to annotate

Response

200

OK

Body

application/json

authobject

dataobject

Request

JavaScriptCurlPython

const response = await fetch('/v1/auth/ratls/annotations/{key}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": {
    "created": 0,
    "key": "text",
    "value": "text"
  }
}

Delete annotation

DELETE/v1/auth/ratls/annotations/{key}

Path parameters

key*string

Attestation value to annotate

Response

200

OK

Request

JavaScriptCurlPython

const response = await fetch('/v1/auth/ratls/annotations/{key}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();