Skip to content
nbanba edited this page Jun 14, 2025 · 5 revisions

Configuration needed to use API:

Access QUICK START documentation:

https://github.com/freeboxos/freeboxos-bash-api/tree/nbanb-freebox-api#quick-start

Full Example:

https://github.com/freeboxos/freeboxos-bash-api/tree/nbanb-freebox-api?tab=readme-ov-file#QSFULLEX

Access QUICK START documentation in FRENCH:

https://github.com/freeboxos/freeboxos-bash-api/wiki/%5BFRENCH-QUICK-START%5D-Quick-Start-en-Fran%C3%A7ais

I HAVE A WINDOWS COMPUTER => I DON'T HAVE BASH

https://github.com/freeboxos/freeboxos-bash-api/wiki/I-HAVE-A-WINDOWS-COMPUTER-%E2%80%90-NO-BASH



Create necessary access on your Freebox:

Get a public URL

https://github.com/freeboxos/freeboxos-bash-api?tab=readme-ov-file#RAXXURL

Get a TLS certificate

https://github.com/freeboxos/freeboxos-bash-api?tab=readme-ov-file#TLSCERT

Configure remote access To your box

https://github.com/freeboxos/freeboxos-bash-api?tab=readme-ov-file#RAXX

Configure public URL and TLS certificate on your box

https://github.com/freeboxos/freeboxos-bash-api?tab=readme-ov-file#CFGURLTLS

Ask ISP for a 'full-stack' IPv4 address FULL-STACK IPv4

https://github.com/freeboxos/freeboxos-bash-api?tab=readme-ov-file#FULLSTK



Using API:

Create an application:

https://github.com/freeboxos/freeboxos-bash-api?tab=readme-ov-file#login-functions

Grant application access:

https://github.com/freeboxos/freeboxos-bash-api?tab=readme-ov-file#GRANTAXX



FULL DOCUMENTATION:

https://github.com/freeboxos/freeboxos-bash-api/blob/nbanb-freebox-api/README.md

And read the code and its comments...