Annotations

Create a new annotation

put

Creates a new annotation for an attestation value with a human-readable description

Body

createdinteger · int64Required

Creation timestamp, set by the plugin

keystringRequired

Attestation value to annotate

valuestringRequired

Human-readable description for the attestation value

Responses

200

Annotation created successfully

application/json

400

Invalid request body

405

Unsupported operation

application/json

put

HTTPcURLJavaScriptPython

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

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

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

List all annotations

get

Retrieves a list of all available annotations in the system

Query parameters

liststring · enumRequired

Must be set to 'true' to retrieve the list

Possible values:

Responses

200

List of annotations retrieved successfully

application/json

get

HTTPcURLJavaScriptPython

GET /v1/auth/ratls/annotations/ HTTP/1.1
Host: localhost:8200
Accept: */*

200

List of annotations retrieved successfully

{
  "request_id": "text",
  "lease_id": "text",
  "renewable": true,
  "lease_duration": 1,
  "data": {
    "keys": [
      "text"
    ]
  },
  "wrap_info": null,
  "warnings": null,
  "auth": null
}

Get annotation details

get

Retrieves detailed information about a specific annotation

Path parameters

keystringRequired

Unique attestation value identifier

Responses

200

Annotation details retrieved successfully

application/json

400

Annotation not found

get

HTTPcURLJavaScriptPython

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

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

Delete an annotation

delete

Removes a specific annotation from the system

Path parameters

keystringRequired

Unique attestation value identifier

Responses

200

Annotation deleted successfully

application/json

delete

HTTPcURLJavaScriptPython

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

200

Annotation deleted successfully

{
  "request_id": "text",
  "lease_id": "text",
  "renewable": true,
  "lease_duration": 1,
  "data": {},
  "wrap_info": null,
  "warnings": null,
  "auth": null
}