Home > Storage > PowerFlex > White Papers > PowerFlex REST API Introduction > PowerFlex PowerAPI
PowerFlex PowerAPI is based on a common Dell PowerAPI style guide. The PowerAPI style establishes guidelines so that Dell APIs look and behave in a consistent manner across all products. In PowerFlex v4.0, the PowerAPI endpoints are used to manage SSO, NAS, file, events, and alerts. The base URL for the PowerAPI is https://<PFMP>/rest/v1. The format for URIs that support the GET method are the collection query and the instance query:
Optional URL parameters can be used with the collection queries. If a parameter is not in the collection URL, a 200 response will return all identifiers for the specified resource type. The optional parameters are select and filter.
Collection query examples
Collection query without optional parameters:
GET https://pfmp/rest/v1/nas-snapshot-rules
A 200 response:
[
{
"id": "23913393-3ce2-4203-929d-8b3163d60fca"
},
{
"id": "74df3a14-8f81-420e-b191-4dc7745325ad"
}
]
Collection with optional select statement:
GET https://pfmp/rest/v1/nas-snapshot-rules?select=id,name
A 200 response:
[
{
"id": "23913393-3ce2-4203-929d-8b3163d60fca",
"name": "Daily"
},
{
"id": "74df3a14-8f81-420e-b191-4dc7745325ad",
"name": "Weekly"
}
]
The select parameter also supports wildcards. You can select all parameters for an object by using the asterisk (select=*)
Example:
GET https://pfmp/rest/v1/nas-protection-policies?select=*
A 200 response:
[
{
"id": "86c83dd9-0899-4c65-adc8-c08d20ae5071",
"name": "ProdFS",
"description": null,
"snapshot_rule_ids": [
"23913393-3ce2-4203-929d-8b3163d60fca",
"74df3a14-8f81-420e-b191-4dc7745325ad"
]
}
]
An example of an instance query and selecting a set of properties:
GET https://pfmp/rest/v1/nas-snapshot-rules/23913393-3ce2-4203-929d-8b3163d60fca?select=name,interval,retention,type
A 200 response:
{
"name": "Daily",
"interval": "ONE_DAY",
"retention": 168,
"type": "PROTOCOL_READ_ONLY"
}
An example of using a collection query with the filter parameter:
Example:
GET https://pfmp/rest/v1/events?filter=id%20eq%200cd7750c33c064b0
A 200 response:
{
"results": [
{
"code": "70020001",
"name": "DEPLOYMENT",
"description": "The deployment job FG Storage-only with SDT failed for service template TME-Storage-LACP-with-SDT (8aaa3a1c85e5474d0186043cf635463b).",
"severity": "CRITICAL",
"category": "STATE_CHANGED",
"details": {
"code": "VXFM00213",
"message": "The deployment job FG Storage-only with SDT failed for service template TME-Storage-LACP-with-SDT (8aaa3a1c85e5474d0186043cf635463b)."
},
"domain": "MANAGEMENT",
"id": "0cd7750c33c064b0",
"timestamp": "2023-01-30T22:41:06.954Z",
"resource_type": "basic-system-config",
"resource_name": "asmmanager",
"resource_id": "asmcore",
"service_name": "ASMCORE",
"service_version": "1.0",
"service_instance_id": "504b0a60-45dd-4637-b34b-bcd4554bc39a",
"originating_application_name": null,
"request_id": null,
"related_events": null,
"job_id": null,
"is_internal": false
}
]
}