Archive API

Details

Archive API

About

Gets an archived message or a list of archived messages in your outbound archive

API gateway

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.

Authentication

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

Compression

For details, see the Industry Data Exchange Platform Standard

OpenAPI specification

Archive API Reference

Pagination

Cursor-based pagination is supported for GET requests

Payload format

n/a

Payload limit

n/a

Prerequisites

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.

User rights access

URM entity:  ARCH_RETRIEVE

Validation

Validation is only applied to HTTP headers, query, and path parameters in the request