Monitors and controls message delivery across B2B business functions on IDX. It provides:

• Visibility into the flow control status for subscribed business functions

• Control to stop or resume outbound delivery of a business function to your queue (once per day)

• Insight of other Participants’ flow‑control status

Participants can connect to the AEMO API Gateway through MarketNet.

All communications between AEMO’s API Gateway and participants’ gateways use HTTPS. AEMO APIs do not support HTTP.

OAuth 2.0 with the client credentials grant type. A bearer token is returned and used to authenticate API requests. See OAuth 2.0 authentication

For details, see the Industry Data Exchange Platform Standard

Flow Control API Reference

Cursor-based pagination is supported for GET requests

JSON

10 MB compressed

To connect to the IDX Hub, participants need:

• A Participant ID. If your company is a Registered Participant, it is set up during the registration process.

• A user ID and password with user access rights provided by your company's Participant Administrator.

• Access to MarketNet. For details about MarketNet, see Guide to Information Systems.

• Primary and secondary AEMO-signed TLS certificates for MTLS authentication. For help, see TLS Certificate Management.

• An AEMO certificate authority trusted by your systems. See AEMO Hub and Signing Certificates.

• Your IP address range allow listed by AEMO.

• The appropriate IDX URM entities assigned to the Participant User. See User Rights Management.

URM entities:

• FCTRL_FCTRL — access to your Business Function Flow Control endpoints

• FCTRL_STATUS — read access to other Participant status