Sign in
peer

Get Peers

This function is an API endpoint that retrieves the list of all peers in the network. It is tagged with "peer" for OpenAPI documentation.

Parameters

  • none

Returns

If successful, this function returns a Json<PeersResponse> object, which includes a success message, the total number of peers, and the list of peers. <br> If no peers are found, this function returns a status::NotFound error. <br>

Errors

This function will return an error if the system is in maintenance mode, or if no peers are found.

Example

GET /api/peers

get/api/peers

Response

msgstring required
totalinteger required

Changes

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

  • b66a109db88a12See the full diff
    • ▲

      the data response's property type/format changed from string/ to array/ for status 200

      response-property-type-changed

    • ○

      api tag peer added

      api-tag-added

    • ○

      api tag todo removed

      api-tag-removed

  • fafd43b82c7812See the full diff
    • ▲

      the data response's property type/format changed from array/ to string/ for status 200

      response-property-type-changed

    • ○

      api tag todo added

      api-tag-added

    • ○

      api tag peer removed

      api-tag-removed

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