REreplicated
networks

List test networks.

Changed on

Each network includes a resources field containing a historical list of all clusters and VMs that have ever been associated with the network. Resources remain in the list even after deletion to preserve history for network report correlation.

Required RBAC Policy: kots/network/list

get/networks

Request

  • Base URL
    https://api.replicated.com/vendor/v3
  • URL
    https://api.replicated.com/vendor/v3/networks
  • Auth
    API key in header Authorization

Query parameters

pageSizeinteger

Page size

currentPageinteger

Current page

sortColumnstring

Sort column

sortDescboolean

Sort descending

show-terminatedboolean

Show terminated networks

terminated-filterstring

Filter terminated networks. Allowed values: "all" (default, no filter) or "with-report" (only include terminated networks that have a report).

start-timestring

Specify a start time in the format "YYYY-MM-DDTHH:MM:SSZ"

end-timestring

Specify an end time in the format "YYYY-MM-DDTHH:MM:SSZ"

Response

ListNetworksResponse contains the response to list networks

errorstring
totalNetworksinteger

Changes

  • a36c6aead22fRevision changes
    • info

      added the new optional query request parameter show-terminated

    • info

      added the new optional query request parameter terminated-filter

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status