Portworx OpenStorageObjectstore API
The OpenStorageObjectstore API from Portworx — 3 operation(s) for openstorageobjectstore.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/portworx-openstorageobjectstore-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: OpenStorage SDK OpenStorageAlerts Open Storage Objectstore 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: OpenStorageObjectstore
paths:
/v1/objectstores:
post:
operationId: OpenStorageObjectstore_Create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/apiSdkObjectstoreCreateRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/apiSdkObjectstoreCreateResponse'
description: A successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
description: An unexpected error response.
summary: Creates creates an object store endpoint on specified volume
tags:
- OpenStorageObjectstore
/v1/objectstores/inspect/{objectstore_id}:
get:
operationId: OpenStorageObjectstore_Inspect
parameters:
- description: Id of the object store
in: path
name: objectstore_id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/apiSdkObjectstoreInspectResponse'
description: A successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
description: An unexpected error response.
summary: Inspect returns information about the object store endpoint
tags:
- OpenStorageObjectstore
/v1/objectstores/{objectstore_id}:
delete:
operationId: OpenStorageObjectstore_Delete
parameters:
- description: Id of the object store to delete
in: path
name: objectstore_id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/apiSdkObjectstoreDeleteResponse'
description: A successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
description: An unexpected error response.
summary: Delete destroys the object store endpoint on the volume
tags:
- OpenStorageObjectstore
put:
operationId: OpenStorageObjectstore_Update
parameters:
- description: Objectstore Id to update
in: path
name: objectstore_id
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/apiSdkObjectstoreUpdateRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/apiSdkObjectstoreUpdateResponse'
description: A successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/runtimeError'
description: An unexpected error response.
summary: 'Updates provided objectstore status.
This call can be used to stop and start the server while maintaining the same
object storage id.'
tags:
- OpenStorageObjectstore
components:
schemas:
apiSdkObjectstoreDeleteResponse:
title: Empty response
type: object
protobufAny:
properties:
type_url:
type: string
value:
format: byte
type: string
type: object
apiObjectstoreInfo:
properties:
access_key:
title: AccessKey for login into objectstore
type: string
access_port:
format: int64
title: AccessPort is objectstore server port
type: string
action:
format: int64
title: Action being taken on this objectstore
type: string
current_endpoint:
title: CurrentEndpoint on which objectstore server is accessible
type: string
enabled:
title: Enable/Disable created objectstore
type: boolean
endpoints:
items:
type: string
title: Endpoints for accessing objectstore
type: array
region:
title: Region for this objectstore
type: string
secret_key:
title: SecretKey for login into objectstore
type: string
status:
title: Status of objectstore running/failed
type: string
uuid:
title: UUID of objectstore
type: string
volume_id:
title: VolumeID of volume used by object store
type: string
title: ObjectstoreInfo is a structure that has current objectstore info
type: object
apiSdkObjectstoreUpdateRequest:
properties:
enable:
title: enable/disable objectstore
type: boolean
objectstore_id:
title: Objectstore Id to update
type: string
title: Defines a request to update an object store
type: object
apiSdkObjectstoreUpdateResponse:
title: Empty response
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
apiSdkObjectstoreInspectResponse:
properties:
objectstore_status:
$ref: '#/components/schemas/apiObjectstoreInfo'
title: Defines a response when inspecting an object store endpoint
type: object
apiSdkObjectstoreCreateRequest:
properties:
volume_id:
title: Volume on which objectstore will be running
type: string
title: Defines a request to create an object store
type: object
apiSdkObjectstoreCreateResponse:
properties:
objectstore_status:
$ref: '#/components/schemas/apiObjectstoreInfo'
title: 'Defines a response when an object store has been created for a
specified volume'
type: object
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT