Portworx

Portworx OpenStorageClusterDomains API

The OpenStorageClusterDomains API from Portworx — 4 operation(s) for openstorageclusterdomains.

GitHub OpenAPI

Operations 4

GET /v1/clusterdomains Enumerate returns names of all the cluster domains in the cluster #
POST /v1/clusterdomains/activate/{cluster_domain_name} Activates a cluster domain in the cluster. All the nodes which are part of an active cluster domain will participate in cluster quorum calculation #
POST /v1/clusterdomains/deactivate/{cluster_domain_name} Deactivates a cluster domain in the cluster. All the nodes which are part of a deactivated cluster domain. will not participate in cluster quorum calculation #
GET /v1/clusterdomains/inspect/{cluster_domain_name} Inspect returns information about a cluster domain and a status indicating whether the cluster domain is active #

Documentation

📖
Documentation
https://docs.portworx.com/
📖
GettingStarted
https://docs.portworx.com/portworx-enterprise/get-started
📖
APIReference
https://libopenstorage.github.io/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/portworx/refs/heads/main/openapi/portworx-openstorageclusterdomains-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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/portworx-openstorageclusterdomains-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 form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

portworx-openstorageclusterdomains-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OpenStorage SDK OpenStorageAlerts Open Storage Cluster Domains API
  version: 0.186.0
servers:
- url: https://libopenstorage.github.io/
  description: Base URL declared by the provider in apis.yml (roadmap#122).
security:
- bearerAuth: []
tags:
- name: OpenStorageClusterDomains
paths:
  /v1/clusterdomains:
    get:
      operationId: OpenStorageClusterDomains_Enumerate
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiSdkClusterDomainsEnumerateResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
          description: An unexpected error response.
      summary: Enumerate returns names of all the cluster domains in the cluster
      tags:
      - OpenStorageClusterDomains
  /v1/clusterdomains/activate/{cluster_domain_name}:
    post:
      operationId: OpenStorageClusterDomains_Activate
      parameters:
      - description: Name of the cluster domain to activate
        in: path
        name: cluster_domain_name
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiSdkClusterDomainActivateResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
          description: An unexpected error response.
      summary: 'Activates a cluster domain in the cluster.

        All the nodes which are part of an active cluster domain

        will participate in cluster quorum calculation'
      tags:
      - OpenStorageClusterDomains
  /v1/clusterdomains/deactivate/{cluster_domain_name}:
    post:
      operationId: OpenStorageClusterDomains_Deactivate
      parameters:
      - description: Name of the cluster domain to deactivate
        in: path
        name: cluster_domain_name
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiSdkClusterDomainDeactivateResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
          description: An unexpected error response.
      summary: 'Deactivates a cluster domain in the cluster.

        All the nodes which are part of a deactivated cluster domain.

        will not participate in cluster quorum calculation'
      tags:
      - OpenStorageClusterDomains
  /v1/clusterdomains/inspect/{cluster_domain_name}:
    get:
      operationId: OpenStorageClusterDomains_Inspect
      parameters:
      - description: Name of the cluster domain to inspect
        in: path
        name: cluster_domain_name
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiSdkClusterDomainInspectResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
          description: An unexpected error response.
      summary: 'Inspect returns information about a cluster domain and a

        status indicating whether the cluster domain is active'
      tags:
      - OpenStorageClusterDomains
components:
  schemas:
    apiSdkClusterDomainInspectResponse:
      properties:
        cluster_domain_name:
          title: Name of the cluster domain
          type: string
        is_active:
          title: IsActive indicates whether this cluster domain is active
          type: boolean
      title: Defines a response to inspecting a cluster domain
      type: object
    protobufAny:
      properties:
        type_url:
          type: string
        value:
          format: byte
          type: string
      type: object
    apiSdkClusterDomainsEnumerateResponse:
      properties:
        cluster_domain_names:
          items:
            type: string
          title: List of names of all the cluster domains in a cluster
          type: array
      title: Defines a response when enumerating cluster domains
      type: object
    runtimeError:
      properties:
        code:
          format: int32
          type: integer
        details:
          items:
            $ref: '#/components/schemas/protobufAny'
          type: array
        error:
          type: string
        message:
          type: string
      type: object
    apiSdkClusterDomainDeactivateResponse:
      title: Empty response
      type: object
    apiSdkClusterDomainActivateResponse:
      title: Empty response
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT