Skip to content

REST API Overview

The Kinetic daemon exposes a local REST API that you can interact with using standard HTTP requests.

  • Base URL: http://127.0.0.1:16002/api
  • Content-Type: application/json (for all request bodies and responses)
  • Authentication: Bearer token (see Authentication for details).

Endpoints Summary

Public Endpoints

No authentication is required for these endpoints.

MethodPathDescription
GET/api/network-statusReturns the current network connectivity status.
GET/api/resolve/{name}Resolves a Kinetic name and returns the Reveal object.
GET/api/resolve-kid/{did}Resolves a KID identity (did:kin:...).
GET/api/zone/{name}Returns the DNS zone for a given name.

Authenticated Endpoints

Requires Authorization: Bearer <token> header.

MethodPathDescription
POST/api/commitCommits a name hash to the DHT.
POST/api/publishPublishes a name reveal to the DHT.
POST/api/publish-kidPublishes a KID identity document.
POST/api/publish-manifestPublishes a Capability Manifest.
GET/api/configRetrieves the daemon configuration.
POST/api/configUpdates the daemon configuration.
GET/api/owned-namesLists all locally owned names.
POST/api/vdf/registerStarts a VDF name registration task.
POST/api/vdf/renewStarts a VDF name renewal task.
GET/api/vdf/status/{task_id}Gets the status of a running VDF task.
DELETE/api/vdf/status/{task_id}Cancels/deletes a VDF task.
GET/api/zone/{name}Retrieves the local DNS zone for an owned name.
POST/api/zone/{name}Saves/updates a local DNS zone file.
POST/api/zone/{name}/publishSigns and publishes a zone to the DHT.

Error Format

When an API request fails, it returns a standard JSON error response conforming to RFC 7807. The HTTP status code will reflect the error type (e.g., 404 Not Found, 400 Bad Request), and the body will contain a machine-readable code and a human-readable message.

json
{
  "code": "KIN-RES-002",
  "message": "The domain is not registered on the Kinetic network.",
  "status": 404
}

You can programmatically match on the code field to handle specific error conditions.

Pagination & Rate Limiting

  • Pagination: There is currently no pagination. List endpoints (like /api/owned-names) return the full collection in a single response.
  • Rate Limiting: Because this is a local-only API, there are no strict rate limits. However, VDF polling should be kept to reasonable intervals (e.g., once every 1-5 minutes) to avoid unnecessary overhead.