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-clusteraddons-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 Cluster Addons 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: clusterAddons
paths:
  /cluster/{cluster_id}/addons:
    get:
      security:
      - api_key: []
      description: 'Required RBAC Policy: kots/cluster/[:clusterid]/addon/list'
      tags:
      - clusterAddons
      summary: Lists addons for all clusters.
      operationId: listClusterAddons
      parameters:
      - x-go-name: ClusterID
        description: Cluster identifier
        name: cluster_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/listClusterAddonsResponse'
        '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
  /cluster/{cluster_id}/addons/objectstore:
    post:
      security:
      - api_key: []
      description: 'Required RBAC Policy: kots/cluster/[:clusterid]/addon/create/objectstore'
      tags:
      - clusterAddons
      summary: Adds an object store addon to a cluster.
      operationId: createClusterAddonObjectStore
      parameters:
      - x-go-name: ClusterID
        description: Cluster identifier
        name: cluster_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          $ref: '#/components/responses/createClusterAddonObjectStoreResponse'
        '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:
                bucket:
                  type: string
                  x-go-name: BucketDeprecated
                bucket_prefix:
                  type: string
                  x-go-name: BucketPrefix
  /cluster/{cluster_id}/addons/{addon_id}:
    delete:
      security:
      - api_key: []
      description: 'Required RBAC Policy: kots/cluster/[:clusterid]/addon/[:addonid]/delete'
      tags:
      - clusterAddons
      summary: Deletes an addon from a cluster.
      operationId: deleteClusterAddon
      parameters:
      - x-go-name: ClusterID
        description: Cluster identifier
        name: cluster_id
        in: path
        required: true
        schema:
          type: string
      - x-go-name: AddonID
        description: Cluster addon identifier
        name: addon_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          $ref: '#/components/responses/responseNoContent'
        '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:
    responseNoContent:
      description: On success, no payload returned
    responseErrUnauthorized:
      description: Return if the caller is not authorized
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                x-go-name: Message
    createClusterAddonObjectStoreResponse:
      description: CreateClusterAddonObjectStoreResponse contains the response to a create cluster object store addon request
      content:
        application/json:
          schema:
            type: object
            properties:
              addon:
                $ref: '#/components/schemas/ClusterAddon'
    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
    listClusterAddonsResponse:
      description: ListClusterAddonsResponse contains the response to a list clusters addons request
      content:
        application/json:
          schema:
            type: object
            properties:
              addons:
                type: array
                items:
                  $ref: '#/components/schemas/ClusterAddon'
                x-go-name: Addons
  schemas:
    ClusterAddonPort:
      type: object
      properties:
        is_wildcard:
          type: boolean
          x-go-name: IsWildcard
        name:
          type: string
          x-go-name: Name
        protocol_http:
          type: boolean
          x-go-name: ProtocolHTTP
        protocol_https:
          type: boolean
          x-go-name: ProtocolHTTPS
        protocol_ws:
          type: boolean
          x-go-name: ProtocolWS
        protocol_wss:
          type: boolean
          x-go-name: ProtocolWSS
        upstream_port:
          type: integer
          format: int64
          x-go-name: UpstreamPort
      x-go-package: github.com/replicatedhq/vandoor/pkg/vendor-api/cluster/types
    ClusterAddonObjectStore:
      type: object
      properties:
        bucket_name:
          type: string
          x-go-name: BucketName
        bucket_prefix:
          type: string
          x-go-name: BucketPrefix
        service_account_name:
          type: string
          x-go-name: ServiceAccountName
        service_account_name_read_only:
          type: string
          x-go-name: ServiceAccountNameReadOnly
        service_account_namespace:
          type: string
          x-go-name: ServiceAccountNamespace
      x-go-package: github.com/replicatedhq/vandoor/pkg/vendor-api/cluster/types
    ClusterAddonStatus:
      type: string
      x-go-package: github.com/replicatedhq/vandoor/pkg/vendor-api/cluster/types
    ClusterAddon:
      type: object
      properties:
        cluster_guid:
          type: string
          x-go-name: ClusterGUID
        cluster_id:
          type: string
          x-go-name: ClusterShortID
        created_at:
          type: string
          format: date-time
          x-go-name: CreatedAt
        guid:
          type: string
          x-go-name: GUID
        id:
          type: string
          x-go-name: ShortID
        object_store:
          $ref: '#/components/schemas/ClusterAddonObjectStore'
        port:
          $ref: '#/components/schemas/ClusterAddonPort'
        ready_at:
          type: string
          format: date-time
          x-go-name: ReadyAt
        status:
          $ref: '#/components/schemas/ClusterAddonStatus'
        terminated_at:
          type: string
          format: date-time
          x-go-name: TerminatedAt
        total_credits:
          type: integer
          format: int64
          x-go-name: TotalCredits
      x-go-package: github.com/replicatedhq/vandoor/pkg/vendor-api/cluster/types
  securitySchemes:
    api_key:
      type: apiKey
      name: Authorization
      in: header