find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/replicated-networks-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  description: Manage enterprise portal users, install options, branding, documentation, email templates, and access control.
  title: Vendor API V3 apps Networks API
  contact:
    name: Replicated, Inc.
    url: http://www.replicated.com/
    email: info@replicated.com
  version: 3.0.0
servers:
- url: https://api.replicated.com/vendor/v3
tags:
- name: networks
paths:
  /network/{network_id}:
    get:
      security:
      - api_key: []
      description: 'The resources field contains a historical list of all clusters and VMs that have ever been

        associated with this network. Resources remain in the list even after deletion to preserve

        history for network report correlation.


        Required RBAC Policy: kots/network/[:clusterid]'
      tags:
      - networks
      summary: Get the details for a test network.
      operationId: getNetwork
      parameters:
      - x-go-name: NetworkID
        description: Network identifier
        name: network_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/getNetworkResponse'
        '400':
          $ref: '#/components/responses/responseErrBadRequest'
        '401':
          $ref: '#/components/responses/responseErrUnauthorized'
        '403':
          $ref: '#/components/responses/responseErrForbidden'
        '404':
          $ref: '#/components/responses/responseErrNotFound'
      servers:
      - url: https://api.replicated.com/vendor/v3
  /network/{network_id}/update:
    put:
      security:
      - api_key: []
      description: 'Required RBAC Policy: kots/network/[:networkid]/update'
      tags:
      - networks
      summary: Update network settings (policy and/or collect report).
      operationId: updateNetwork
      parameters:
      - x-go-name: NetworkID
        description: Network identifier
        name: network_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/updateNetworkResponse'
        '400':
          $ref: '#/components/responses/updateNetworkErrorResponse'
        '401':
          $ref: '#/components/responses/responseErrUnauthorized'
        '403':
          $ref: '#/components/responses/responseErrForbidden'
        '404':
          $ref: '#/components/responses/responseErrNotFound'
      servers:
      - url: https://api.replicated.com/vendor/v3
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                policy:
                  type: string
                  x-go-name: Policy
  /networks:
    get:
      security:
      - api_key: []
      description: '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'
      tags:
      - networks
      summary: List test networks.
      operationId: listNetworks
      parameters:
      - x-go-name: PageSize
        description: Page size
        name: pageSize
        in: query
        schema:
          type: integer
          format: int64
          default: 20
      - x-go-name: CurrentPage
        description: Current page
        name: currentPage
        in: query
        schema:
          type: integer
          format: int64
      - x-go-name: SortColumn
        description: Sort column
        name: sortColumn
        in: query
        schema:
          type: string
      - x-go-name: SortDesc
        description: Sort descending
        name: sortDesc
        in: query
        schema:
          type: boolean
      - x-go-name: ShowTerminated
        description: Show terminated networks
        name: show-terminated
        in: query
        schema:
          type: boolean
      - x-go-name: TerminatedFilter
        description: 'Filter terminated networks. Allowed values: "all" (default, no filter) or

          "with-report" (only include terminated networks that have a report).'
        name: terminated-filter
        in: query
        schema:
          type: string
      - x-go-name: StartTimeStr
        description: Specify a start time in the format "YYYY-MM-DDTHH:MM:SSZ"
        name: start-time
        in: query
        schema:
          type: string
      - x-go-name: EndTimeStr
        description: Specify an end time in the format "YYYY-MM-DDTHH:MM:SSZ"
        name: end-time
        in: query
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/listNetworksResponse'
        '400':
          $ref: '#/components/responses/responseErrBadRequest'
        '401':
          $ref: '#/components/responses/responseErrUnauthorized'
        '403':
          $ref: '#/components/responses/responseErrForbidden'
        '404':
          $ref: '#/components/responses/responseErrNotFound'
      servers:
      - url: https://api.replicated.com/vendor/v3
components:
  responses:
    getNetworkResponse:
      description: GetNetworkResponse contains the response to get network details
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                x-go-name: Error
              network:
                $ref: '#/components/schemas/Network'
    listNetworksResponse:
      description: ListNetworksResponse contains the response to list networks
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                x-go-name: Error
              networks:
                type: array
                items:
                  $ref: '#/components/schemas/Network'
                x-go-name: Networks
              totalNetworks:
                type: integer
                format: int64
                x-go-name: TotalNetworks
    responseErrUnauthorized:
      description: Return if the caller is not authorized
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                x-go-name: Message
    updateNetworkResponse:
      description: UpdateNetworkResponse contains the response to update a network
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                x-go-name: Error
              network:
                $ref: '#/components/schemas/Network'
    responseErrForbidden:
      description: Returned if the caller does not have the needed permission
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  message:
                    type: string
                    x-go-name: Message
                  messageCode:
                    type: string
                    x-go-name: MessageCode
                x-go-name: Error
    responseErrNotFound:
      description: Returned on resource not found
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                x-go-name: Message
    responseErrBadRequest:
      description: Returned on bad input
      content:
        application/json:
          schema:
            type: object
            properties:
              error_code:
                description: Error code if available
                type: string
                x-go-name: ErrorCode
              message:
                description: Error message text if available
                type: string
                x-go-name: Message
    updateNetworkErrorResponse:
      description: UpdateNetworkErrorResponse contains error information
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                x-go-name: Message
  schemas:
    NetworkStatus:
      type: string
      x-go-package: github.com/replicatedhq/vandoor/pkg/vendor-api/network/types
    NetworkResource:
      type: object
      properties:
        distribution:
          type: string
          x-go-name: Distribution
        id:
          type: string
          x-go-name: ID
        name:
          type: string
          x-go-name: Name
      x-go-package: github.com/replicatedhq/vandoor/pkg/vendor-api/network/types
    Network:
      type: object
      properties:
        assigned_at:
          type: string
          format: date-time
          x-go-name: AssignedAt
        collect_report:
          type: boolean
          x-go-name: CollectReport
        created_at:
          type: string
          format: date-time
          x-go-name: CreatedAt
        distribution:
          type: string
          x-go-name: Distribution
        expires_at:
          type: string
          format: date-time
          x-go-name: ExpiresAt
        guid:
          type: string
          x-go-name: GUID
        has_report:
          type: boolean
          x-go-name: HasReport
        id:
          type: string
          x-go-name: ShortID
        last_scheduling_status:
          type: string
          x-go-name: LastSchedulingStatus
        name:
          type: string
          x-go-name: Name
        policy:
          type: string
          x-go-name: Policy
        resources:
          description: Resources contains the clusters and VMs associated with this network
          type: array
          items:
            $ref: '#/components/schemas/NetworkResource'
          x-go-name: Resources
        running_at:
          type: string
          format: date-time
          x-go-name: RunningAt
        status:
          $ref: '#/components/schemas/NetworkStatus'
        team_id:
          type: string
          x-go-name: TeamID
        ttl:
          type: string
          x-go-name: TTL
        version:
          type: string
          x-go-name: Version
      x-go-package: github.com/replicatedhq/vandoor/pkg/vendor-api/network/types
  securitySchemes:
    api_key:
      type: apiKey
      name: Authorization
      in: header