> 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/developer-reference/restful-api.md).

# RESTful API (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://prosbcdocs.telcobridges.com/tmedia-documentation/products/tmedia/tmedia) VoIP gateway or [ProSBC](https://prosbcdocs.telcobridges.com/). 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://prosbcdocs.telcobridges.com/tmedia-documentation/other-pages/operations/web-server) 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](/telecom-references/developer-reference/restful-api/northbound-interface-restful-api.md)

### Links

* [tbconfig tool](/telecom-references/developer-reference/toolpack-api/toolpack-application-tbconfig.md)
* [Ruby Implementation Example](/telecom-references/developer-reference/restful-api/northbound-interface-ruby-implementation.md)
* [Postman Tool Integration](/telecom-references/developer-reference/restful-api/northbound-interface-postman-tool-integration.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)

## In this section

* [Configuration:H248](/telecom-references/developer-reference/restful-api/configuration-h248.md)
* [Enum Values](/telecom-references/developer-reference/restful-api/enum-values.md)
* [Northbound interface: Postman Tool Integration](/telecom-references/developer-reference/restful-api/northbound-interface-postman-tool-integration.md)
* [Northbound interface: RESTful API](/telecom-references/developer-reference/restful-api/northbound-interface-restful-api.md)
* [Northbound interface: Ruby Implementation](/telecom-references/developer-reference/restful-api/northbound-interface-ruby-implementation.md)
* [RESTful API: Activating a Configuration](/telecom-references/developer-reference/restful-api/restful-api-activating-a-configuration.md)
* [RESTful API: Add MTP3 Point Codes](/telecom-references/developer-reference/restful-api/restful-api-add-mtp3-point-codes.md)
* [RESTful API: Add MTP3 Routes](/telecom-references/developer-reference/restful-api/restful-api-add-mtp3-routes.md)
* [RESTful API: Exporting a Configuration](/telecom-references/developer-reference/restful-api/restful-api-exporting-a-configuration.md)
* [RESTful API: Importing a Configuration](/telecom-references/developer-reference/restful-api/restful-api-importing-a-configuration.md)
* [RESTful API: Updating a Route](/telecom-references/developer-reference/restful-api/restful-api-updating-a-route.md)
* [Web OAM\&P](/telecom-references/developer-reference/restful-api/web-oam-and-p.md)


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://prosbcdocs.telcobridges.com/telecom-references/developer-reference/restful-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.