REST API in Traefik v3.1

Traefik Traefik v3 (latest)
1

Hello,
we want to upgrade our Traefic version from v1.7 to v3.1, until now we were using the REST provider, however I don't find REST in the list of the providers supported in v3. Has the REST provider been removed or is this just a lack of documentation? If it is just lack of documentation, are there breaking changes between REST provider in v1/v2/v3? And are you planning to release a documentation for it in v3 in the near future?

Thank you very much.

2

Is providers.http (doc) what you are looking for?

3

Hi, thanks for the answer. The http provider is not exactly the same, since it will poll from an endpoint, while with the REST provider of v1 we would send a put request to /api/providers/rest of traefik. So I understand it correctly that now there is no REST provider that can be used in the same way as in the old v1.7, meaning by sending a put/post request to traefik? Is the http provider what comes closest?

4

Traefik v2/v3 will pull dynamic config. AFAIK you can’t push (PUT/POST), but you can set the pull frequency for GET from http source.

5

Maybe it's still there, see discussion (link).

At least there is still some providers/rest source code (link).

6

Thank you, indeed it looks like it should still be there, I added it to the providers and I can see it in the dashboard in the list of available providers. However, when I send a request to /api/providers/rest I get a 404. From the source code it looks like it should have created a router for the REST provider (same link you posted):

// CreateRouter creates a router for the Rest API.
func (p *Provider) CreateRouter() *mux.Router {
router := mux.NewRouter()
router.Methods(http.MethodPut).Path("/api/providers/{provider}").Handler(p)
return router
}

but I don't see that in my list of routers. I see that a "rest@internal" service has been created, but it is not used by any router. Any ideas?

7

Try to assign it as a service, similar to api@internal.

8

I finally had time to try this out, creating a router that uses the rest@internal service works and I can use the rest api. Thank you very much @bluepuma77 !

9

Hi @adashi
I am trying to achieve the same that you did but I am still failing, receiving a 405. Here is my traefik.yml config file (I undestood that all configuration related to REST needs to be in the static part, i.e. in traefik.yml). I can access http://localhost:8080/dashboard nicely as well as GET data through http://localhost:8080/api/http/services/. However, I am failing with POST requests. Can you please share a simple example of your config along with a working POST request?

Thanks!

---traefik.yml---
entryPoints:
websecure:
address: ":443"
custom:
address: ":7777"
forwardedHeaders:
trustedIPs:
- "0.0.0.0/0"
insecure: true

providers:
file:
filename: "/etc/traefik/dynamic.yml"
watch: true
rest: true

api:
dashboard: true
insecure: true

http:
routers:
rest@internal:
rule: "PathPrefix(/api/providers/rest)"
service: rest@internal
entry-points:
- traefik

accessLog:
filePath: "/etc/traefik/access.log"

log:
filePath: "/etc/traefik/traefik.log"
format: "json"
level: "DEBUG"

10

For formatting, use 3 backticks before and after code/config, or select it and press </> button.

http root element is dynamic config, must be loaded via a provider, like using providers.file to read from dynamic config file.

11

Sorry for the messed up formatting.

I should say that I am new to traefik first of all ...

Here is my traefik.yml hopefully well formatted.
What I would like to achieve is enabling the REST API endpoint in traefik (I am using v3.3) such that I can add routes and services at runtime.

I do not see any REST related route in the dashboard, however, I do see the rest@internal service. Any attempt to use POST requests towards http://localhost:8080/api/http/services/... returns a 405. I am now using the toplevel entry rest in traefik.yml instead of http. I admit that this is all guessing. That's why I was asking for a very minimalistic working config that enables REST API.

entryPoints:
  websecure:
    address: ":443"
  custom:
    address: ":7777"
    forwardedHeaders:
      trustedIPs:
        - "0.0.0.0/0"
      insecure: true

providers:
  file:
    filename: "/etc/traefik/dynamic.yml"
    watch: true
  rest: true

api:
  dashboard: true
  insecure: true

rest:
  routers:
    rest:
      rule: "PathPrefix(`/api/providers`)"
      service: rest@internal
      entrypoints:
        - traefik


accessLog:
  filePath: "/etc/traefik/access.log"

log:
  filePath: "/etc/traefik/traefik.log"
  format: "json"
  level: "DEBUG"```
12

If you are new to Traefik, why use an un-documented REST API (not in doc).

This old post might help.