How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SimpliVity policies API

A policy contains backup rules that can be applied to an individual datastore or virtual_machine.

SimpliVity policies API is one of 10 APIs that SimpliVity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Policies. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 17 operations across 13 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 1.25.

Requests are made against a single base URL, https://localhost.

17 operations 13 paths 15 schemas 2 DELETE6 GET8 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.25
Base URL
https://management-virtual-appliance/api
Authentication
OAuth 2.0
Contact
Hewlett Packard Enterprise
License
HPE OmniStack REST API
Resource Areas
1

Authentication & Security 1

SimpliVity policies API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the password flow, exposing 2 scopes.

Paths & Operations 17

Across 13 paths, the API surfaces 17 operations — 2 DELETE, 6 GET, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

policies 17

A policy contains backup rules that can be applied to an individual datastore or virtualmachine.

GET
/policies
Retrieves all policies defined on this system
listPolicies 11 params → 200401403404
POST
/policies
Creates a new policy
createPolicy 1 param body → 200201401403404
GET
/policies/policy_schedule_report
Retrieves the policy schedule report
getPolicyScheduleReport 1 param → 200401403404
POST
/policies/resume
Resumes policy-based backups on a specific targeted object
resumePolicy body → 200201401403404
POST
/policies/suspend
Suspends policy-based backups on a specific targeted object
suspendPolicy body → 200201401403404
GET
/policies/{policyId}
Retrieves the specified policy
getPolicy 1 param → 200401403404
DELETE
/policies/{policyId}
Removes a policy
deletePolicy 1 param → 200204401403
GET
/policies/{policyId}/datastoresdeprecated
Retrieves the datastores using this policy
getPolicyDatastores 1 param → 200401403404
POST
/policies/{policyId}/impact_report/create_rules
Generate a backup impact reported based on proposed creation of rules for the policy
reportOnProposedRulesCreation 2 params body → 200201401403404
POST
/policies/{policyId}/impact_report/edit_rules
Generate a backup impact reported based on proposed changes to the rules for the policy
reportOnProposedRulesEdits 2 params body → 200201401403404
POST
/policies/{policyId}/rename
Renames the specified policy
renamePolicy 1 param body → 200201401403404
POST
/policies/{policyId}/rules
Creates one or more new rules or replaces existing rules with new rules for a policy
createRule 2 params body → 200201401403404
GET
/policies/{policyId}/rules/{ruleId}
Retrieves the specified policy rule
getRule 2 params → 200401403404
PUT
/policies/{policyId}/rules/{ruleId}
Edits an existing policy rule
updateRule 2 params body → 200201401403404
DELETE
/policies/{policyId}/rules/{ruleId}
Removes a policy rule
deleteRule 2 params → 200204401403
POST
/policies/{policyId}/rules/{ruleId}/impact_report/delete_rule
Generate a backup impact reported based on proposed deletion of a policy rule
reportOnProposedRuleDeletion 2 params → 200201401403404
GET
/policies/{policyId}/virtual_machinesdeprecated
Retrieves the virtualmachines using this policy
getPolicyVirtualMachines 1 param → 200401403404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are virtual_machine (39 properties), datastore (20 properties), rule (13 properties), report_on_proposed_rules_edits (10 properties). Each schema is shown below with its type and property counts.

share
object
An object (host) that shares the datastore
3 properties 3 required
virtual_machine
object
An instance of a virtualmachine defined on this system
39 properties 21 required
policy_schedule_impact_report
object
The policy backup schedule reports for prior to and after applying proposed changes
2 properties 2 required
NetworkInterface
object
6 properties 6 required
suspend_or_resume_policy
object
Suspends or resumes policy backups
2 properties 1 required
ReplicaInfo
object
2 properties 2 required
AffectedObjectMO
object
2 properties 2 required
datastore
object
An instance of a datastore that is defined on this system
20 properties 17 required
create_or_rename_policy
object
Creates a new policy
1 property 1 required
report_on_proposed_rules_edits
object
Generate a backup impact reported based on proposed changes to the rules for the policy
10 properties 3 required
TaskMO
object
A task that was created as a result of an operation performed on the system
7 properties 5 required
rule
object
A backup policy rule defined on this system
13 properties 2 required
policy_schedule_report
object
A policy on this system
6 properties 6 required
policy
object
A policy on this system
6 properties 6 required
create_or_edit_rule
object
Creates a policy rule
9 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

simplivity-policies-api-openapi.yml Raw ↑

Other APIs SimpliVity publishes across the network.

SimpliVity backups API
SimpliVity cluster_groups API
SimpliVity datastores API
SimpliVity external_stores API
SimpliVity hosts API
SimpliVity omnistack_clusters API
SimpliVity security API
SimpliVity tasks API
SimpliVity virtual_machines API
Where this information came from

This is an independent, third-party profile of SimpliVity policies API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.