Sign in
address book

List peers

This function is an API endpoint that lists the peers in an address book. It is tagged with "address book" for OpenAPI documentation.

Parameters

  • current: The current page number for pagination. This parameter is currently unused.

  • pageSize: The number of items per page for pagination. This parameter is currently unused.

  • ab: The identifier of the address book.

Returns

If successful, this function returns a Json<AbPeersResponse> object containing the peers in the address book. <br> If the address book does not exist or the user is not authorized to access it, this function returns a status::Unauthorized error. <br>

Errors

This function will return an error if the system is in maintenance mode, or if the address book does not exist or the user is not authorized to access it.

post/api/ab/peers

Query parameters

currentinteger required
pageSizeinteger required
abstring required

Response

errorstring nullable
totalinteger required

Changes

Changed in 2 of the 11 revisions of this API.42

  • 12b1b72bc3f322See the full diff
    • ▲

      for the query request parameter current, the type/format was changed from integer/int32 to integer/uint32

      request-parameter-type-changed

    • ▲

      for the query request parameter pageSize, the type/format was changed from integer/int32 to integer/uint32

      request-parameter-type-changed

    • ●

      for the query request parameter current, the min was set to 0.00

      request-parameter-min-set

    • ●

      for the query request parameter pageSize, the min was set to 0.00

      request-parameter-min-set

  • fafd43b82c782See the full diff
    • ▲

      for the query request parameter current, the type/format was changed from integer/uint32 to integer/int32

      request-parameter-type-changed

    • ▲

      for the query request parameter pageSize, the type/format was changed from integer/uint32 to integer/int32

      request-parameter-type-changed

    This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog