github.com/decred/dcrlnd@v0.7.6/lnrpc/lightning.yaml (about)

     1  type: google.api.Service
     2  config_version: 3
     3  
     4  # Mapping for the grpc-gateway REST proxy.
     5  # Please make sure to also update the `metadata.go` file when editing this file
     6  # and adding a new client-streaming RPC!
     7  
     8  http:
     9    rules:
    10      - selector: lnrpc.Lightning.WalletBalance
    11        get: "/v1/balance/blockchain"
    12      - selector: lnrpc.Lightning.ChannelBalance
    13        get: "/v1/balance/channels"
    14      - selector: lnrpc.Lightning.GetTransactions
    15        get: "/v1/transactions"
    16      - selector: lnrpc.Lightning.EstimateFee
    17        get: "/v1/transactions/fee"
    18      - selector: lnrpc.Lightning.SendCoins
    19        post: "/v1/transactions"
    20        body: "*"
    21      - selector: lnrpc.Lightning.ListUnspent
    22        get: "/v1/utxos"
    23      - selector: lnrpc.Lightning.SubscribeTransactions
    24        get: "/v1/transactions/subscribe"
    25      - selector: lnrpc.Lightning.SendMany
    26        post: "/v1/transactions/many"
    27        body: "*"
    28      - selector: lnrpc.Lightning.NewAddress
    29        get: "/v1/newaddress"
    30      - selector: lnrpc.Lightning.SignMessage
    31        post: "/v1/signmessage"
    32        body: "*"
    33      - selector: lnrpc.Lightning.VerifyMessage
    34        post: "/v1/verifymessage"
    35        body: "*"
    36      - selector: lnrpc.Lightning.ConnectPeer
    37        post: "/v1/peers"
    38        body: "*"
    39      - selector: lnrpc.Lightning.DisconnectPeer
    40        delete: "/v1/peers/{pub_key}"
    41      - selector: lnrpc.Lightning.ListPeers
    42        get: "/v1/peers"
    43      - selector: lnrpc.Lightning.SubscribePeerEvents
    44        get: "/v1/peers/subscribe"
    45      - selector: lnrpc.Lightning.GetInfo
    46        get: "/v1/getinfo"
    47      - selector: lnrpc.Lightning.GetRecoveryInfo
    48        get: "/v1/getrecoveryinfo"
    49      - selector: lnrpc.Lightning.PendingChannels
    50        get: "/v1/channels/pending"
    51      - selector: lnrpc.Lightning.ListChannels
    52        get: "/v1/channels"
    53      - selector: lnrpc.Lightning.SubscribeChannelEvents
    54        get: "/v1/channels/subscribe"
    55      - selector: lnrpc.Lightning.ClosedChannels
    56        get: "/v1/channels/closed"
    57      - selector: lnrpc.Lightning.OpenChannelSync
    58        post: "/v1/channels"
    59        body: "*"
    60      - selector: lnrpc.Lightning.OpenChannel
    61        post: "/v1/channels/stream"
    62        body: "*"
    63      - selector: lnrpc.Lightning.BatchOpenChannel
    64        post: "/v1/channels/batch"
    65        body: "*"
    66      - selector: lnrpc.Lightning.FundingStateStep
    67        post: "/v1/funding/step"
    68        body: "*"
    69      - selector: lnrpc.Lightning.ChannelAcceptor
    70        post: "/v1/channels/acceptor"
    71        body: "*"
    72      - selector: lnrpc.Lightning.CloseChannel
    73        delete: "/v1/channels/{channel_point.funding_txid_str}/{channel_point.output_index}"
    74      - selector: lnrpc.Lightning.AbandonChannel
    75        delete: "/v1/channels/abandon/{channel_point.funding_txid_str}/{channel_point.output_index}"
    76      - selector: lnrpc.Lightning.SendPayment
    77        post: "/v1/channels/transaction-stream"
    78        body: "*"
    79      - selector: lnrpc.Lightning.SendPaymentSync
    80        post: "/v1/channels/transactions"
    81        body: "*"
    82      - selector: lnrpc.Lightning.SendToRoute
    83        # deprecated, no REST endpoint
    84      - selector: lnrpc.Lightning.SendToRouteSync
    85        post: "/v1/channels/transactions/route"
    86        body: "*"
    87      - selector: lnrpc.Lightning.AddInvoice
    88        post: "/v1/invoices"
    89        body: "*"
    90      - selector: lnrpc.Lightning.ListInvoices
    91        get: "/v1/invoices"
    92      - selector: lnrpc.Lightning.LookupInvoice
    93        get: "/v1/invoice/{r_hash_str}"
    94      - selector: lnrpc.Lightning.SubscribeInvoices
    95        get: "/v1/invoices/subscribe"
    96      - selector: lnrpc.Lightning.DecodePayReq
    97        get: "/v1/payreq/{pay_req}"
    98      - selector: lnrpc.Lightning.DeletePayment
    99        delete: "/v1/payment"
   100      - selector: lnrpc.Lightning.ListPayments
   101        get: "/v1/payments"
   102      - selector: lnrpc.Lightning.DeleteAllPayments
   103        delete: "/v1/payments"
   104      - selector: lnrpc.Lightning.DescribeGraph
   105        get: "/v1/graph"
   106      - selector: lnrpc.Lightning.GetNodeMetrics
   107        get: "/v1/graph/nodemetrics"
   108      - selector: lnrpc.Lightning.GetChanInfo
   109        get: "/v1/graph/edge/{chan_id}"
   110      - selector: lnrpc.Lightning.GetNodeInfo
   111        get: "/v1/graph/node/{pub_key}"
   112      - selector: lnrpc.Lightning.QueryRoutes
   113        get: "/v1/graph/routes/{pub_key}/{amt}"
   114      - selector: lnrpc.Lightning.GetNetworkInfo
   115        get: "/v1/graph/info"
   116      - selector: lnrpc.Lightning.StopDaemon
   117        post: "/v1/stop"
   118        body: "*"
   119      - selector: lnrpc.Lightning.SubscribeChannelGraph
   120        get: "/v1/graph/subscribe"
   121      - selector: lnrpc.Lightning.DebugLevel
   122        post: "/v1/debuglevel"
   123        body: "*"
   124      - selector: lnrpc.Lightning.FeeReport
   125        get: "/v1/fees"
   126      - selector: lnrpc.Lightning.UpdateChannelPolicy
   127        post: "/v1/chanpolicy"
   128        body: "*"
   129      - selector: lnrpc.Lightning.ForwardingHistory
   130        post: "/v1/switch"
   131        body: "*"
   132      - selector: lnrpc.Lightning.ExportChannelBackup
   133        get: "/v1/channels/backup/{chan_point.funding_txid_str}/{chan_point.output_index}"
   134      - selector: lnrpc.Lightning.ExportAllChannelBackups
   135        get: "/v1/channels/backup"
   136      - selector: lnrpc.Lightning.VerifyChanBackup
   137        post: "/v1/channels/backup/verify"
   138        body: "*"
   139      - selector: lnrpc.Lightning.RestoreChannelBackups
   140        post: "/v1/channels/backup/restore"
   141        body: "*"
   142      - selector: lnrpc.Lightning.SubscribeChannelBackups
   143        get: "/v1/channels/backup/subscribe"
   144      - selector: lnrpc.Lightning.BakeMacaroon
   145        post: "/v1/macaroon"
   146        body: "*"
   147      - selector: lnrpc.Lightning.ListMacaroonIDs
   148        get: "/v1/macaroon/ids"
   149      - selector: lnrpc.Lightning.DeleteMacaroonID
   150        delete: "/v1/macaroon/{root_key_id}"
   151      - selector: lnrpc.Lightning.ListPermissions
   152        get: "/v1/macaroon/permissions"
   153      - selector: lnrpc.Lightning.CheckMacaroonPermissions
   154        post: "/v1/macaroon/checkpermissions"
   155        body: "*"
   156      - selector: lnrpc.Lightning.RegisterRPCMiddleware
   157        post: "/v1/middleware"
   158      - selector: lnrpc.Lightning.SendCustomMessage
   159        post: "/v1/custommessage"
   160        body: "*"
   161      - selector: lnrpc.Lightning.SubscribeCustomMessages
   162        get: "/v1/custommessage/subscribe"