BPAPI method Gateway/History

Gateway/History

Returns history for the gateway identified by {id}

Authorization required: Yes

HTTP methods allowed: GET

Syntax: Gateway//History Details

Syntax: Gateway/{id}/History/ Details

Syntax: Gateway/{id}/History/{limit}/ Details

Returns history for the gateway identified by {id}

The parameter {id} is optional. If not given the call will return information about the gateway assigned to the customer identified by the authorization credentials used.(in this case the call will fail if more than one gateway has been assigned)

The optional parameter {limit} may be used to narrow the result. See Property/History for explanation about using {limit}.

{id} may be any of
gateway_id,
user_defined_name,
user_defined_group_name,

If {id} identifies more than one gateway an error response is generated
See also -PropertyHistory-

Popularity: 142 (number of times method has been accessed)

Documentation and tests automatically generated from source-code 2025-12-06 05:04