Freebox Server (Ultra V9/ Pop V8/ Delta V7 / Revolution V6 / Mini 4K)

Actuellement l’API AirMedia du FreeboxOS permet l’affichage de photos et de videos mais pas la lecture de fichiers audio.
Il est possible de choisir le media_type “video” et de renseigner l’url d’un fichier audio mais on se retrouve avec un écran noir sur la TV.

L’idéal serait de reproduire ce qui est proposé pour AirPlay :
- affichage du titre (cover, titre, etc) dans l’application AirMedia
- affichage de la notification (en haut à droite) à la lecture du fichier audio

Avec possibilité de renseigner les informations du media : cover, titre, artiste, etc; si celles-ci ne sont pas disponible dans le fichier. Ou même rendre ces infos obligatoires.

Bonjour,

Depuis une adresse externe au reseau local :
GET /api/v3/login/session/ HTTP/1.1

Renvoie HTTP 200 mais avec success false et error_code denied_from_external_ip.
Pour être cohérent avec le reste de l’API et conformément a la documention il faudrait renvoyer un HTTP 403 dans ce cas là.

En attendant je vais mettre un if 200 and success == true dans mon code ...

Bien a vous !

Bonjour,

Serait il possible de mettre en place une procédure de réinitialisation du mot de passe Server par envoi d’un code par sms ou email à la place (ou en doublon ?) du code affiché sur le panneau du Server ?

Motivation :
- sécurisation de la procédure (voir par exemple  FS#17543 ),
- panneau d’affichage Server illisible (mon cas),
- intervention à distance.

Pour cela il faudrait :
- une évolution au niveau Freebox OS (ou page Web d’administration sur le site Free) pour pouvoir enregistrer un numéro de téléphone portable pour l’envoi du sms ou une adresse mail pour l’envoi d’un mail, et une option pour choisir le mode de gestion du code de réinitialisation du mot de passe (affiché sur le Server, envoyé par sms, envoyé par mail, ou plusieurs de ces options en même temps),
- une API Freebox OS pour pouvoir activer la procédure de réinitialisation à distance,
- l’implémentation dans les Compagnons (Android, iOS) de l’appel à cette API.

Cette procédure devrait aussi être utilisable pour une connexion à Freebox OS via un navigateur WEB.

Le code envoyé par sms ou mail devra avoir une durée de validité suffisamment longue pour permettre sa réception et sa ressaisie dans l’interface de réinitialisation du mot de passe.

Cordialement,

DFAL

Bonjour,

Avec la version 3.3, il est possible de gérer une liste de noms de domaines auxquels la Freebox répond depuis l’extérieur, et d’y ajouter des certificats SSL.

Serait-il possible d’étendre l’API pour permettre de configurer ces noms de domaines et leurs certificats ?

Ceci permettrait par exemple d’écrire un plugin pour le client letsencrypt qui permettrait de gérer le renouvellement automatisé (avec un client letsencrypt qui tourne sur un PC) du certificat SSL pour les noms de domaine personnalisés, et son installation automatique sur la Freebox.

Merci.

Il est indiqué dans la documentation que les champs dsl::rate_up et dsl::rate_down sont renvoyés en octet/s (byte/s), alors qu’ils sont renvoyés en bits/s.

De même il est indiqué que les champs net::rate_up et net::rate_down sont renvoyés en octet/s (byte/s) alors qu’il sont renvoyés en koctets/s.

Il faudrait corriger la documentation ou l’API.

L’accès aux variables RRD nécessite une autorisation supplémentaire de “Modifications des réglages de la Freebox”, alors qu’ils sont en lecture seule, et que rien ne l’indique dans la documentation.

Dans le cadre du développement d’un plugin pour Rainmeter (https://github.com/Kitof/RainFbx), je dois demander aux utilisateurs d’activer cette autorisation ce qui est de manière à les inquiéter sans raison particulière.

Bonjour,
En me basant sur le sdk (http://dev.freebox.fr/sdk/os/login/#make-an-authenticated-call-to-the-api) je n’arrive pas à m’authentifier .
J’interroge la freebox en PHP avec php-curl.

POST /api/v3/login/authorize/ me retourne HTTP/1.1 200 OK - {”msg”:”Requête invalide (404)”,”success”:false,”error_code”:”invalid_request”}bool(true)

L’erreur vient de la documentation.

Merci

Quand il y a plus de 256 numéros de téléphone, à la création du numéro de téléphone, l’id retourné est modulo 256. Il n’est plus possible ensuite d’accéder à ce numéro par l’API. La supression du numéro par l’interface web Freebox Os est également impossible.

Exemple :

is_own: 'False'
number: '1234567890'
contact_id: '150'
is_default: 'False'
type: 'fixed'
id: '684'

DELETE /number/684 ->
 {'status': 200, 'cookies': <RequestsCookieJar[]>, 'content_type': 'application/json; charset=utf-8', 'is_json': True, 'timeout': False, 'data': {u'msg': u'Impossible supprimer cet objet', u'error_code': u'internal_error', u'success': False}}

Example request:

PUT /api/v3/contact/addtogroup/ HTTP/1.1
Host: mafreebox.freebox.fr
{
  "group_id": 2,
  "contact_id": 6
}

Example response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
    "success": true
}

Suite au bug : External Linkhttps://dev.freebox.fr/bugs/task/21461

Il apparaît que depuis la version 4 des API, certains appels nécessitent vraiment le header

Content-type: application/json

pour fonctionner correctement.

En effet, ce header est bien mentionné (71 fois) pour les réponses, mais jamais clairement pour les requêtes (juste 1 fois pour expliquer qu’il ne faut PAS l’envoyer dans un cas précis).

Cela n’est indiqué nulle part en clair dans la documentation.

Je suggère donc (améliorations) que la documentation mentionne cette “bonne pratique” (puisque en réalité 99% des API fonctionnent néanmoins, mais ce n’est effectivement pas 100% fiable).

Cela pourrait figurer dans la section d’introduction, en donnant des modèles de ‘curl’ par exemple.

Une documentation plus précise est en effet à même d’aider les futurs développeurs en leur évitant de tomber dans des bugs bizarres comme celui signalé plus haut.

Bonjour,
je n’arrive pas à programmer un enregistrement depuis l’API freebox. La documentation étant incomplète, impossible de deviner quels sont les informations nécessaires, et pourquoi j’ai une erreur internal quand j’essaye d’ajouter un enregistrement :( Serait-il possible de compléter la doc, avec notamment un exemple d’utilisation ?
Merci d’avance

Bonjour ,
de récurrents soucis de coupure de courant avec le réseau public de distribution de l’électricité m’ont incité à acquérir un ups pour protéger ma petite installation , et j’ai l’impression que ce type de problème est amené à se multiplié dans le futur .
Donc voila la question à peut être déjà été posée et je n’ai peut être pas cherché assez et par ailleurs je comprendrai que des contraintes techniques l’imposent ou rendent la chose impossible , mais après avoir cherché un minimum je n’ai pas trouvé de possibilité de faire un shutdown du freeboxserver , j’utilise apscupsd sur mes machines et je demande pas l’implémentation d’un client mais j’ai observé que l’api permettait le reboot (via POST /api/v4/system/reboot/) et me demande si le shutdown ne serait pas possible , en effet en cas de coupure si je souhaite continuer à alimenter la box pour maintenir le téléphone en cas d’urgence , j’aimerai aussi pourvoir l’éteindre et privilégier une autre machine à partir d’un certain temps / pourcentage de batterie .
Cette demande n’est ni urgente ni critique , mais je souhaitait avoir votre réponse avant d’envisager l’achat d’un autre ups uniquement pour la freebox ;)

Merci d’avance,
Cordialement

Pas de doc pour la version 6.0 des api freebox

Bonjour,

avec les nouvelles fonctionalités de la Freebox Delta, il serait préférable de pouvoir integrer la domotique (Somfy, ...) avec des applications tierces en fournissant un API

Merci

Bonjour,
serait-il possible d’avoir de la documentation et des exemples sur la partie domotique et l’alarme en particulier.

J’ai bien vu la partie “Special Tiles specification” dans la documentation sur la Freebox mais je n’ai pas trouvé comment, par exemple, activer ou désactiver l’alarme.

Merci

Bonjour,

j’explore actuellement l’utilisation des api freebox, je constate que la doc n’est pas à jours, il y est fait mention de la v5 des api, quand je fait une requete mDNS je constate que les api sont en fait en V7.

Il est fait mention de websocket dans cette doc, il n’est pas fait mention de l’url pour les utiliser, et de fait j’ai essayer tout ce qu’il me passait par la tête et rien n’a fonctionner.

Ma demande consiste donc a avoir la doc à jour, et dans l’intervalle je ne serais pas contre un p’tit exemple d’utilisation des websockets ou au moins l’url du endpoint.

Bonjour,

Apple demande des CGU ou tout autre texte qui authorise un dev indépendant d’utiliser l’api REST de la freebox. Rien n’est mentionné sur le site.

Quelques lignes disant que l’on peut faire des application IOS + Android avec l’api serait vraiment bien.
Et aussi que l’on peut mentionner le nom “Free” ou “Freebox” tant que ça reste nominatif genre “pour Freebox ...” ce serait vraiment pratique aussi.

J’ai plusieurs applications sur la store et j’ai sans arrêt des soucis vu qu’on ne trouve aucun texte ou CGU.
Désolé si ce n’est pas le bon endroit mais je ne sais pas du tout où poster ça à part sur un truc de dev.

Merci

Bonjour,

Les entêtes HTTP des fichiers proposés par l’API, comme les logos des chaînes, ne sont plus disponibles.
Sauf erreur de ma part, la requête suivante fonctionnait il y a peu :

curl -I http://mafreebox.freebox.fr/api/v8/tv/img/channels/logos68x60/uuid-webtv-201.png

Désormais, elle retourne :

HTTP/1.1 404 Not Found
Server: nginx
Date: Fri, 20 Nov 2020 17:24:52 GMT
Content-Type: application/json; charset=utf-8
Connection: keep-alive

Ce comportement est aberrant puisque la ressource existe bel et bien.
Ainsi, la requête GET correspondante fonctionne :

curl -I -X GET http://mafreebox.freebox.fr/api/v8/tv/img/channels/logos68x60/uuid-webtv-201.png

HTTP/1.1 200 OK
Server: nginx
Date: Fri, 20 Nov 2020 17:28:02 GMT
Content-Type: image/png; charset=utf-8
Content-Length: 1777
Connection: keep-alive
Last-Modified: Wed, 18 Nov 2020 11:31:39 GMT
ETag: "5fb5061b-6f1"
Expires: Wed, 25 Nov 2020 11:55:21 GMT
Cache-Control: max-age=604800
Accept-Ranges: bytes

Cette régression a vraisemblablement été introduite dans Freebox OS peu avant le 26 août.

Merci :)

Bonjour,

Depuis le passage au firmware 4.3.3 sur ma Freebox Révolution, il n'est plus possible de supprimer les fichiers dont l'extension est .srt

J'ai essayé :

• via l'interface de la TV : aucune erreur apparait mais le fichier n'est pas supprimé
• via l'application Android de Free : j'ai une erreur qui dit « suppression de 1 fichier a échoué »
• via l'interface de FreeboxOS : j'ai le message « erreur lors de la suppression : permission refusée »

Voici le JSON retourné par https://mafreebox.freebox.fr/api/v8/fs/rm/ :

{
  "result": {
    "curr_bytes_done": 0,
    "total_bytes": 0,
    "nfiles_done": 0,
    "started_ts": 1622011226,
    "duration": 0,
    "done_ts": 0,
    "src": [
      "/Disque dur/Vidéos/TV/episode.s1e01.srt"
    ],
    "curr_bytes": 0,
    "type": "rm",
    "to": "",
    "id": 10,
    "nfiles": 0,
    "created_ts": 1622011226,
    "state": "running",
    "total_bytes_done": 0,
    "rate": 0,
    "from": "/Disque dur/Vidéos/TV/episode.s1e01.srt",
    "dst": "",
    "eta": 0,
    "error": "none",
    "progress": 0
  }
}

À noter que j'arrive à supprimer sans problème le fichier via Windows Explorer.

Cela ne vient pas d'un seul fichier SRT en particulier (j'ai essayé 2 fichiers différents dans deux répertoires différents). Pas de problème avec les fichiers vidéos.

Merci

Bonjour à tous,

pour info,
après plusieurs essais infructeux dans tous les sens
j'ai enfin réussi à obtenir un session token

la doc API intégrée à la freebox (https://mafreebox.freebox.fr/doc/index.html#)
est erronée concernant le calcul du "password".

ce password est necessaire dans la requête du session token

—> dans la doc est écrit
—> dans le paragraphe "Obtaining a session_token"/"password string"
—> password = hmac-sha1(app_token, challenge) (←– CECI NE FONCTIONNE PAS)

avec le password ainsi calculé,
j'obtenais en réponse à la requête de session token (POST http)

Status Code: 403 Forbidden
msg: Erreur d'authentification de l'application
error_code: invalid_token

Pour que ça fonctionne,
il faut inverser app_token et challenge dans la formule

(CECI CI-DESSOUS FONCTIONNE)
(variables challenge et app_token préalablement attribuées bien sûr)

#en php
$password = hash_hmac("sha1", $challenge, $app_token); 

#ou en bash
password=$(echo -n $challenge | openssl sha1 -hmac $app_token | cut -d '=' -f2 | sed 's/ //g')

—> et avec le bon password, ça passe mieux
—> session_token (enfin) reçu

en remarques complémentaires (de ce que j'en ai compris),

- l'app_token une fois sollicité/autorisé/validé est pérenne 
- le challenge par contre, à une durée de validité courte (30 secondes), 
  validité courte qui est donc conférée au password. 
  Et donc pour réussir l'obtention du session_token, 
  la requête/obtention du challenge, le calcul du password et la requête du session_token 
  doivent être fait pendant cette période de validité de 30 secondes.
- je suppose que le session_token est relativement pérenne  
  (pas pu tester longtemps) mais on sait maintenant comment en solliciter un autre...

HTH,
cordialement,
hého

Bonjour,

je souhaite développer une application en python pour me connecter à ma freebox POP.

J’ai bien compris que la première étape est d’inscrire son application et de l’autoriser sur la box. Voici mon code:

 headers = {}

  payload=json.dumps ({
 "app_id": "fr.freebox.test",
 "app_name": "test",
 "app_version": "1.0.0",
 "device_name": "NO"
  })

  try:        
      response = requests.request('POST', 'https://mafreebox.freebox.fr/api/v10/login/authorize', headers=headers, data=payload,verify=False)
  except Exception as e:
      print ('Execution Box Authorize commmand failed : ' + str(e))     
  else :
      if (response.status_code == 200) :
          authorize = response.json()
          print (authorize)

Tout fonctionne bien je récupère bien un app_token :

{’success’: True, ‘result’: {’app_token’: ‘xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx’, ‘track_id’: 74}}

Et sur la box s’affiche l’authorisation. Mais j’ai beau essayé de valider en sélectionnant Oui sur l’édcran LCD (Fleche droite puis l’écran affiche de nouveau l’heure), La console des accès reste la même :

—–> ‘Authentification en cours’

Avez-vous une idée de là où ça coince ?

Cordialement

Bonjour

1) Il serait pratique de pouvoir custom le champ 'type' des notifications :
Aujourd'hui seul 3 choix sont possibles :
Android | IOS | Firebase

L'ajout d'un type 'custom' (et pourquoi pas la possibilité de personnaliser un champ associé ⇒ ajout d'un "custom_type") serait bien.
Par exemple :

GET /api/v11/notif/targets/11111111-2222-3333-4444-666666666666
{
   "success":true,
   "result":[
      {
         "last_use":0,
         "type":"custom",
         "custom_type":"firewall",
         "name":"FGT901G-API",
         "id":"11111111-2222-3333-4444-666666666666",
         "subscriptions":[
                              "security",
                              "lan_host",
                              "box_state",
         ],
         "api_url": "https://myserver.example.com/my_fortigate_API_app",
         "message_type": "notification"
      }
   ]
}

2) Il serait bien d'ajouter à la "subscriptions" les notifications des events des VM qui sont aujourd'hui renvoyés en websocket (+ celles des type l2/l3_address_(un)reachable)

3) Il serait bien de pouvoir avoir tous les types de notifications au travers des websocket API (register event) :

phone	        notification when missing call
download	notification when download is finished
security	notification when alarm is on
box_state	notification when box state changed
lan_host	notification related to lan events
password_change	notification when admin password is changed

Ainsi le système serait un peu plus complet et homogène et surtout on pourrait piloter d'autres équipements (avec leur propre API) à réception de ces notifications.

Merci
Cordialement
nbanba

Bonjour

Il existe au moins 1 cas à priori non documenté ou l’API du player Devialet ne renvoit pas du JSON

Si je fais la requête pour reboot mon player en utilisant le bon ID pour mon player, la réponse est en JSON ⇒ OK

Si je fais volontairement une requête sur un mauvais ID de player, le player renvoit du HTML au lieu de renvoyer du JSON :

Exemple:
La fonction reboot player prend en argument l’ID du player (mon player à pour ID 17)

Si je fais:

reboot_player 17

J’obtiens le JSON:

{"success":true}

Maintenant si je passe un ID erroné volontairement(ex: ID 0), l’API ne renvoi pas une erreur en JSON mais du HTML:
Trace debug:

$ debug=1
$ reboot_player  0
get_fbx_api request:
curl -s https://mafreebox.freebox.fr/api/v14/player -H "Content-Type: application/json" -H "X-Fbx-App-Auth: $_SESSION_TOKEN" -G --cacert /dev/shm/fbx-cacert 

get_fbx_api result:
{"success":true,"result":[{"mac":"34:27:92:80:29:7c","stb_type":"stb_v7","id":17,"last_time_reachable":1742725668,"api_available":true,"device_name":"Freebox Player","device_model":"fbx7hd-delta","reachable":true,"uid":"a51dde83e07a057e64bef5bdcac8c5e2","api_version":"14.0","lan_gids":["ether-34:27:92:80:29:7c"]}]}

post_fbx_api request:
curl -s "https://mafreebox.freebox.fr/api/v14/player/0/api/v14/system/reboot" -H "Content-Type: application/json" -H "X-Fbx-App-Auth: $_SESSION_TOKEN" -X POST --cacert /dev/shm/fbx-cacert -d {}

post_fbx_api result:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Freebox :: Requête invalide</title>
<link href="/err/err.css" rel="stylesheet" type="text/css" />
</head>

<body>
<div id="info">
    <div id="errorMsg">
      <h3>Requête invalide</h3>
      <p class="desc">La requête envoyée est invalide</p>
    </div>
</div>

</body>
</html>

Je comprend bien que c’est du à l’URL qui devient “mauvaise” car l’ID du player est incluse dans l’URL

cette URL n’existe en fait pas:
https://mafreebox.freebox.fr/api/v14/player/0/api/v14/system/reboot

par contre celle-ci existe:
https://mafreebox.freebox.fr/api/v14/player/17/api/v14/system/reboot

Cependant, pour des questions de normalisation et de parsing, il faudrait que l’API renvoi une erreur avec un content-type application/json

Il serait bien de ne pas devoir développer un moteur de parsing HTML en plus du moteur de parsing JSON à cause d’1 seul message d’erreur renvoyé par l’API et “ne respectant à priori pas la convention de cette même API”

Merci

Cordialement
nbanba

Dans l’API, je récupère les informations bytes_down et bytes_up dans ConnectionStatus https://https://dev.freebox.fr/sdk/os/connection/ Ils sont régulièrement réinitialisés car les valeurs restent faibles malgré l’absence de reconnection dans le journal des connections.
Ils ne devraient être réinitialisés qu’à chaque boot de la freebox, comme c’était le cas il y a longtemps dans l’API.

Bonjour,
Suite au redémarrage de ma freebox courant novembre 2024 pour récupérer le dernier firmware (4.8.15 ou 4.8.16),
les métriques API pour rate_up et bytes_up sous le endpoint “/api/v?/connection/” sont invalides, et semblent être une addition avec les valeurs de rate_down et bytes_down.
L’interface Freebox OS affichant la même anomalie dans les courbes de débit sous “Etat de la freebox”

Par exemple, en récupérant la dernière version d’ubuntu via le navigateur, l’image ISO faisant 5.9 Go (https://releases.ubuntu.com/24.04.2/ubuntu-24.04.2-desktop-amd64.iso),
le téléchargement plafonnant à 2.3 Mo/s, la freebox indique 2.3 Mo/s pour rate_down, comme attendu, mais aussi 2.3 Mo/s pour rate_up.
Alors qu’il n’y a aucune autre activité, et que le téléchargement est via un navigateur, donc sans upload. Mêmes valeurs coté FreeboxOS.

Ceci affectant tous les firmwares depuis ce moment jusqu’au 4.9.8, ainsi que les différentes versions de l’API (vérifié pour v4, v8, v11 et v14)

La freebox n’ayant pas de service interne actif, et étant branchée seule devant un routeur indépendant la comparaison avec son seul port actif du switch intégré est notable.

L’anomalie est présente sur la mini4k, aucune idée pour les autres modèles de freebox.
Attention, ma freebox n’était pas à jour depuis plusieurs mois lorsqu’elle a été redémarrée fin 2024, il est possible que l’anomalie soit antérieure au firmware 4.8.15.

Merci