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

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,

Je tente depuis plusieurs jours de taper via API ma freebox server revolution (A jour du dernier firmware)

J’ai donc bien suivis la DOC, et je suis en python 3.8

1 - Générer mon application, puis la confirmer sur le front en physique, j’ai le “status”:”granted” 2 - Je récupère le challenge
3 - Tentative d’ouverture de session via le password généré depuis le app_token et le challenge

J’obtiens en retour (tout est anonymisé) :

{'uid': '732edfg65fgaze', 'success': False, 'msg': "Erreur d'authentification de l'application", 'result': {'password_salt': 'M/iYdsf6a9dhyuiods9qsxtfpc+r1KFB', 'challenge': 'KRgdfez6r5sHHRTEuygfvVTGK'}, 'error_code': 'invalid_token'}

Je ne comprend pas ou la raison du soucis, si quelqu’un peut m’éclairer si je me suis trompé ou si c’est un bug

import datetime
import hashlib
import hmac
import json
import pickle
import time
import requests
import urllib3
import sys
import base64

def make_digest(message, key):
    
    key = bytes(key, 'UTF-8')
    message = bytes(message, 'UTF-8')
    
    digester = hmac.new(key, message, hashlib.sha1)
    #signature1 = digester.hexdigest()
    signature1 = digester.digest()
    #print(signature1)
    
    #signature2 = base64.urlsafe_b64encode(bytes(signature1, 'UTF-8'))
    signature2 = base64.urlsafe_b64encode(signature1)    
    #print(signature2)
    
    return str(signature2, 'UTF-8')

appid = "applicationidcustom"
appname ="AppnameCustom"
devicename ="Dlocalcustom"
appversion = "1"
apptoken = "dfgmonapptokengenererlorsdelauthOw0Udhyq/"

#Etape 2 : Obtenir le challenge value avant de sauthentifier
url = "http://mafreebox.freebox.fr/api/v10/login/"
headers = {"Content-Type": "application/json; charset=utf-8"}
response = requests.get(url, headers=headers)
ReturnResponse = response.json()
if ReturnResponse["success"] == False:
	sys.exit(0)

#Etape 3 : Recuperation du token de session
CurrentChallenge = ReturnResponse["result"]["challenge"]
CurrentPassword = make_digest(CurrentChallenge, apptoken)
url = "http://mafreebox.freebox.fr/api/v10/login/session/"
data = {"app_id": appname, "password": CurrentPassword}
headers = {"Content-Type": "application/json; charset=utf-8"}
response = requests.post(url, headers=headers, json=data)
ReturnResponse = response.json()
print(ReturnResponse)
#{'uid': '732edfg65fgaze', 'success': False, 'msg': "Erreur d'authentification de l'application", 'result': {'password_salt': 'M/iYdsf6a9dhyuiods9qsxtfpc+r1KFB', 'challenge': 'KRgdfez6r5sHHRTEuygfvVTGK'}, 'error_code': 'invalid_token'}

Bonjour,

J’ai constaté que l’endpoint /share_link ne retourne pas ce qu’il faut, en théorie il doit retourner ça :

{
    "success": true,
    "result": {
        "path": "L0Rpc3F1ZSBkdXIvVMOpbMOpY2hhcmdlbWVudHM=", /* /Disque dur/Téléchargements */
        "name": "Téléchargements",
        "token": "6Hj57zgTfoQqb_vH",
        "expire": 1355932880,
        "fullurl": "http://13.37.42.69/api/v8/share/6Hj57zgTfoQqb_vH/"
    }
}

actuellement il retourne uniquement le success sans le result :

{
   success: true
}

Ce problème est présent sur le post de /share_link uniquement à ma connaissance.

Merci

Bonjour,
l’api bouquet :

https://mafreebox.freebox.fr/api/v6/tv/bouquets/770/channels

ne renvoie pas la chaîne TVMonaco ajoutée dernièrement en place 900.

Pourquoi et comment faire pour mettre à jour le bouquet?

Merci et bonne journée.

Bonjour,

Je rencontre un problème lors de l’utilisation de l’API. Actuellement, lorsque j’effectue un nombre excessif de requêtes, je reçois en retour le message “Too Many Requests”.

Vu que le blacklistage des machines qui effectuent trop de requêtes est exponentiel (plus on insiste, plus la limitation est longue ; https://https://dev.freebox.fr/bugs/task/19160#comment79018), serait-il possible d’ajouter une indication du temps d’attente nécessaire avant de pouvoir effectuer de nouvelles requêtes ?

Actuellement, nous sommes contraints de réessayer à plusieurs reprises sans savoir exactement dans combien de temps nous pourrons effectuer de nouvelles requêtes. Cela a pour conséquence d’augmenter le temps d’attente si nous essayons de nouveau avant la fin de la période de blocage, ce qui a pour conséquence d’aggraver la situation.

Dans la demande “ FS#19160 “, il était indiqué que “Pour réinitialiser cette limitation il suffit de redémarrer le Server”. Cependant, après avoir essayé cette solution, le problème persiste toujours. Donc l’ajout de cette évolution aiderait grandement.

Je vous remercie par avance pour votre considération de cette demande d’amélioration.

Cordialement

Bonjour

Je n’ai pas de ULTRA.
Afin de maintenir la library BASH permettant d’utiliser l’API de manière user firendly depuis le shell bash de chaque machines, est ce que quelqu’un pourrait faire le call suivant sur l’API d’une ULTRA :

GET https://mafreebox.freebox.fr/api/v10/vm/info 

Sur une DELTA avec la RAM à 16g j’obtiens

$ get_freebox_api vm/info | jq
{
  "success": true,
  "result": {
    "usb_used": false,
    "sata_used": false,
    "sata_ports": [
      "sata-internal-p0",
      "sata-internal-p1",
      "sata-internal-p2",
      "sata-internal-p3"
    ],
    "used_memory": 12288,
    "usb_ports": [
      "usb-external-type-a",
      "usb-external-type-c"
    ],
    "used_cpus": 3,
    "total_memory": 15360,
    "total_cpus": 3
  }
}

En vous remerciant d’avance,
Cordialement
nbanba

Bonjour

Je suis tombé sur un message d'erreur renvoyé par l'API et non documenté dans la doc interne à la box (https://mafreebox.freebox.fr/doc/index.html?) :

Lors de la création foireuse d'une VM :

curl -sX POST --cacert /dev/shm/fbx-cacert "https://fbx.fbx.lan/api/v10/vm/"  -H "X-Fbx-App-Auth: $_SESSION_TOKEN" -d '{"cloudinit_userdata":"","cd_path":"L0ZCWDI0VC9pc28vYXJtNjRfaXB4ZV9zaW1wbGUtbWVudTMuaXNv","os":"debian","enable_cloudinit":false,"disk_path":"L0ZCWDI0VC9ib3gtdm0vMTRSVi1GU1JWLTE2LnFjb3cy","vcpus":"1","memory":"4096","name":"14RV-FSRV-16","cloudinit_hostname":"","bind_usb_ports":[["",""]],"enable_screen":false,"disk_type":"qcow2"}' 2>&1

Notez bien l'erreur volontaire dans le tableau :

"bind_usb_ports":[["",""]]

Je ne devrais pas mettre un tableau dans ce tableau, l'objet JSON de l'API n'est pas prévu pour, surtout pour un tableau de tableau void.
Je devrais écrire :

"bind_usb_ports":[]

Le retour de l'API est :

{"msg":"Impossible d’ajouter cette VM","success":false,"error_code":"internal"}

Et alors, j'ai bien cherché dans la doc des VM et dans la page d'error_codes de la doc de l'API, mais cette erreur internal ne semble pas être documentée.

Pourriez vous SVP ajouter la signification de ce message (et peut être le rendre + verbeux type : "bad value for a JSON array - internal error")

En vous remerciant d'avance
Cordialement
nbanba

PS: comme déjà demandé, le support de l'ANGLAIS sur les Delta serait bien et éviterai des trucs bien moches avec mix Français / Anglais comme :

{"msg":"Impossible d’ajouter cette VM","success":false,"error_code":"internal"}

Bonjour

La box résout en local en IPv6 sur fd0f:ee:b0::1 pour le domaine mafreebox.freebox.fr

host -6 mafreebox.freebox.fr 
mafreebox.freebox.fr has address 212.27.38.253
mafreebox.freebox.fr has IPv6 address fd0f:ee:b0::1
mafreebox.freebox.fr is an alias for freeplayer.freebox.fr.

Sauf erreur de ma part, l’API n’est pas joignable sur cette IPv6 locale associée au nom de domaine mafreebox.freebox.fr :

La requête :

curl -k https://[fd0f:ee:b0::1]/api_version
curl: (7) Failed to connect to fd0f:ee:b0::1 port 443: Couldn't connect to server

arrive en timeout (sur le même segment L2, sans blocage ni firewall)

alors qu’en IPv4, une requête sur l’IPv4 associée à mafreebox.freebox.fr (212.27.38.253) fonctionne:

curl -k https://212.27.38.253/api_version
{"box_model_name":"Freebox v7 (r1)","api_base_url":"\/api\/","https_port":2xxx,"device_name":"ZZZ-ZZZZZ","https_available":true,"box_model":"fbxgw7-r1\/full","api_domain":"fxxxxxxx.fbxos.fr","uid":"537xxxxxxxxxxxxxxxxxxxxxxxxxxxx5","api_version":"12.0","device_type":"FreeboxServer7,1"}

Ce comportement asymétrique entre IPv4 et Ipv6 est gênant pour le maintient d’applications se connectant à la freebox en local sur l’URL mafreebox.freebox.fr et utilisant les certificats TLS de la PKI FreeboxOS :

	Issuer: CN=Freebox Root CA,O=Freebox,L=Paris,ST=France,C=FR

Pourriez vous SVP rendre cet accès valide lors d’une prochaine mise à jour ?

En vous remerciant d’avance
Cordialement
nbanba

NOTE 20241128:
EN fait la Freebox n’apprends pas la gateway local v6 depuis les RA lorsqu’elle n’est pas maître sur le LAN
(La table de routage de la Freebox devrait contenir une route pour fc00/7 pointant vers le routeur qui annonce et qui est la gateway IPv6 locale sur le segment L2)
La demande peut être fermée

Bonjour

Ou puis je avoir accès à l’api de là box pour pouvoir contrôler la centrale d’alarme et les détecteur et capteur et télécommande sur ma box lifedomus de delta dore. Il nous manque des infos pour pouvoir l’integrer.

En attente de votre réponse

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.

Depuis la MàJ 1.3, les fichiers (vidéo, audio, image) nommés avec des caractères cyrilliques ne s’affichent plus dans la liste Freebox Player par ordre alphabétique. Le tri se fait par un ordre aléatoire dur à déterminer et il ne semble pas y avoir de remède à ce problème pour l’utilisateur.

La liste des dessins animés venants des pays slaves ressemble maintenant à cela :

Les souris malines 01
Petits chatons 01
Petits chatons 02
Les renards rigolo
Un ourson gentil 01
Trois lapins pompiers
Deux garçons et un vélo
Petits chatons 03
Les souris malines 02
Petits chatons 04

Donc, il est laborieux pour des parents de trouver le dessin animé demandé par le petit cinéphile et tout simplement impossible pour ce dernier de se faire un marathon des « Petits chatons », par exemple.

Il faut noter, que ce tri mystérieux était présent dans l’interface FreeboxOS depuis déjà long temps, tandis que le Freebox Player réussissait sans problème a trier les alphabets non-latins. Dans l’absolu, il aurait été mieux pour le Server d’apprendre à bien trier et non au Player de l’oublier.

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

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’ai connecté un serveur linux à la freebox via l’API.
Mais depuis quelque temps je n’ai plus d’acces.

J’ai voulu revoqué mon applicatif, mais la freebox me renvoi une erreur.
Impossible de supprimer cet objet.

De plus, quand j’essai de recuperer un nouveau token applicatif, la requete me renvoi une erreur interne:

“msg”: “Base d’authentification indisponible”,

Merci de m’indiquer la meilleure marche a suivre car le SAV me repond qu’ils ne sont pas capable de traiter ce probleme..

Je souhaiterai récupérer la totalité des appels émis ou reçus sur ma Freebox. J’utilise donc l’API via cette URL :

/api/v4/call/log/

Seulement 100 éléments me sont affichés mais la numérotation de ceux-ci va bien au-delà (+ de 3000 dans mon cas). Si tous les appels sont gardés en mémoire, est-ce possible de mettre un paramètre optionnel pour récupérer l’ensemble des éléments ?

Bonjour,

Afin de pouvoir administrer et superviser de façon plus fine les Hosts qui se connectent au réseau de la Freebox (wifi ou LAN), j’ai besoin de pouvoir spécifier la durée par défaut du bail DHCP (cela devrait à priori être possible selon la RFC RFC1541)

Cette durée semble être forcée à 12h et n’est pas configurable malgré la disponibilité de l’API “/api/v6/dhcp/config/” (avec un PUT).

Pouvez-vous svp ajouter à l’API existante (”/api/v6/dhcp/config/”) la gestion de ce paramètre (ajout du champ dans l’objet DhcpConfig) ?

Merci

Bien à vous

Bonjour,

Il semble que Freebox OS ne permette pas de mettre à jour les certificats de noms de domaine non administrés par freeboxos. Le seul moyen que j’aie pu trouver est de supprimer et recréer le domaine.

Dans l’idéal, il faudrait une API (documentée) afin de permettre des mise à jour automatiques par scripts (par exemple lorsqu’on a un certificat Let’s Encrypt pour son domaine, qu’il faut renouveler régulièrement).

Bonjour

J’ai paramétré deux caméras chez un de mes clients, elles sont en adresse IP fixe en dehors de la plage du DHCP, avec deux redirections de ports pour avoir accès à mes caméras depuis l’extérieur. Tout fonctionné très bien depuis plus d’un an et demi et tout d’un coup depuis quelques semaines, je n’ai plus accès aux caméras depuis l’extérieur.
La seule chose que je vois d’anormale est le fait que je ne peux pas pinger la box depuis l’extérieur. J’ai bien sur prix soin d’activer le ping sur le portail de la box en question.
Et la commande msdos tracert xx.xxx.xx.xx n’abouti pas, le delai d’attente est dépassé ce qui me semble vraiment anormal.

Je n’ai malheureusement pas trouver de réponse à mon problème et mes clients envisage très sérieusement de quitter Free alors qu ej’ai d’autres clients avec le smêmes caméèas configurés de la même manière et tout fonctionne très bien.

J’espère avoir exposé clairement mon problème et j’espère que quelqu’un pourra rapidement m’aider à le résoudre.

Bien cordialement

Bonjour, mon fils réussi à s’associer à la freebox pop sans saisir le mdp administrateur dans Freebox Connect. Le mdp est pourtant assez compliqué, je l’ai changé plusieurs fois et il est enregistré nulle part.

– Titre édité suite aux échanges

A cause d’une latence de plusieurs dizaines de millisecondes dans le traitement du signal audio via la fonction airmedia de la freebox revolution, il est impossible d’utiliser correctement cette fonction de la freebox au sein d’un systeme avec d’autres haut-parleurs fonctionnant également en airplay. En effet le décalage sonore entre les autres appareils et la freebox est trop important.