> For the complete documentation index, see [llms.txt](https://prosbcdocs.telcobridges.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://prosbcdocs.telcobridges.com/telecom-references/apis-and-integration/restful-api-and-northbound-interface.md).

# RESTful API and Northbound interface

> **Applies to:** Tmedia 2.9, 2.10, 3.0, 3.2; SBC 2.9, 2.10, 3.0, 3.2

The RESTful API and Northbound interface allows a higher-level component to configure. This is particularly useful for deployment of large number of units in the field.

### TelcoBridges and Northbound interface

An external application using the RESTful API can now configure the TelcoBridges devices through its Northbound interface.

Some implementation, like the tbconfig tool provided by TelcoBridges can be used to configure the TelcoBridges devices through its Northbound interface.

### Configuration

The Northbound interface offers multiple ways to configure your system:

#### Integration with EMS

The RESTful API (See wikipedia [RESTful API](http://en.wikipedia.org/wiki/Representational_state_transfer) ) allows the provisioning of [Tmedia](https://telcobridges.com/media-gateways/products/tmedia-gateways/) VoIP gateway or [ProSBC](https://telcobridges.com/sbc/products/prosbc/). The configuration of the device is seen as collections of resources than can be queried/modified through this interface.

HTTP requests are sent to the [web server](https://github.com/telcobridges-main/tmedia-wiki/tree/main/tmedia/operations/web-server/README.md) using standard HTTP methods(e.g., GET, PUT, POST, or DELETE). Data exchanged in requests and responses is in [JSON](http://en.wikipedia.org/wiki/JSON) format.

More information on the TelcoBridges implementation of the [RESTful API here](https://github.com/telcobridges-main/tmedia-wiki/tree/main/reference/api/northbound-interface-restful-api/README.md)

### Links

* [tbconfig tool](https://github.com/telcobridges-main/tmedia-wiki/tree/main/reference/api/toolpack-application-tbconfig/README.md)
* [Ruby Implementation Example](https://github.com/telcobridges-main/tmedia-wiki/tree/main/reference/api/northbound-interface-ruby-implementation/README.md)
* [Postman Tool Integration](https://github.com/telcobridges-main/tmedia-wiki/tree/main/reference/api/northbound-interface-postman-tool-integration/README.md)
* [Download full Active Configuration](https://forums.freesbc.com/t720-download-full-active-configuration-and-other-things-from-webgui-in-json-format)

### References

[Wikipedia RESTful API](http://en.wikipedia.org/wiki/Representational_state_transfer)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://prosbcdocs.telcobridges.com/telecom-references/apis-and-integration/restful-api-and-northbound-interface.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.