Get Relay application

GET

https://{your_space_name}.signalwire.com/api/fabric/resources/relay_applications/:id

Retrieves one Relay Application by resource ID so you can inspect how SignalWire routes events to its Relay Server SDK listener. Use List Relay applications to discover IDs, or a SWML Script when no Relay Server SDK process should receive the event.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice, Messaging, Fax, or Video.

Learn more about API scopes.

Retrieves one Relay Application by resource ID so you can inspect how SignalWire routes events to its Relay Server SDK listener. Use [List Relay applications](/docs/apis/rest/relay-application/list-relay-applications) to discover IDs, or a [SWML Script](/docs/apis/rest/swml-scripts/create-swml-script) when no Relay Server SDK process should receive the event. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

idstringRequiredformat: "uuid"

Unique ID of a Relay Application.

Response

The request has succeeded.

idstringformat: "uuid"

Unique ID of the Relay Application.

project_idstringformat: "uuid"

Unique ID of the Project.

display_namestring

Display name of the Relay Application Fabric Resource

typeenum

Type of the Fabric Resource

created_atdatetime

Date and time when the resource was created.

updated_atdatetime

Date and time when the resource was updated.

relay_applicationobject

Relay Application data.

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error