diff --git a/VirtualDDNSRouter.Server/VirtualDDNSRouter.Server.http b/VirtualDDNSRouter.Server/VirtualDDNSRouter.Server.http index 7e7d060..1c75831 100644 --- a/VirtualDDNSRouter.Server/VirtualDDNSRouter.Server.http +++ b/VirtualDDNSRouter.Server/VirtualDDNSRouter.Server.http @@ -1,11 +1,18 @@ @VirtualDDNSRouter.Server_HostAddress = http://localhost:5277 -GET {{VirtualDDNSRouter.Server_HostAddress}}/todos/ -Accept: application/json +### Set IP for a path +# This endpoint is used by clients to register/update their IP address for a specific path +# Parameters: +# - path: The path identifier (must match a rule in rules.yaml) +# - port: The port number the client wants to expose +# - apiKey: The API key for authentication (must match the rule for the path) +POST {{VirtualDDNSRouter.Server_HostAddress}}/setip/{path}/{port}/{apiKey} +Content-Type: application/json ### -GET {{VirtualDDNSRouter.Server_HostAddress}}/todos/1 -Accept: application/json +### Redirect to registered service +# This endpoint redirects to the IP and port registered for a specific path +GET {{VirtualDDNSRouter.Server_HostAddress}}/goto/{path} ###