1
0
mirror of https://github.com/juanfont/headscale.git synced 2024-12-20 19:09:07 +01:00
juanfont.headscale/proto/headscale/v1/headscale.proto

208 lines
5.9 KiB
Protocol Buffer
Raw Normal View History

2021-10-30 16:29:41 +02:00
syntax = "proto3";
package headscale.v1;
option go_package = "github.com/juanfont/headscale/gen/go/v1";
import "google/api/annotations.proto";
import "headscale/v1/user.proto";
import "headscale/v1/preauthkey.proto";
import "headscale/v1/machine.proto";
import "headscale/v1/routes.proto";
2022-01-25 23:11:15 +01:00
import "headscale/v1/apikey.proto";
// import "headscale/v1/device.proto";
2021-10-30 16:29:41 +02:00
service HeadscaleService {
// --- User start ---
rpc GetUser(GetUserRequest) returns(GetUserResponse) {
option(google.api.http) = {
get : "/api/v1/user/{name}"
};
}
2021-10-30 16:29:41 +02:00
rpc CreateUser(CreateUserRequest) returns(CreateUserResponse) {
option(google.api.http) = {
post : "/api/v1/user"
body : "*"
};
}
2021-10-30 16:29:41 +02:00
rpc RenameUser(RenameUserRequest) returns(RenameUserResponse) {
option(google.api.http) = {
post : "/api/v1/user/{old_name}/rename/{new_name}"
};
}
2021-10-30 16:29:41 +02:00
rpc DeleteUser(DeleteUserRequest) returns(DeleteUserResponse) {
option(google.api.http) = {
delete : "/api/v1/user/{name}"
};
}
2021-10-30 16:29:41 +02:00
rpc ListUsers(ListUsersRequest) returns(ListUsersResponse) {
option(google.api.http) = {
get : "/api/v1/user"
};
}
// --- User end ---
2021-10-30 16:29:41 +02:00
// --- PreAuthKeys start ---
rpc CreatePreAuthKey(CreatePreAuthKeyRequest) returns(CreatePreAuthKeyResponse) {
option(google.api.http) = {
post : "/api/v1/preauthkey"
body : "*"
};
}
2021-10-30 16:29:41 +02:00
rpc ExpirePreAuthKey(ExpirePreAuthKeyRequest) returns(ExpirePreAuthKeyResponse) {
option(google.api.http) = {
post : "/api/v1/preauthkey/expire"
body : "*"
};
}
2021-10-30 16:29:41 +02:00
rpc ListPreAuthKeys(ListPreAuthKeysRequest) returns(ListPreAuthKeysResponse) {
option(google.api.http) = {
get : "/api/v1/preauthkey"
};
}
// --- PreAuthKeys end ---
// --- Machine start ---
rpc DebugCreateMachine(DebugCreateMachineRequest) returns(DebugCreateMachineResponse) {
option(google.api.http) = {
post : "/api/v1/debug/machine"
body : "*"
};
}
2021-10-30 16:29:41 +02:00
rpc GetMachine(GetMachineRequest) returns(GetMachineResponse) {
option(google.api.http) = {
get : "/api/v1/machine/{machine_id}"
2021-10-30 16:29:41 +02:00
};
}
rpc SetTags(SetTagsRequest) returns(SetTagsResponse) {
option(google.api.http) = {
post : "/api/v1/machine/{machine_id}/tags"
body : "*"
};
}
rpc RegisterMachine(RegisterMachineRequest) returns(RegisterMachineResponse) {
option(google.api.http) = {
post : "/api/v1/machine/register"
2021-10-30 16:29:41 +02:00
};
}
rpc DeleteMachine(DeleteMachineRequest) returns(DeleteMachineResponse) {
option(google.api.http) = {
delete : "/api/v1/machine/{machine_id}"
2021-10-30 16:29:41 +02:00
};
}
rpc ExpireMachine(ExpireMachineRequest) returns(ExpireMachineResponse) {
option(google.api.http) = {
post : "/api/v1/machine/{machine_id}/expire"
2021-11-21 14:40:04 +01:00
};
}
2022-03-13 22:03:20 +01:00
rpc RenameMachine(RenameMachineRequest) returns(RenameMachineResponse) {
option(google.api.http) = {
post : "/api/v1/machine/{machine_id}/rename/{new_name}"
2022-03-13 22:03:20 +01:00
};
}
2021-11-21 14:40:04 +01:00
rpc ListMachines(ListMachinesRequest) returns(ListMachinesResponse) {
option(google.api.http) = {
get : "/api/v1/machine"
};
}
2022-05-01 15:34:40 +02:00
rpc MoveMachine(MoveMachineRequest) returns(MoveMachineResponse) {
option(google.api.http) = {
post : "/api/v1/machine/{machine_id}/user"
2022-05-01 15:34:40 +02:00
};
}
// --- Machine end ---
// --- Route start ---
rpc GetRoutes(GetRoutesRequest) returns(GetRoutesResponse) {
option(google.api.http) = {
get : "/api/v1/routes"
};
}
rpc EnableRoute(EnableRouteRequest) returns(EnableRouteResponse) {
option(google.api.http) = {
post : "/api/v1/routes/{route_id}/enable"
};
}
rpc DisableRoute(DisableRouteRequest) returns(DisableRouteResponse) {
option(google.api.http) = {
post : "/api/v1/routes/{route_id}/disable"
};
}
rpc GetMachineRoutes(GetMachineRoutesRequest) returns(GetMachineRoutesResponse) {
option(google.api.http) = {
get : "/api/v1/machine/{machine_id}/routes"
2021-10-30 16:29:41 +02:00
};
}
2023-03-06 09:05:40 +01:00
rpc DeleteRoute(DeleteRouteRequest) returns(DeleteRouteResponse) {
option(google.api.http) = {
delete : "/api/v1/routes/{route_id}"
};
}
// --- Route end ---
2022-01-25 23:11:15 +01:00
// --- ApiKeys start ---
rpc CreateApiKey(CreateApiKeyRequest) returns(CreateApiKeyResponse) {
option(google.api.http) = {
post : "/api/v1/apikey"
body : "*"
2022-01-25 23:11:15 +01:00
};
}
rpc ExpireApiKey(ExpireApiKeyRequest) returns(ExpireApiKeyResponse) {
option(google.api.http) = {
post : "/api/v1/apikey/expire"
body : "*"
2022-01-25 23:11:15 +01:00
};
}
rpc ListApiKeys(ListApiKeysRequest) returns(ListApiKeysResponse) {
option(google.api.http) = {
get : "/api/v1/apikey"
2022-01-25 23:11:15 +01:00
};
}
// --- ApiKeys end ---
// Implement Tailscale API
// rpc GetDevice(GetDeviceRequest) returns(GetDeviceResponse) {
// option(google.api.http) = {
// get : "/api/v1/device/{id}"
// };
// }
// rpc DeleteDevice(DeleteDeviceRequest) returns(DeleteDeviceResponse) {
// option(google.api.http) = {
// delete : "/api/v1/device/{id}"
// };
// }
// rpc GetDeviceRoutes(GetDeviceRoutesRequest) returns(GetDeviceRoutesResponse) {
// option(google.api.http) = {
// get : "/api/v1/device/{id}/routes"
// };
// }
// rpc EnableDeviceRoutes(EnableDeviceRoutesRequest) returns(EnableDeviceRoutesResponse) {
// option(google.api.http) = {
// post : "/api/v1/device/{id}/routes"
// };
// }
2021-10-30 16:29:41 +02:00
}