Skip to content

api-reference.md

Latest commit

 

History

History
100 lines (70 loc) · 1.45 KB

api-reference.md

File metadata and controls

100 lines (70 loc) · 1.45 KB

API Reference

The 0.1.0 API defines the foundation system endpoints. The secret-storage operations are intentionally not implemented until later releases.

GET /v1/sys/health

Returns process health and foundation seal state.

curl -s http://127.0.0.1:8200/v1/sys/health

Example response:

{
  "initialized": false,
  "sealed": true
}

GET /v1/sys/seal-status

Returns initialization and seal progress.

curl -s http://127.0.0.1:8200/v1/sys/seal-status

Example response:

{
  "initialized": false,
  "sealed": true,
  "threshold": 0,
  "progress": 0
}

GET /v1/sys/version

Returns the Lykilheim version.

curl -s http://127.0.0.1:8200/v1/sys/version

Example response:

{
  "version": "0.1.0"
}

POST /v1/sys/init

Defined in 0.1.0, implemented in 0.2.0.

curl -s -X POST http://127.0.0.1:8200/v1/sys/init

Example 0.1.0 response:

{
  "code": "not_implemented",
  "message": "this endpoint is not available in this release"
}

POST /v1/sys/unseal

Defined in 0.1.0, implemented in 0.2.0.

curl -s -X POST http://127.0.0.1:8200/v1/sys/unseal

POST /v1/sys/seal

Defined in 0.1.0, implemented in 0.2.0.

curl -s -X POST http://127.0.0.1:8200/v1/sys/seal

Error Format

Errors return a stable JSON object:

{
  "code": "not_implemented",
  "message": "this endpoint is not available in this release"
}