# SimpliVity policies API

**Canonical:** https://apis.io/apis/simplivity/simplivity-policies-api/  
**Provider:** SimpliVity — https://apis.io/providers/simplivity/  
**Base URL:** https://management-virtual-appliance/api  
**Documentation:** https://github.com/HewlettPackard/hpe-simplivity-swagger

SimpliVity policies API is one of 10 APIs that [SimpliVity](https://apis.io/providers/simplivity/) publishes on the [APIs.io](https://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.

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

## Operations (17)

| Method | Path | Summary |
|---|---|---|
| GET | `/policies` | Retrieves all policies defined on this system |
| POST | `/policies` | Creates a new policy |
| GET | `/policies/policy_schedule_report` | Retrieves the policy schedule report |
| POST | `/policies/resume` | Resumes policy-based backups on a specific targeted object |
| POST | `/policies/suspend` | Suspends policy-based backups on a specific targeted object |
| GET | `/policies/{policyId}` | Retrieves the specified policy |
| DELETE | `/policies/{policyId}` | Removes a policy |
| GET | `/policies/{policyId}/datastores` | Retrieves the datastores using this policy |
| POST | `/policies/{policyId}/impact_report/create_rules` | Generate a backup impact reported based on proposed creation of rules for the policy |
| POST | `/policies/{policyId}/impact_report/edit_rules` | Generate a backup impact reported based on proposed changes to the rules for the policy |
| POST | `/policies/{policyId}/rename` | Renames the specified policy |
| POST | `/policies/{policyId}/rules` | Creates one or more new rules or replaces existing rules with new rules for a policy |
| GET | `/policies/{policyId}/rules/{ruleId}` | Retrieves the specified policy rule |
| PUT | `/policies/{policyId}/rules/{ruleId}` | Edits an existing policy rule |
| DELETE | `/policies/{policyId}/rules/{ruleId}` | Removes a policy rule |
| POST | `/policies/{policyId}/rules/{ruleId}/impact_report/delete_rule` | Generate a backup impact reported based on proposed deletion of a policy rule |
| GET | `/policies/{policyId}/virtual_machines` | Retrieves the virtual_machines using this policy |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/simplivity/refs/heads/main/openapi/simplivity-policies-api-openapi.yml
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/simplivity/refs/heads/main/authentication/simplivity-authentication.yml
- **OAuthScopes** — https://raw.githubusercontent.com/api-evangelist/simplivity/refs/heads/main/scopes/simplivity-scopes.yml

## Other SimpliVity APIs (9)

- [SimpliVity backups API](https://apis.io/apis/simplivity/simplivity-backups-api/)
- [SimpliVity cluster_groups API](https://apis.io/apis/simplivity/simplivity-cluster-groups-api/)
- [SimpliVity datastores API](https://apis.io/apis/simplivity/simplivity-datastores-api/)
- [SimpliVity external_stores API](https://apis.io/apis/simplivity/simplivity-external-stores-api/)
- [SimpliVity hosts API](https://apis.io/apis/simplivity/simplivity-hosts-api/)
- [SimpliVity omnistack_clusters API](https://apis.io/apis/simplivity/simplivity-omnistack-clusters-api/)
- [SimpliVity security API](https://apis.io/apis/simplivity/simplivity-security-api/)
- [SimpliVity tasks API](https://apis.io/apis/simplivity/simplivity-tasks-api/)
- [SimpliVity virtual_machines API](https://apis.io/apis/simplivity/simplivity-virtual-machines-api/)

## Tags

Policies

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/simplivity/simplivity-policies-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/simplivity/.