Skip to content

Latest commit

 

History

History
121 lines (70 loc) · 3.12 KB

RouterApi.md

File metadata and controls

121 lines (70 loc) · 3.12 KB
Raw

\RouterApi

All URIs are relative to http://localhost

Method HTTP request Description
RouterCreate Post /1.8/routers
RouterDelete Delete /1.8/routers/{name}
RouterList Get /1.3/routers
RouterUpdate Put /1.8/routers/{name}

RouterCreate

RouterCreate(ctx, dynamicRouter)

Adds a new dynamic router

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
dynamicRouter DynamicRouter

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RouterDelete

RouterDelete(ctx, name)

Deletes a dynamic router

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string Dynamic router name.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RouterList

[]PlanRouter RouterList(ctx, )

List available routers

Required Parameters

This endpoint does not need any parameter.

Return type

[]PlanRouter

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RouterUpdate

RouterUpdate(ctx, name, dynamicRouter)

Updates a dynamic router

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string Dynamic router name.
dynamicRouter DynamicRouter

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]