AzuraCast icon

AzuraCast

Interact with AzuraCast Web API

Actions263

Administration General → Get Relay Details

AI-generated

Summary

Retrieve detailed information about the relay server configured in the AzuraCast installation.

Inputs

  • Send Additional Headers — Optional toggle to include extra HTTP headers in the request.
  • Additional Headers (JSON) — JSON object specifying extra HTTP headers to send when enabled.
  • Body Mode Override — Choose the format for the request body, with 'Auto' as the default that uses built-in fields.
  • Manual JSON Body — Specify a custom JSON body if 'Body Mode Override' is set to JSON.
  • Manual Raw Body — Specify a custom raw text body if 'Body Mode Override' is set to Raw.
  • Manual Input Data Field Name — Name of the input binary property to read for manual binary or multipart payloads.
  • Manual Multipart File Field Name — Multipart file field name expected by the endpoint when using manual multipart mode.
  • Manual Multipart Fields (JSON) — Additional multipart form fields expressed as JSON when using manual multipart mode.
  • Response Format — Select how to parse the response: Auto, Binary, JSON, or Text.
  • Output Data Field Name — Binary output property name used when the response format is set to Binary.
  • Return Full Response — Whether to return the entire HTTP response, including headers and status code.
  • Wrap Response Data — Whether to output the response body as a single item or split array responses into multiple items.

Output shape

a single output item containing the relay details in the chosen response format

Response parsing depends on 'Response Format'; enabling 'Return Full Response' returns full HTTP response including metadata; 'Wrap Response Data' controls if array responses are flattened or preserved as one item.

Examples

Example 1: Retrieve basic relay details in JSON

Set Resource to 'Administration General' and Operation to 'Get Relay Details' with default settings.

Example 2: Get relay details sending additional headers and receive raw text

Enable 'Send Additional Headers' with custom headers JSON, set 'Response Format' to 'Text'.

Links

Discussion