API Reference

Generated by make docs-sync from tools/gendocs/api. Source of truth is api/proto/keystone/core/v1/*.proto (gRPC) and api/openapi/openapi-spec.yaml (REST). Do not edit by hand — make docs-sync re-runs the generator and git diff will catch drift.

This is an index. For request / response field detail, follow the Source link to the relevant .proto block or the openapi spec entry.

gRPC services

AgentService

RPC	Request	Response	Source
`GetAgentInfo`	`GetAgentInfoRequest`	`GetAgentInfoResponse`	`api/proto/keystone/core/v1/agent.proto:38`
`Heartbeat`	`HeartbeatRequest`	`HeartbeatResponse`	`api/proto/keystone/core/v1/agent.proto:27`
`Register`	`RegisterRequest`	`RegisterResponse`	`api/proto/keystone/core/v1/agent.proto:24`

BlueprintService

RPC	Request	Response	Source
`ApplyBlueprint`	`ApplyBlueprintRequest`	`ApplyBlueprintResponse`	`api/proto/keystone/core/v1/blueprint.proto:14`
`GetBlueprint`	`GetBlueprintRequest`	`GetBlueprintResponse`	`api/proto/keystone/core/v1/blueprint.proto:13`
`ListBlueprints`	`ListBlueprintsRequest`	`ListBlueprintsResponse`	`api/proto/keystone/core/v1/blueprint.proto:12`

ClusterService

RPC	Request	Response	Source
`AddMember`	`AddMemberRequest`	`AddMemberResponse`	`api/proto/keystone/core/v1/cluster.proto:17`
`CreateBackup`	`CreateBackupRequest`	`CreateBackupResponse`	`api/proto/keystone/core/v1/cluster.proto:25`
`GetClusterStatus`	`GetClusterStatusRequest`	`GetClusterStatusResponse`	`api/proto/keystone/core/v1/cluster.proto:13`
`GetLeader`	`GetLeaderRequest`	`GetLeaderResponse`	`api/proto/keystone/core/v1/cluster.proto:20`
`GetMember`	`GetMemberRequest`	`GetMemberResponse`	`api/proto/keystone/core/v1/cluster.proto:16`
`ListMembers`	`ListMembersRequest`	`ListMembersResponse`	`api/proto/keystone/core/v1/cluster.proto:15`
`Rebalance`	`RebalanceRequest`	`RebalanceResponse`	`api/proto/keystone/core/v1/cluster.proto:23`
`RemoveMember`	`RemoveMemberRequest`	`RemoveMemberResponse`	`api/proto/keystone/core/v1/cluster.proto:18`
`RestoreBackup`	`RestoreBackupRequest`	`RestoreBackupResponse`	`api/proto/keystone/core/v1/cluster.proto:26`
`TransferLeader`	`TransferLeaderRequest`	`TransferLeaderResponse`	`api/proto/keystone/core/v1/cluster.proto:21`
`WatchLeadership`	`WatchLeadershipRequest`	`stream WatchLeadershipResponse`	`api/proto/keystone/core/v1/cluster.proto:32`
`WatchMembership`	`WatchMembershipRequest`	`stream WatchMembershipResponse`	`api/proto/keystone/core/v1/cluster.proto:29`

ControlPlaneService

RPC	Request	Response	Source
`BatchExecuteCommand`	`BatchExecuteCommandRequest`	`stream BatchExecuteCommandResponse`	`api/proto/keystone/core/v1/controlplane.proto:39`
`CancelBatchJob`	`CancelBatchJobRequest`	`CancelBatchJobResponse`	`api/proto/keystone/core/v1/controlplane.proto:53`
`ExecuteCommand`	`ExecuteCommandRequest`	`stream ExecuteCommandResponse`	`api/proto/keystone/core/v1/controlplane.proto:33`
`GetAgent`	`GetAgentRequest`	`GetAgentResponse`	`api/proto/keystone/core/v1/controlplane.proto:17`
`GetBatchAgentResult`	`GetBatchAgentResultRequest`	`GetBatchAgentResultResponse`	`api/proto/keystone/core/v1/controlplane.proto:59`
`GetBatchJob`	`GetBatchJobRequest`	`GetBatchJobResponse`	`api/proto/keystone/core/v1/controlplane.proto:45`
`GetCommandStatus`	`GetCommandStatusRequest`	`GetCommandStatusResponse`	`api/proto/keystone/core/v1/controlplane.proto:41`
`ListAgents`	`ListAgentsRequest`	`ListAgentsResponse`	`api/proto/keystone/core/v1/controlplane.proto:16`
`ListBatchAgentResults`	`ListBatchAgentResultsRequest`	`ListBatchAgentResultsResponse`	`api/proto/keystone/core/v1/controlplane.proto:56`
`ListBatchJobs`	`ListBatchJobsRequest`	`ListBatchJobsResponse`	`api/proto/keystone/core/v1/controlplane.proto:49`
`ListCommandHistory`	`ListCommandHistoryRequest`	`ListCommandHistoryResponse`	`api/proto/keystone/core/v1/controlplane.proto:42`
`QuarantineAgent`	`QuarantineAgentRequest`	`QuarantineAgentResponse`	`api/proto/keystone/core/v1/controlplane.proto:23`
`ServerStatus`	`ServerStatusRequest`	`ServerStatusResponse`	`api/proto/keystone/core/v1/controlplane.proto:14`
`UnquarantineAgent`	`UnquarantineAgentRequest`	`UnquarantineAgentResponse`	`api/proto/keystone/core/v1/controlplane.proto:24`
`VerifyAgent`	`VerifyAgentRequest`	`VerifyAgentResponse`	`api/proto/keystone/core/v1/controlplane.proto:29`

CoordinationService

RPC	Request	Response	Source
`ClusterHealth`	`ClusterHealthRequest`	`ClusterHealthResponse`	`api/proto/keystone/core/v1/coordination.proto:25`
`LookupLeader`	`LookupLeaderRequest`	`LookupLeaderResponse`	`api/proto/keystone/core/v1/coordination.proto:26`
`NATSStatus`	`NATSStatusRequest`	`NATSStatusResponse`	`api/proto/keystone/core/v1/coordination.proto:27`
`NodeHeartbeat`	`NodeHeartbeatRequest`	`NodeHeartbeatResponse`	`api/proto/keystone/core/v1/coordination.proto:29`
`PropagateState`	`PropagateStateRequest`	`PropagateStateResponse`	`api/proto/keystone/core/v1/coordination.proto:30`
`RecoveryCoordinate`	`RecoveryCoordinateRequest`	`RecoveryCoordinateResponse`	`api/proto/keystone/core/v1/coordination.proto:28`

EventService

RPC	Request	Response	Source
`EmitEvent`	`EmitEventRequest`	`EmitEventResponse`	`api/proto/keystone/core/v1/event.proto:18`
`GetEvent`	`GetEventRequest`	`GetEventResponse`	`api/proto/keystone/core/v1/event.proto:17`
`GetEventStats`	`GetEventStatsRequest`	`GetEventStatsResponse`	`api/proto/keystone/core/v1/event.proto:28`
`GetEventTypes`	`GetEventTypesRequest`	`GetEventTypesResponse`	`api/proto/keystone/core/v1/event.proto:27`
`ListEvents`	`ListEventsRequest`	`ListEventsResponse`	`api/proto/keystone/core/v1/event.proto:16`
`SubscribeEvents`	`SubscribeEventsRequest`	`stream SubscribeEventsResponse`	`api/proto/keystone/core/v1/event.proto:25`

IdentityService

RPC	Request	Response	Source
`CleanupJoinTokens`	`CleanupJoinTokensRequest`	`CleanupJoinTokensResponse`	`api/proto/keystone/core/v1/identity.proto:38`
`CreateJoinToken`	`CreateJoinTokenRequest`	`CreateJoinTokenResponse`	`api/proto/keystone/core/v1/identity.proto:23`
`DeleteJoinToken`	`DeleteJoinTokenRequest`	`DeleteJoinTokenResponse`	`api/proto/keystone/core/v1/identity.proto:32`
`ExportCA`	`ExportCARequest`	`ExportCAResponse`	`api/proto/keystone/core/v1/identity.proto:55`
`GetCAInfo`	`GetCAInfoRequest`	`GetCAInfoResponse`	`api/proto/keystone/core/v1/identity.proto:43`
`GetStatus`	`GetStatusRequest`	`GetStatusResponse`	`api/proto/keystone/core/v1/identity.proto:58`
`ListJoinTokens`	`ListJoinTokensRequest`	`ListJoinTokensResponse`	`api/proto/keystone/core/v1/identity.proto:28`
`RotateSigningCA`	`RotateSigningCARequest`	`RotateSigningCAResponse`	`api/proto/keystone/core/v1/identity.proto:50`

PolicyService

RPC	Request	Response	Source
`CreatePolicy`	`CreatePolicyRequest`	`CreatePolicyResponse`	`api/proto/keystone/core/v1/policy.proto:40`
`DeletePolicy`	`DeletePolicyRequest`	`DeletePolicyResponse`	`api/proto/keystone/core/v1/policy.proto:42`
`EvaluatePolicy`	`EvaluatePolicyRequest`	`EvaluatePolicyResponse`	`api/proto/keystone/core/v1/policy.proto:25`
`EvaluatePolicySet`	`EvaluatePolicySetRequest`	`EvaluatePolicySetResponse`	`api/proto/keystone/core/v1/policy.proto:26`
`GetAuditLog`	`GetAuditLogRequest`	`GetAuditLogResponse`	`api/proto/keystone/core/v1/policy.proto:37`
`GetComplianceReport`	`GetComplianceReportRequest`	`GetComplianceReportResponse`	`api/proto/keystone/core/v1/policy.proto:36`
`GetPolicy`	`GetPolicyRequest`	`GetPolicyResponse`	`api/proto/keystone/core/v1/policy.proto:29`
`GetPolicySet`	`GetPolicySetRequest`	`GetPolicySetResponse`	`api/proto/keystone/core/v1/policy.proto:31`
`ListPolicies`	`ListPoliciesRequest`	`ListPoliciesResponse`	`api/proto/keystone/core/v1/policy.proto:30`
`ListPolicySets`	`ListPolicySetsRequest`	`ListPolicySetsResponse`	`api/proto/keystone/core/v1/policy.proto:32`
`ListViolations`	`ListViolationsRequest`	`ListViolationsResponse`	`api/proto/keystone/core/v1/policy.proto:33`
`UpdatePolicy`	`UpdatePolicyRequest`	`UpdatePolicyResponse`	`api/proto/keystone/core/v1/policy.proto:41`

RunbookService

RPC	Request	Response	Source
`ExecuteRunbook`	`ExecuteRunbookRequest`	`ExecuteRunbookResponse`	`api/proto/keystone/core/v1/runbook.proto:14`
`GetRunbook`	`GetRunbookRequest`	`GetRunbookResponse`	`api/proto/keystone/core/v1/runbook.proto:13`
`GetRunbookExecution`	`GetRunbookExecutionRequest`	`GetRunbookExecutionResponse`	`api/proto/keystone/core/v1/runbook.proto:15`
`ListRunbooks`	`ListRunbooksRequest`	`ListRunbooksResponse`	`api/proto/keystone/core/v1/runbook.proto:12`

SecretsService

RPC	Request	Response	Source
`Decrypt`	`DecryptRequest`	`DecryptResponse`	`api/proto/keystone/core/v1/secrets.proto:27`
`DeleteSecret`	`DeleteSecretRequest`	`DeleteSecretResponse`	`api/proto/keystone/core/v1/secrets.proto:17`
`Encrypt`	`EncryptRequest`	`EncryptResponse`	`api/proto/keystone/core/v1/secrets.proto:26`
`GetLease`	`GetLeaseRequest`	`GetLeaseResponse`	`api/proto/keystone/core/v1/secrets.proto:20`
`GetSecret`	`GetSecretRequest`	`GetSecretResponse`	`api/proto/keystone/core/v1/secrets.proto:14`
`ListLeases`	`ListLeasesRequest`	`ListLeasesResponse`	`api/proto/keystone/core/v1/secrets.proto:21`
`ListSecrets`	`ListSecretsRequest`	`ListSecretsResponse`	`api/proto/keystone/core/v1/secrets.proto:15`
`RenewLease`	`RenewLeaseRequest`	`RenewLeaseResponse`	`api/proto/keystone/core/v1/secrets.proto:22`
`RevokeLease`	`RevokeLeaseRequest`	`RevokeLeaseResponse`	`api/proto/keystone/core/v1/secrets.proto:23`
`Sign`	`SignRequest`	`SignResponse`	`api/proto/keystone/core/v1/secrets.proto:28`
`Verify`	`VerifyRequest`	`VerifyResponse`	`api/proto/keystone/core/v1/secrets.proto:29`
`WriteSecret`	`WriteSecretRequest`	`WriteSecretResponse`	`api/proto/keystone/core/v1/secrets.proto:16`

StateService

RPC	Request	Response	Source
`ApplyState`	`ApplyStateRequest`	`stream ApplyStateResponse`	`api/proto/keystone/core/v1/state.proto:22`
`CheckState`	`CheckStateRequest`	`CheckStateResponse`	`api/proto/keystone/core/v1/state.proto:26`
`DetectDrift`	`DetectDriftRequest`	`DetectDriftResponse`	`api/proto/keystone/core/v1/state.proto:30`
`GetStateHistory`	`GetStateHistoryRequest`	`GetStateHistoryResponse`	`api/proto/keystone/core/v1/state.proto:34`
`GetStateStatus`	`GetStateStatusRequest`	`GetStateStatusResponse`	`api/proto/keystone/core/v1/state.proto:38`
`RollbackState`	`RollbackStateRequest`	`stream RollbackStateResponse`	`api/proto/keystone/core/v1/state.proto:46`

REST endpoints

Source: api/openapi/openapi-spec.yaml. Method / path tuples below.

Method	Path	Source
`GET`	`/api/v1/agents`	`api/openapi/openapi-spec.yaml:363`
`GET`	`/api/v1/agents/{id}`	`api/openapi/openapi-spec.yaml:400`
`DELETE`	`/api/v1/agents/{id}`	`api/openapi/openapi-spec.yaml:413`
`GET`	`/api/v1/apikeys`	`api/openapi/openapi-spec.yaml:425`
`POST`	`/api/v1/apikeys`	`api/openapi/openapi-spec.yaml:441`
`GET`	`/api/v1/apikeys/{id}`	`api/openapi/openapi-spec.yaml:476`
`DELETE`	`/api/v1/apikeys/{id}`	`api/openapi/openapi-spec.yaml:488`
`GET`	`/api/v1/cluster/status`	`api/openapi/openapi-spec.yaml:499`
`GET`	`/api/v1/cluster/leader`	`api/openapi/openapi-spec.yaml:517`
`GET`	`/api/v1/cluster/members`	`api/openapi/openapi-spec.yaml:532`
`POST`	`/api/v1/cluster/members`	`api/openapi/openapi-spec.yaml:544`
`GET`	`/api/v1/cluster/members/{id}`	`api/openapi/openapi-spec.yaml:556`
`DELETE`	`/api/v1/cluster/members/{id}`	`api/openapi/openapi-spec.yaml:566`
`POST`	`/api/v1/cluster/backup`	`api/openapi/openapi-spec.yaml:573`
`POST`	`/api/v1/cluster/restore`	`api/openapi/openapi-spec.yaml:588`
`GET`	`/api/v1/events`	`api/openapi/openapi-spec.yaml:597`
`POST`	`/api/v1/events`	`api/openapi/openapi-spec.yaml:617`
`GET`	`/api/v1/events/types`	`api/openapi/openapi-spec.yaml:636`
`GET`	`/api/v1/events/stats`	`api/openapi/openapi-spec.yaml:652`
`GET`	`/api/v1/events/{id}`	`api/openapi/openapi-spec.yaml:677`
`GET`	`/api/v1/execution/commands`	`api/openapi/openapi-spec.yaml:691`
`POST`	`/api/v1/execution/commands`	`api/openapi/openapi-spec.yaml:706`
`POST`	`/api/v1/execution/batch`	`api/openapi/openapi-spec.yaml:739`
`GET`	`/api/v1/execution/commands/{id}`	`api/openapi/openapi-spec.yaml:773`
`DELETE`	`/api/v1/execution/commands/{id}`	`api/openapi/openapi-spec.yaml:784`
`GET`	`/api/v1/gitops/repos`	`api/openapi/openapi-spec.yaml:794`
`POST`	`/api/v1/gitops/repos`	`api/openapi/openapi-spec.yaml:800`
`DELETE`	`/api/v1/gitops/repos/{id}`	`api/openapi/openapi-spec.yaml:812`
`POST`	`/api/v1/gitops/sync`	`api/openapi/openapi-spec.yaml:819`
`POST`	`/api/v1/gitops/webhook`	`api/openapi/openapi-spec.yaml:826`
`GET`	`/api/v1/maintenance/windows`	`api/openapi/openapi-spec.yaml:837`
`POST`	`/api/v1/maintenance/windows`	`api/openapi/openapi-spec.yaml:843`
`GET`	`/api/v1/maintenance/windows/{id}`	`api/openapi/openapi-spec.yaml:855`
`DELETE`	`/api/v1/maintenance/windows/{id}`	`api/openapi/openapi-spec.yaml:862`
`GET`	`/api/v1/policies`	`api/openapi/openapi-spec.yaml:872`
`GET`	`/api/v1/policies/{id}`	`api/openapi/openapi-spec.yaml:890`
`POST`	`/api/v1/policies/evaluate`	`api/openapi/openapi-spec.yaml:902`
`GET`	`/api/v1/policies/violations`	`api/openapi/openapi-spec.yaml:918`
`GET`	`/api/v1/policies/compliance`	`api/openapi/openapi-spec.yaml:931`
`GET`	`/api/v1/policies/audit`	`api/openapi/openapi-spec.yaml:938`
`GET`	`/api/v1/runbooks`	`api/openapi/openapi-spec.yaml:947`
`POST`	`/api/v1/runbooks`	`api/openapi/openapi-spec.yaml:953`
`GET`	`/api/v1/runbooks/{id}`	`api/openapi/openapi-spec.yaml:965`
`DELETE`	`/api/v1/runbooks/{id}`	`api/openapi/openapi-spec.yaml:972`
`POST`	`/api/v1/runbooks/{id}/run`	`api/openapi/openapi-spec.yaml:985`
`GET`	`/api/v1/schedules`	`api/openapi/openapi-spec.yaml:1001`
`POST`	`/api/v1/schedules`	`api/openapi/openapi-spec.yaml:1007`
`GET`	`/api/v1/schedules/{id}`	`api/openapi/openapi-spec.yaml:1019`
`DELETE`	`/api/v1/schedules/{id}`	`api/openapi/openapi-spec.yaml:1026`
`GET`	`/api/v1/secrets/{path}`	`api/openapi/openapi-spec.yaml:1046`
`PUT`	`/api/v1/secrets/{path}`	`api/openapi/openapi-spec.yaml:1062`
`DELETE`	`/api/v1/secrets/{path}`	`api/openapi/openapi-spec.yaml:1072`
`GET`	`/api/v1/leases`	`api/openapi/openapi-spec.yaml:1079`
`GET`	`/api/v1/leases/{id}`	`api/openapi/openapi-spec.yaml:1097`
`POST`	`/api/v1/leases/{id}/renew`	`api/openapi/openapi-spec.yaml:1114`
`POST`	`/api/v1/leases/{id}/revoke`	`api/openapi/openapi-spec.yaml:1130`
`POST`	`/api/v1/transit/encrypt`	`api/openapi/openapi-spec.yaml:1137`
`POST`	`/api/v1/transit/decrypt`	`api/openapi/openapi-spec.yaml:1144`
`POST`	`/api/v1/transit/sign`	`api/openapi/openapi-spec.yaml:1151`
`POST`	`/api/v1/transit/verify`	`api/openapi/openapi-spec.yaml:1158`
`POST`	`/api/v1/state/apply`	`api/openapi/openapi-spec.yaml:1174`
`POST`	`/api/v1/state/check`	`api/openapi/openapi-spec.yaml:1198`
`POST`	`/api/v1/state/drift`	`api/openapi/openapi-spec.yaml:1205`
`GET`	`/api/v1/state/runs`	`api/openapi/openapi-spec.yaml:1212`
`GET`	`/api/v1/state/runs/{id}`	`api/openapi/openapi-spec.yaml:1224`
`GET`	`/api/v1/webhooks`	`api/openapi/openapi-spec.yaml:1234`
`POST`	`/api/v1/webhooks`	`api/openapi/openapi-spec.yaml:1240`
`GET`	`/api/v1/webhooks/{id}`	`api/openapi/openapi-spec.yaml:1252`
`DELETE`	`/api/v1/webhooks/{id}`	`api/openapi/openapi-spec.yaml:1259`
`POST`	`/api/v1/webhooks/{id}/test`	`api/openapi/openapi-spec.yaml:1272`

Configuration Reference Design