SimpliVity

SimpliVity external_stores API

An external (non HPE SimpliVity) destination for storing backups, such as an HPE StoreOnce Catalyst store

GitHub OpenAPI

Operations 4

GET /external_stores Retrieves all external_stores #
POST /external_stores Registers a new external store #
POST /external_stores/unregister Removes the external store as a backup destination for the cluster. Backups remain on the external store, but they can no longer be managed by HPE SimpliVity. #
POST /external_stores/update_credentials Update the IP address or credentials that HPE SimpliVity uses to access the external store #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/simplivity/refs/heads/main/authentication/simplivity-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/simplivity/refs/heads/main/openapi/simplivity-external-stores-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/simplivity/refs/heads/main/scopes/simplivity-scopes.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/simplivity-external-stores-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

simplivity-external-stores-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: "This API enables the programmatic management of key components of an HPE SimpliVity configuration.\n\nTo access the API, request an authentication token by issuing an authentication request in the following form, where the username/password combination is a set of valid management credentials for the applicable hypervisor environment:\n\n     curl -k https://simplivity@<host>/api/oauth/token -d grant_type=password -d username=<user> -d password=<pass>\n\nThen, you can pass in the resulting access_token returned in each HTTP header using Authorization: Bearer token. For example:\n\n     curl -H \"Authorization: Bearer 0a08c809-17ff-479f-b0a8-aedd4d8305a0\"\n\nThe access_token times out after 10 minutes of inactivity and expires after 24 hours.\n\nMake sure to use TLS version 1.2 or greater.\n\nThere are a wide range of possible return values.  Below is a list of the most common return values. \n\n    200 \"OK\" ⁃ This indicates that the request and action has completed with no issues.\n    201 \"Created\" ⁃ This indicates that the request has completed and a new resource has been created.\n    202 \"Accepted\" ⁃ This indicates that the request has been accepted for processing but the processing has not\n                     completed. This is a typical return when a task is generated.\n    400 \"Bad Request\" ⁃ The request cannot or will not be proccessed.  Usually due to a missing required parameter\n                        or invalid data in the parameter.\n    401 \"Unauthorized\" ⁃ The request has not been applied because it lacks authentication credentials for the\n                         target resource.\n    404 \"Not Found\" ⁃ The requested target doesn't exist or has been deleted.\n    405 \"Method Not Allowed\" ⁃ The method being requested is not valid for the target it is being performed on.\n    408 \"Request Timeout\" ⁃ The response took too long.\n    500 \"Internal Server Error\" ⁃ Indicates that the server encountered an unexpected condition that prevented it\n                                  from fulfilling the request.\n\n<a href=\"https://developer.hpe.com/platform/hpe-simplivity/home\" class=\"\toggleEndpointList\" data-id=\"errors\">Click here for a complete list of return codes and response formats</a>\n\n"
  version: '1.25'
  title: HPE OmniStack REST backups External Stores API
  contact:
    name: Hewlett Packard Enterprise
  license:
    name: HPE OmniStack REST API
servers:
- url: https://localhost
tags:
- name: external_stores
  description: An external (non HPE SimpliVity) destination for storing backups, such as an HPE StoreOnce Catalyst store
paths:
  /external_stores:
    get:
      tags:
      - external_stores
      summary: Retrieves all external_stores
      operationId: listExternalStores
      parameters:
      - name: name
        in: query
        description: 'The name of the external_stores to return


          Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
        required: false
        schema:
          type: string
      - name: omnistack_cluster_id
        in: query
        description: The identifier of the cluster. This identifier is unique within the category namespace.
        required: false
        schema:
          type: string
      - name: management_ip
        in: query
        description: 'The IP address of the external store


          Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
        required: false
        schema:
          type: string
      - name: cluster_group_id
        in: query
        description: 'The unique identifiers (UIDs) of the cluster_groups associated with the external stores to return


          Accepts: Single value, comma-separated list'
        required: false
        schema:
          type: string
      - name: fields
        in: query
        description: "A comma-separated list of fields to include in the returned objects\n\n Default: Returns all fields"
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: 'A positive integer that represents the maximum number of results to return


          Default: 500'
        required: false
        schema:
          type: integer
          format: int32
          default: 500
      - name: offset
        in: query
        description: 'A positive integer that directs the service to start returning the &lt;offset value&gt; instance, up to the limit


          Default: 0'
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - name: case
        in: query
        description: 'An indicator that specifies if the filter and sort results use a case-sensitive or insensitive manner


          Valid values: sensitive or insensitive


          Default: sensitive'
        required: false
        schema:
          type: string
          enum:
          - sensitive
          - insensitive
          default: sensitive
      - name: sort
        in: query
        description: The name of the field where the sort occurs
        required: false
        schema:
          type: string
      - name: order
        in: query
        description: 'The sort order preference


          Valid values: ascending or descending


          Default: descending'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/vnd.simplivity.v1.19+json:
              schema:
                $ref: '#/components/schemas/external_store'
            application/vnd.simplivity.v1.23+json:
              schema:
                $ref: '#/components/schemas/external_store'
            application/json:
              schema:
                $ref: '#/components/schemas/external_store'
            application/vnd.simplivity.v1.18+json:
              schema:
                $ref: '#/components/schemas/external_store'
            application/vnd.simplivity.v1.13+json:
              schema:
                $ref: '#/components/schemas/external_store'
            application/vnd.simplivity.v1.16+json:
              schema:
                $ref: '#/components/schemas/external_store'
            application/vnd.simplivity.v1.24+json:
              schema:
                $ref: '#/components/schemas/external_store'
            application/vnd.simplivity.v1.14+json:
              schema:
                $ref: '#/components/schemas/external_store'
            application/vnd.simplivity.v1.11+json:
              schema:
                $ref: '#/components/schemas/external_store'
            application/vnd.simplivity.v1.17+json:
              schema:
                $ref: '#/components/schemas/external_store'
            application/vnd.simplivity.v1.21+json:
              schema:
                $ref: '#/components/schemas/external_store'
            application/vnd.simplivity.v1.22+json:
              schema:
                $ref: '#/components/schemas/external_store'
            application/vnd.simplivity.v1.15+json:
              schema:
                $ref: '#/components/schemas/external_store'
            application/vnd.simplivity.v1.25+json:
              schema:
                $ref: '#/components/schemas/external_store'
            application/vnd.simplivity.v1.12+json:
              schema:
                $ref: '#/components/schemas/external_store'
            application/vnd.simplivity.v1.20+json:
              schema:
                $ref: '#/components/schemas/external_store'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    post:
      tags:
      - external_stores
      summary: Registers a new external store
      operationId: registerExternalStores
      responses:
        '200':
          description: OK
          content:
            application/vnd.simplivity.v1.19+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.23+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.18+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.13+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.16+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.24+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.14+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.11+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.17+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.21+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.22+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.15+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.25+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.12+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.20+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      requestBody:
        content:
          application/vnd.simplivity.v1.19+json:
            schema:
              $ref: '#/components/schemas/register_external_store'
          application/vnd.simplivity.v1.23+json:
            schema:
              $ref: '#/components/schemas/register_external_store'
          application/vnd.simplivity.v1.18+json:
            schema:
              $ref: '#/components/schemas/register_external_store'
          application/vnd.simplivity.v1.13+json:
            schema:
              $ref: '#/components/schemas/register_external_store'
          application/vnd.simplivity.v1.16+json:
            schema:
              $ref: '#/components/schemas/register_external_store'
          application/vnd.simplivity.v1.24+json:
            schema:
              $ref: '#/components/schemas/register_external_store'
          application/vnd.simplivity.v1.14+json:
            schema:
              $ref: '#/components/schemas/register_external_store'
          application/vnd.simplivity.v1.11+json:
            schema:
              $ref: '#/components/schemas/register_external_store'
          application/vnd.simplivity.v1.17+json:
            schema:
              $ref: '#/components/schemas/register_external_store'
          application/vnd.simplivity.v1.21+json:
            schema:
              $ref: '#/components/schemas/register_external_store'
          application/vnd.simplivity.v1.22+json:
            schema:
              $ref: '#/components/schemas/register_external_store'
          application/vnd.simplivity.v1.15+json:
            schema:
              $ref: '#/components/schemas/register_external_store'
          application/vnd.simplivity.v1.25+json:
            schema:
              $ref: '#/components/schemas/register_external_store'
          application/vnd.simplivity.v1.12+json:
            schema:
              $ref: '#/components/schemas/register_external_store'
          application/vnd.simplivity.v1.20+json:
            schema:
              $ref: '#/components/schemas/register_external_store'
        description: 'management_ip: The IP address of the external store


          management_port: The management IP port of the external store


          Default: 9387


          name: The name of the external_store


          storage_port: The storage IP port of the external store


          Default: 9388


          omnistack_cluster_id: The UID of the omnistack_cluster associated with the external store


          type: The type of external store


          Default: StoreOnceOnPrem


          username: The client name of the external store


          password: The client password of the external store'
        required: true
  /external_stores/unregister:
    post:
      tags:
      - external_stores
      summary: Removes the external store as a backup destination for the cluster. Backups remain on the external store, but they can no longer be managed by HPE SimpliVity.
      operationId: unregisterExternalStores
      responses:
        '200':
          description: OK
          content:
            application/vnd.simplivity.v1.19+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.23+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.18+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.13+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.16+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.24+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.14+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.11+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.17+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.21+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.22+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.15+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.25+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.12+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.20+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      requestBody:
        content:
          application/vnd.simplivity.v1.17+json:
            schema:
              $ref: '#/components/schemas/unregister_external_store'
          application/vnd.simplivity.v1.19+json:
            schema:
              $ref: '#/components/schemas/unregister_external_store'
          application/vnd.simplivity.v1.23+json:
            schema:
              $ref: '#/components/schemas/unregister_external_store'
          application/vnd.simplivity.v1.21+json:
            schema:
              $ref: '#/components/schemas/unregister_external_store'
          application/vnd.simplivity.v1.22+json:
            schema:
              $ref: '#/components/schemas/unregister_external_store'
          application/vnd.simplivity.v1.18+json:
            schema:
              $ref: '#/components/schemas/unregister_external_store'
          application/vnd.simplivity.v1.15+json:
            schema:
              $ref: '#/components/schemas/unregister_external_store'
          application/vnd.simplivity.v1.25+json:
            schema:
              $ref: '#/components/schemas/unregister_external_store'
          application/vnd.simplivity.v1.16+json:
            schema:
              $ref: '#/components/schemas/unregister_external_store'
          application/vnd.simplivity.v1.20+json:
            schema:
              $ref: '#/components/schemas/unregister_external_store'
          application/vnd.simplivity.v1.24+json:
            schema:
              $ref: '#/components/schemas/unregister_external_store'
        description: 'name: The name of the external_store


          omnistack_cluster_id: The UID of the omnistack_cluster associated with the external store'
        required: true
  /external_stores/update_credentials:
    post:
      tags:
      - external_stores
      summary: Update the IP address or credentials that HPE SimpliVity uses to access the external store
      operationId: updateExternalStoreCredentials
      responses:
        '200':
          description: OK
          content:
            application/vnd.simplivity.v1.19+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.23+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.18+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.13+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.16+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.24+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.14+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.11+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.17+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.21+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.22+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.15+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.25+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.12+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
            application/vnd.simplivity.v1.20+json:
              schema:
                $ref: '#/components/schemas/TaskMO'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      requestBody:
        content:
          application/vnd.simplivity.v1.17+json:
            schema:
              $ref: '#/components/schemas/update_external_store_credentials'
          application/vnd.simplivity.v1.19+json:
            schema:
              $ref: '#/components/schemas/update_external_store_credentials'
          application/vnd.simplivity.v1.23+json:
            schema:
              $ref: '#/components/schemas/update_external_store_credentials'
          application/vnd.simplivity.v1.21+json:
            schema:
              $ref: '#/components/schemas/update_external_store_credentials'
          application/vnd.simplivity.v1.22+json:
            schema:
              $ref: '#/components/schemas/update_external_store_credentials'
          application/vnd.simplivity.v1.18+json:
            schema:
              $ref: '#/components/schemas/update_external_store_credentials'
          application/vnd.simplivity.v1.15+json:
            schema:
              $ref: '#/components/schemas/update_external_store_credentials'
          application/vnd.simplivity.v1.25+json:
            schema:
              $ref: '#/components/schemas/update_external_store_credentials'
          application/vnd.simplivity.v1.16+json:
            schema:
              $ref: '#/components/schemas/update_external_store_credentials'
          application/vnd.simplivity.v1.20+json:
            schema:
              $ref: '#/components/schemas/update_external_store_credentials'
          application/vnd.simplivity.v1.24+json:
            schema:
              $ref: '#/components/schemas/update_external_store_credentials'
        description: 'name: The name of the external_store


          username: The client name of the external store


          password: The client password of the external store


          management_ip: The IP address of the external store'
        required: true
components:
  schemas:
    update_external_store_credentials:
      type: object
      required:
      - name
      - password
      - username
      properties:
        management_ip:
          type: string
          description: The IP address of the external store
        name:
          type: string
          description: The name of the external_store
        password:
          type: string
          description: The client password of the external store
        username:
          type: string
          description: The client name of the external store
      description: Update the IP address or credentials that HPE SimpliVity uses to access the external store
    unregister_external_store:
      type: object
      required:
      - name
      - omnistack_cluster_id
      properties:
        name:
          type: string
          description: The name of the external_store
        omnistack_cluster_id:
          type: string
          description: The UID of the omnistack_cluster associated with the external store
      description: Removes the external store as a backup destination for the cluster. Backups remain on the external store, but they can no longer be managed by HPE SimpliVity.
    AffectedObjectMO:
      type: object
      required:
      - object_id
      - object_type
      properties:
        object_id:
          type: string
          description: The unique identifier (UID) of the object affected by the completed task
        object_type:
          type: string
          description: The type of the object affected by the completed task (virtual_machine, datastore, omnistack_cluster, backup, host, policy, rule)
    register_external_store:
      type: object
      required:
      - management_ip
      - name
      - omnistack_cluster_id
      - password
      - username
      properties:
        management_ip:
          type: string
          description: The IP address of the external store
        management_port:
          type: integer
          format: int32
          description: The management IP port of the external store
        name:
          type: string
          description: The name of the external_store
        omnistack_cluster_id:
          type: string
          description: The UID of the omnistack_cluster associated with the external store
        password:
          type: string
          description: The client password of the external store
        storage_port:
          type: integer
          format: int32
          description: The storage IP port of the external store
        type:
          type: string
          description: The type of external store
          enum:
          - StoreOnceOnPrem
          - StoreOnceCloud
        username:
          type: string
          description: The client name of the external store
      description: Registers a new external store
    TaskMO:
      type: object
      required:
      - affected_objects
      - end_time
      - id
      - start_time
      - state
      properties:
        affected_objects:
          type: array
          description: For a completed task, the unique identifiers (UIDs) and types of the objects affected by the operation
          items:
            $ref: '#/components/schemas/AffectedObjectMO'
        end_time:
          type: string
          description: The time the task finished, expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)
        error_code:
          type: integer
          format: int32
          description: The error code returned if a task failed
        error_message:
          type: string
          description: The error message returned if a task fails
        id:
          type: string
          description: The unique identifier (UID) of the task
        start_time:
          type: string
          description: The time the task started, expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)
        state:
          type: string
          description: The current state of the task object
          enum:
          - IN_PROGRESS
          - COMPLETED
          - FAILED
      description: A task that was created as a result of an operation performed on the system
    external_store:
      type: object
      required:
      - cluster_group_ids
      - management_ip
      - name
      - omnistack_cluster_id
      properties:
        cluster_group_ids:
          type: array
          description: The unique identifiers (UIDs) of the cluster_groups associated with the external store
          items:
            type: string
        management_ip:
          type: string
          description: The IP address of the external store
        management_port:
          type: integer
          format: int32
          description: The management IP port of the external store
        name:
          type: string
          description: The name of the external_store
        omnistack_cluster_id:
          type: string
          description: The UID of the omnistack_cluster associated with the external store
        storage_port:
          type: integer
          format: int32
          description: The storage IP port of the external store
        type:
          type: string
          description: The type of external store
      description: An external_store
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        password:
          scopes:
            read: Grants read access
            write: Grants write access
          tokenUrl: /oauth/token