Annotations

Last updated 3 months ago

Was this helpful?

Read annotation

get

Path parameters

keystringRequired

Attestation value to annotate

Responses

200

application/json

get

GET /v1/auth/ratls/annotations/{key} HTTP/1.1
Host: 
Accept: */*

200

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

Delete annotation

delete

Path parameters

keystringRequired

Attestation value to annotate

Responses

200

delete

DELETE /v1/auth/ratls/annotations/{key} HTTP/1.1
Host: 
Accept: */*

200

No content

List annotations

get

Query parameters

liststring · enumRequired

Must be set to true

Possible values:

Responses

200

application/json

get

GET /v1/auth/ratls/annotations/?list=true HTTP/1.1
Host: 
Accept: */*

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

200

application/json

put

PUT /v1/auth/ratls/annotations HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 41

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

200

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