Pure1 Public REST API (1.latest)

Download OpenAPI specification:

Pure1 Public REST API, developed by Everpure, Inc.

The Pure1 REST API 1.latest offers one single form of authentication: OAuth 2.0 via the Token Exchange protocol.

OAuth 2.0 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, desktop and background applications.

Note that the Authentication section below mentions 'API Key' as the security scheme type. This is solely for the purpose of allowing testing this API with Swagger UI.

Knowledge base reference documentation

Authorization

Handles authorization access to other API endpoints through OAuth 2.0 Token Exchange.

Get access token

Exchanges an ID Token for an OAuth 2.0 access token.

header Parameters

X-Request-ID

string

Supplied by client during request or generated by server.

Request Body schema: application/x-www-form-urlencoded
required

grant_type required	string (OauthGrantType) Default: "urn:ietf:params:oauth:grant-type:token-exchange" The method by which the access token will be obtained. The Everpure REST API supports the OAuth 2.0 "token exchange" grant type, which indicates that a token exchange is being performed. Set `grant_type` to `urn:ietf:params:oauth:grant-type:token-exchange`.
subject_token required	string (OauthSubjectToken) An encoded security ID Token representing the identity of the party on behalf of whom the request is being made. The token must be issued by a trusted identity provider which must be either a registered application in Pure1 or an enabled API client on the array. The token must be a JSON Web Token and must contain the following claims: \| JWT claim \| Location \| API Client Field \| Description \| Required By \| \|-\|-\|-\|-\|-\| \| kid \| Header \| key_id \| Key ID of the API client that issues the identity token. \| FlashArray and FlashBlade only. \| \| aud \| Payload \| id \| Client ID of the API client that issues the identity token. \| FlashArray and FlashBlade only. \| \| sub \| Payload \| \| Login name of the array user for whom the token should be issued. This must be a valid user in the system. \| FlashArray and FlashBlade only. \| \| iss \| Payload \| issuer \| Application ID for the Pure1 or API client's trusted identity issuer on the array. \| All products. \| \| iat \| Payload \| \| Timestamp of when the identity token was issued. Measured in milliseconds since the UNIX epoch. \| All products. \| \| exp \| Payload \| \| Timestamp of when the identity token will expire. Measured in milliseconds since the UNIX epoch. \| All products. \| Each token must also be signed with the private key that is paired with the API client's public key.
subject_token_type required	string (OauthSubjectTokenType) Default: "urn:ietf:params:oauth:token-type:jwt" An identifier that indicates the type of security token specifed in the `subject_token` parameter. The Everpure REST API supports the JSON Web Token (JWT) as the means for requesting the access token. Set `subject_token_type` to `urn:ietf:params:oauth:token-type:jwt`.

Responses

Response samples

Content type

application/json

{"access_token": "eyJraWQiOiJqTlBzL1Ria2c4U2Vua3F3ZmkvbnI4bWxxQ3NPIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhdWQiOiI5NDcyMTkwOC1mNzkyLTcxMmUtYTYzOS0wODM5ZmE4MzA5MjIiLCJzdWIiOiJqb2UiLCJyb2xlIjoic3RvcmFnZV9hZG1pbiIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6OTAwMCIsImlhdCI6MTU0NDAzNjA1MiwiZXhwIjoxNTQ0MDcyMDUyLCJqdGkiOiJjOTg0MjgyNS1mNGM3LTRiNGUtODdkNy03OWFiZmIxYTUzNDgifQ.pnuYAx0CkmkIG0LDrMAQGRr5Ci4-t5yMto3A7BkmyKnAVHBXG5ZIWwvNkWDLhqbA4YjmG7LZmWHrCVehLy2zy2vRLahFURsd3GTnOaWSyWFIyrwpoO81jQRtOQATtseweuMT_-C8o3oa4MgBNBsuKrhwKQS3oDDpeRPaCRTGev1_xRDxh_K6CWJBTAeOP2pcR4LW6zIJkCLzzkMuyL4aTJWWUjSbl04mcFbyw8r8W1GURrmaDVOvvpT634Hk9-GGh9OMIRlS6OOq7cJKc-RRWn18IK2Gs53V_KYshXTBbnRr990Y_qOX8MaTWOJTqgzsojY02MSVuJ9XDJWoIU3TQytr4K1vM2EvwDZDgl7LuUYUn7vWhbKktFzpeZyyhOjq3eX-ViugYKpIjBcG2f_-fcTPceEWGV82rd6TyVNB5A-v9u2kxCdW198t_kesgVQfuupDeS02cZe0ABLCzEHPiVF17JfiVr6sjkciioxN7Wj_j18ga4U0mdSukauT8yhbgCW1ijTVTFu1VwWebW0s8z3BWMtXdTtZ3BhcZVAdKRF8bOq7nfEbUQGhTn9g7dK-yF050winjtp-VTL2oUtkF5j1v_N8vPNiN9ZdkGJZr7VVZ-qeOJZcjdaRbxL6YB__yT1wkTcKPh8RHz6GUq7Jbyw8VIlcBE2nvJ63d0tH9C4",
"expires_in": 35999,
"issued_token_type": "urn:ietf:params:oauth:token-type:access_token",
"token_type": "Bearer"
}

Alerts

Provides access to capacity, health, and hardware related array alerts.

Get alerts

Retrieves information about alerts generated by Pure1-monitored appliances.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"arrays": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
],
"actual": "empty",
"category": "array",
"closed": 1502729489760,
"code": 100,
"component_name": "drive1",
"component_type": "drive",
"created": 1502729489760,
"description": "Some sort of failure.",
"expected": "healthy",
"knowledge_base_url": "https://support.purestorage.com/",
"notified": 1502729489760,
"origin": "array",
"severity": "critical",
"state": "open",
"summary": "Test alert.",
"updated": 1502729489760
}
]
}

Arrays

Provides information about FlashArray and FlashBlade appliances.

Get arrays

Retrieves information about FlashArray and FlashBlade storage appliances.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
fqdns	Array of strings A comma-separated list of resource FQDNs. If there is not at least one resource that matches each `fqdn` element, an error is returned. Single quotes are required around all strings.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "example_name",
"fleet": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"fqdn": "https://array01.dc1.example.com",
"model": "FA-m70r2",
"os": "Purity//FA",
"version": "5.0.0"
}
]
}

Get array support contracts

Retrieves the support contracts associated with arrays.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
resource_fqdns	Array of strings A comma-separated list of resource FQDNs. If there is not at least one resource that matches each `resource_fqdn` element, an error is returned. Single quotes are required around all strings.
resource_ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `resource_id` element, an error is returned. Single quotes are required around all strings.
resource_names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `resource_name` element, an error is returned. Single quotes are required around all strings.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"end_date": 1582502400000,
"resource": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
},
"start_date": 1550966400000
}
]
}

Get array tags

Retrieves the tags associated with specified arrays.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
keys	Array of strings A comma-separated list of tag keys. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
namespaces	Array of strings A comma-separated list of namespaces. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
resource_ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `resource_id` element, an error is returned. Single quotes are required around all strings.
resource_names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `resource_name` element, an error is returned. Single quotes are required around all strings.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"key": "example_key",
"namespace": "pure1",
"resource": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"tag_organization_id": 101,
"value": "value123"
}
]
}

Delete array tags

Deletes array tags from Pure1.

Authorizations:

AuthorizationHeader

query Parameters

keys	Array of strings A comma-separated list of tag keys. Single quotes are required around all strings.
namespaces	Array of strings A comma-separated list of namespaces. Single quotes are required around all strings.
resource_ids	Array of strings REQUIRED: either `resource_ids` or `resource_names`. A comma-separated list of resource IDs. If there is not at least one resource that matches each `resource_id` element, an error is returned. Single quotes are required around all strings.
resource_names	Array of strings REQUIRED: either `resource_ids` or `resource_names`. A comma-separated list of resource names. If there is not at least one resource that matches each `resource_name` element, an error is returned. Single quotes are required around all strings.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"errors": [{"context": "Error with ...",
"message": "Something was wrong"
}
]
}

Create or update array tags

Creates or updates array tags contextual to Pure1 only.

Authorizations:

AuthorizationHeader

query Parameters

namespaces	Array of strings A comma-separated list of namespaces. Single quotes are required around all strings.
resource_ids	Array of strings REQUIRED: either `resource_ids` or `resource_names`. A comma-separated list of resource IDs. If there is not at least one resource that matches each `resource_id` element, an error is returned. Single quotes are required around all strings.
resource_names	Array of strings REQUIRED: either `resource_ids` or `resource_names`. A comma-separated list of resource names. If there is not at least one resource that matches each `resource_name` element, an error is returned. Single quotes are required around all strings.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json
required

Array

key	string Key of the tag.
value	string Value of the tag.

Responses

Request samples

Payload

Content type

application/json

[{"key": "example_key",
"value": "value123"
}
]

Response samples

Content type

application/json

{"items": [{"key": "example_key",
"namespace": "pure1",
"resource": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"tag_organization_id": 101,
"value": "value123"
}
]
}

Audits

Provides access to CLI audit logs from FlashArray and FlashBlade appliances.

Get audits

Retrieves audit objects.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"arrays": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
],
"arguments": "--args",
"command": "purevol",
"origin": "array",
"subcommand": "snap",
"time": 1502729489760,
"user": "pureuser"
}
]
}

Blades

Provides information about FlashBlade blades.

Get blades

Retrieves information about FlashBlade blades.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "example_name",
"arrays": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com",
"total_blades": 15,
"used_blades": 10
}
],
"details": "string",
"raw_capacity": 0,
"status": "healthy"
}
]
}

Buckets

Provides information about FlashBlade buckets.

Get buckets

Retrieves buckets.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"arrays": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
],
"account": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"created": 1502729489760,
"destroyed": true,
"object_count": 15,
"versioning": "string"
}
]
}

Bucket Replica Links

Provides information about replica links between buckets.

Get bucket replica links

Retrieves information about bucket replica links.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
member_ids	Array of strings A list of member IDs. Member IDs separated by a `+` indicate that both members must be present in each element. Member IDs separated by a `,` indicate that at least one member must be present in each element. If there is not at least one resource that matches each `member_id` element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of member IDs separated by a `+` must be entered in the same item cell.
member_names	Array of strings A list of member names. Member names separated by a `+` indicate that both members must be present in each element. Member names separated by a `,` indicate that at least one member must be present in each element. If there is not at least one resource that matches each `member_name` element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of member names separated by a `+` must be entered in the same item cell.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.
source_ids	Array of strings A list of source IDs. Source IDs separated by a `+` indicate that both sources must be present in each element. Source IDs separated by a `,` indicate that at least one source must be present in each element. If there is not at least one resource that matches each `source_id` element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of source IDs separated by a `+` must be entered in the same item cell.
source_names	Array of strings A list of source names. Source names separated by a `+` indicate that both sources must be present in each element. Source names separated by a `,` indicate that at least one source must be present in each element. If there is not at least one resource that matches each `source_name` element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of source names separated by a `+` must be entered in the same item cell.
target_ids	Array of strings A list of target IDs. Target IDs separated by a `+` indicate that both targets must be present in each element. Target IDs separated by a `,` indicate that at least one target must be present in each element. If there is not at least one resource that matches each `target_id` element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of target IDs separated by a `+` must be entered in the same item cell.
target_names	Array of strings A list of target names. Target names separated by a `+` indicate that both targets must be present in each element. Target names separated by a `,` indicate that at least one target must be present in each element. If there is not at least one resource that matches each `target_name` element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of target names separated by a `+` must be entered in the same item cell.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"lag": 1560,
"paused": false,
"recovery_point": 1565034592494,
"status": "replicating",
"members": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"location": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
}
],
"sources": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"location": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
}
],
"status_details": "string",
"targets": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"location": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
}
]
}
]
}

Controllers

Provides information about FlashArray controllers.

Get controllers

Retrieves information about controllers.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "example_name",
"arrays": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
],
"mode": "primary",
"model": "FA-m50",
"status": "ready",
"type": "array_controller",
"version": "5.0.0"
}
]
}

Directories

Provides information about FlashArray directories.

Get managed directories

Retrieves information about FlashArray managed directory objects.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
file_system_ids	Array of strings Performs the operation on the file system ID specified. Enter multiple file system IDs in comma-separated format. The `file_system_ids` and `file_system_names` parameters cannot be provided together. Single quotes are required around all strings.
file_system_names	Array of strings Performs the operation on the file system name specified. Enter multiple file system names in comma-separated format. For example, `filesystem1,filesystem2`. The `file_system_ids` and `file_system_names` parameters cannot be provided together. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "example_name",
"arrays": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
],
"created": 1502729489760,
"destroyed": false,
"directory_name": "string",
"file_system": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"path": "string"
}
]
}

Drives

Provides information about FlashArray drives.

Get drives

Retrieves information about FlashArray drives.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "example_name",
"arrays": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"drive_count": 24,
"fqdn": "example_name.dc1.example.com",
"total_capacity": 7625244672
}
],
"capacity": 494927872,
"details": "Slow link speed.",
"protocol": "SAS",
"status": "healthy",
"type": "SSD"
}
]
}

File Systems

Provides information about FlashArray and FlashBlade file systems.

Get FlashArray and FlashBlade file systems

Retrieves information about FlashArray and FlashBlade file system objects.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "example_name",
"arrays": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
],
"created": 1502729489760,
"destroyed": false,
"fast_remove_directory_enabled": false,
"hard_limit_enabled": false,
"http": {"enabled": false
},
"nfs": {"enabled": false,
"rules": "10.0.0.1(ro)"
},
"provisioned": 1099511627776,
"smb": {"enabled": true
},
"snapshot_directory_enabled": false
}
]
}

Get FlashBlade file system / policy pairs

Retrieves pairs of FlashBlade file system members and their policies.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
member_ids	Array of strings A comma-separated list of member IDs. If there is not at least one resource that matches each `member_id` element, an error is returned. Single quotes are required around all strings.
member_names	Array of strings A comma-separated list of member names. If there is not at least one resource that matches each `member_name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
policy_ids	Array of strings A comma-separated list of policy IDs. If there is not at least one resource that matches each `policy_id` element, an error is returned. Single quotes are required around all strings.
policy_names	Array of strings A comma-separated list of policy names. If there is not at least one resource that matches each `policy_name` element, an error is returned. Single quotes are required around all strings.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"member": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"policy": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
}
}
]
}

File System Replica Links

Provides information about replica links between FlashBlade file systems.

Get FlashBlade file system replica links

Retrieves information about FlashBlade file system replica links.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
member_ids	Array of strings A list of member IDs. Member IDs separated by a `+` indicate that both members must be present in each element. Member IDs separated by a `,` indicate that at least one member must be present in each element. If there is not at least one resource that matches each `member_id` element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of member IDs separated by a `+` must be entered in the same item cell.
member_names	Array of strings A list of member names. Member names separated by a `+` indicate that both members must be present in each element. Member names separated by a `,` indicate that at least one member must be present in each element. If there is not at least one resource that matches each `member_name` element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of member names separated by a `+` must be entered in the same item cell.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.
source_ids	Array of strings A list of source IDs. Source IDs separated by a `+` indicate that both sources must be present in each element. Source IDs separated by a `,` indicate that at least one source must be present in each element. If there is not at least one resource that matches each `source_id` element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of source IDs separated by a `+` must be entered in the same item cell.
source_names	Array of strings A list of source names. Source names separated by a `+` indicate that both sources must be present in each element. Source names separated by a `,` indicate that at least one source must be present in each element. If there is not at least one resource that matches each `source_name` element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of source names separated by a `+` must be entered in the same item cell.
target_ids	Array of strings A list of target IDs. Target IDs separated by a `+` indicate that both targets must be present in each element. Target IDs separated by a `,` indicate that at least one target must be present in each element. If there is not at least one resource that matches each `target_id` element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of target IDs separated by a `+` must be entered in the same item cell.
target_names	Array of strings A list of target names. Target names separated by a `+` indicate that both targets must be present in each element. Target names separated by a `,` indicate that at least one target must be present in each element. If there is not at least one resource that matches each `target_name` element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of target names separated by a `+` must be entered in the same item cell.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"lag": 1560,
"paused": false,
"recovery_point": 1565034592494,
"status": "replicating",
"members": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"location": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
}
],
"sources": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"location": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
}
],
"status_details": "string",
"targets": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"location": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
}
]
}
]
}

Get FlashBlade file system replica link / policy pairs

Retrieves pairs of FlashBlade file system replica link members and their policies.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
member_ids	Array of strings A comma-separated list of member IDs. If there is not at least one resource that matches each `member_id` element, an error is returned. Single quotes are required around all strings.
member_names	Array of strings A comma-separated list of member names. If there is not at least one resource that matches each `member_name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
policy_ids	Array of strings A comma-separated list of policy IDs. If there is not at least one resource that matches each `policy_id` element, an error is returned. Single quotes are required around all strings.
policy_names	Array of strings A comma-separated list of policy names. If there is not at least one resource that matches each `policy_name` element, an error is returned. Single quotes are required around all strings.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"member": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"policy": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
}
}
]
}

File System Snapshots

Provides information about FlashBlade file system snapshots.

Get FlashBlade file system snapshots

Retrieves snapshots of FlashBlade file systems.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.
source_ids	Array of strings A comma-separated list of ids for the source of the object. If there is not at least one resource that matches each `source_id` element, an error is returned. Single quotes are required around all strings.
source_names	Array of strings A comma-separated list of names for the source of the object. If there is not at least one resource that matches each `source_name` element, an error is returned. Single quotes are required around all strings.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "example_name",
"arrays": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
],
"created": 1502729489760,
"destroyed": false,
"on": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
},
"source": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"suffix": "checkpoint_2018_01_01"
}
]
}

Get FlashBlade file system snapshot / policy pairs

Retrieves pairs of FlashBlade file system snapshot members and their policies.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
member_ids	Array of strings A comma-separated list of member IDs. If there is not at least one resource that matches each `member_id` element, an error is returned. Single quotes are required around all strings.
member_names	Array of strings A comma-separated list of member names. If there is not at least one resource that matches each `member_name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
policy_ids	Array of strings A comma-separated list of policy IDs. If there is not at least one resource that matches each `policy_id` element, an error is returned. Single quotes are required around all strings.
policy_names	Array of strings A comma-separated list of policy names. If there is not at least one resource that matches each `policy_name` element, an error is returned. Single quotes are required around all strings.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"member": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"policy": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
}
}
]
}

Fleets

Provides information about fleets.

Get fleets

Retrieves information about the fleets known to the organization.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "example_name"
}
]
}

Hardware

Provides information about hardware components.

Get hardware

Retrieves information about hardware components.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "example_name",
"arrays": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
],
"details": "Temperature too high",
"identify_enabled": true,
"model": "DFSC1",
"serial": "PSMFL1717009B",
"slot": 16,
"speed": 24000000000,
"status": "critical",
"temperature": 25,
"type": "controller",
"voltage": 206
}
]
}

Hardware Connectors

Provides information about FlashBlade hardware connectors.

Get hardware connectors

Retrieves information about FlashBlade hardware connectors.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "example_name",
"arrays": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
],
"connector_type": "QSFP",
"lane_speed": 10000000000,
"port_count": 1,
"transceiver_type": "40GBASE-LR4"
}
]
}

Invoices

Provides information about Pure1 subscription invoices.

Get invoices

Retrieves information about Pure1 subscription invoices.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
partner_purchase_orders	Array of strings A comma-separated list of partner purchase order numbers. If there is not at least one resource that matches each `partner_purchase_order` element, an error is returned. Single quotes are required around all strings.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.
subscription_ids	Array of strings A comma-separated list of subscription IDs. If there is not at least one resource that matches each `subscription.id` element, an error is returned. Single quotes are required around all strings.
subscription_names	Array of strings A comma-separated list of subscription names. If there is not at least one resource that matches each `subscription.name` element, an error is returned. Single quotes are required around all strings.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"amount": 1070,
"currency": "USD",
"date": 1672531200000,
"due_date": 1672531200000,
"end_user_name": "Everpure",
"end_user_purchase_order": "415Tib/400Tib/123456",
"id": "INV123456",
"lines": [{"amount": 1000,
"components": [{"description": "24/7 support",
"item": "08-0144",
"quantity": 1
}
],
"description": "SS-DFM-15TB 1 Month Evergreen Forever Subscription, NBD Delivery, 24/7 Support",
"end_date": 1672531200000,
"item": "SS-DFM-15TB 1MO,ADV,GOLD",
"quantity": 2,
"start_date": 1672531200000,
"tax": {"amount": 70,
"exemption_statement": "string",
"percentage": 0.07
},
"unit_price": 500
}
],
"partner_purchase_order": "123456-1",
"payment_terms": "Net 45",
"sales_representative": "John Doe",
"ship_date": 1672531200000,
"status": "open",
"subscription": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
}
}
]
}

Metrics

Provides information about historical metrics for arrays, buckets, directories, file systems, pods, subscription licenses, and volumes.

Get metrics

Retrieves information about metrics that can be queried for.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
resource_types	Array of strings The resource types to list the available metrics. Valid values are `arrays`, `buckets`, `directories`, `file-systems`, `pods`, `subscription-licenses` and `volumes`. A metric can belong to a combination of resources, e.g., write-iops from array to pod. In that case, query by ['arrays', 'pods']. Single quotes are required around all strings.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "example_name",
"availabilities": [{"aggregations": ["avg"
],
"resolution": 30000,
"retention": 2592000000
}
],
"description": "string",
"resource_types": ["example_resource_type"
],
"unit": "B/s"
}
]
}

Get metrics history

Retrieves historical metric data for resources. This endpoint supports batching: Up to 32 time series can be retrieved in one call. It can be multiple metrics for one resource, (e.g., load and bandwidth for one array - 2 time series), one metric for multiple resource (e.g., load for arrayA and arrayB - 2 time series), or a combination of both, multiple metrics for multiple resources, (e.g., load and bandwidth for arrayA and arrayB - 4 time series).

Authorizations:

AuthorizationHeader

query Parameters

aggregation required	string Aggregation needed on the metric data. Valid values are `avg` and `max`. Single quotes are required around all strings. Latency metrics averages are weighted by the IOPS.
end_time required	integer <int64> Timestamp of when the time window ends. Measured in milliseconds since the UNIX epoch.
ids	Array of strings REQUIRED: either `ids` or `names`. A comma-separated list of object IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
names	Array of strings REQUIRED: either `names` or `ids`. A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
resolution required	integer <int64> The duration of time between individual data points, in milliseconds.
resource_ids	Array of strings REQUIRED: either `resource_ids` or `resource_names`. A comma-separated list of resource IDs. If there is not at least one resource that matches each `resource_id` element, an error is returned. Single quotes are required around all strings.
resource_names	Array of strings REQUIRED: either `resource_ids` or `resource_names`. A comma-separated list of resource names. If there is not at least one resource that matches each `resource_name` element, an error is returned. Single quotes are required around all strings.
start_time required	integer <int64> Timestamp of when the time window starts. Measured in milliseconds since the UNIX epoch.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "example_name",
"aggregation": "avg",
"data": [[1502729489760,
123
]
],
"resolution": 30000,
"resources": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
],
"unit": "B/s"
}
]
}

Network Interfaces

Provides information about network interfaces available on arrays.

Get network interfaces

Retrieves information about physical and virtual network interface objects.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "example_name",
"arrays": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
],
"address": "10.11.12.13",
"enabled": true,
"gateway": "10.20.30.40",
"hwaddr": "90:ef:ba:80:70:dc",
"mtu": 9000,
"netmask": "255.255.255.0",
"services": ["iscsi"
],
"speed": 10000000000,
"subinterfaces": ["ct0.eth0"
]
}
]
}

Object Store Accounts

Provides information about object store accounts.

Get object store accounts

Retrieves object store accounts.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"arrays": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
],
"created": 1502729489760,
"object_count": 15
}
]
}

Planning

Provides planning projections for FlashArray and FlashBlade appliances.

Evaluate planning simulation

Evaluates projected load and capacity for a caller-specified set of arrays. Arrays are listed in the request resources field; each array in resources that is not targeted by a simulation step receives baseline projections, and each array targeted by one or more steps receives simulated projections that reflect the applied steps. Arrays referenced only inside a step but not listed in resources participate in the simulation as input and do not appear in the response. A missing or empty resources array is rejected, as are simulations/volumes/move steps that reference volumes belonging to a stretched pod. The valid step actions are simulations/volumes/move and simulations/activecluster/failover. This request computes results synchronously and does not create a persistent simulation object.

Authorizations:

AuthorizationHeader

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json
required

	Array of objects (PlanningSimulationMetricRequest) The projected metrics to include in the response, each optionally with a per-metric aggregation mode. If `metrics` is not specified, the server returns both `projected_load` and `projected_capacity` with the default aggregation mode. Only `projected_load` differs by aggregation mode; `projected_capacity` is computed on daily granularity, so both aggregation modes return the same values. If a metric entry omits `aggregation`, the server uses `blended_max` as the default.
projection_end_time	integer <int64> The end of the projection window, in UTC milliseconds since the UNIX epoch. If not specified, defaults to three months after the request time.
projection_start_time	integer <int64> The start of the projection window, in UTC milliseconds since the UNIX epoch. If not specified, defaults to the most recent UTC midnight at or before the request time.
resolution	integer <int64> The resolution of projected time series in milliseconds. If not specified, defaults to daily (`86400000` milliseconds).
required	Array of objects (PlanningSimulationArrayReference) non-empty The arrays for which to return projected load and capacity. Each entry identifies an array by `id` or `name`. Arrays listed here without a corresponding simulation step receive baseline projections; arrays targeted by one or more steps receive simulated projections. This field is required and must contain at least one array.
	Array of any (PlanningSimulationStep) The simulation steps to apply. If omitted or empty, the response contains baseline projections for every array listed in `resources`.
training_end_time	integer <int64> The end of the historical training window, in UTC milliseconds since the UNIX epoch. If not specified, defaults to the most recent UTC midnight at or before the request time.
training_start_time	integer <int64> The start of the historical training window, in UTC milliseconds since the UNIX epoch. If not specified, defaults to three months before the request time.

Responses

Request samples

Payload

Content type

application/json

{"metrics": [{"aggregation": "blended_max",
"name": "projected_load"
}
],
"projection_end_time": 1772460000000,
"projection_start_time": 1768464000000,
"resolution": 86400000,
"resources": [{"id": "string",
"name": "string"
}
],
"steps": [{"action": "simulations/activecluster/failover",
"details": {"arrays": [{"id": "string",
"name": "string"
},
{"id": "string",
"name": "string"
}
]
}
}
],
"training_end_time": 1768464000000,
"training_start_time": 1762460000000
}

Response samples

Content type

application/json

{"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "projected_load",
"aggregation": "blended_max",
"data": [[1502729489760,
0.123
]
],
"resolution": 86400000,
"resources": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
],
"unit": "percent"
}
],
"total_item_count": 4
}

Pods

Provides information about FlashArray pods. A pod is the pairing of two arrays that replicate some volumes with each other.

Get pods

Retrieves information about pod objects.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"arrays": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
],
"mediator": "purestorage",
"source": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
}
}
]
}

Pod Replica Links

Provides information about replica links between FlashArray pods.

Get pod replica links

Retrieves information about pod replica links.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
member_ids	Array of strings A list of member IDs. Member IDs separated by a `+` indicate that both members must be present in each element. Member IDs separated by a `,` indicate that at least one member must be present in each element. If there is not at least one resource that matches each `member_id` element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of member IDs separated by a `+` must be entered in the same item cell.
member_names	Array of strings A list of member names. Member names separated by a `+` indicate that both members must be present in each element. Member names separated by a `,` indicate that at least one member must be present in each element. If there is not at least one resource that matches each `member_name` element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of member names separated by a `+` must be entered in the same item cell.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.
source_ids	Array of strings A list of source IDs. Source IDs separated by a `+` indicate that both sources must be present in each element. Source IDs separated by a `,` indicate that at least one source must be present in each element. If there is not at least one resource that matches each `source_id` element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of source IDs separated by a `+` must be entered in the same item cell.
source_names	Array of strings A list of source names. Source names separated by a `+` indicate that both sources must be present in each element. Source names separated by a `,` indicate that at least one source must be present in each element. If there is not at least one resource that matches each `source_name` element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of source names separated by a `+` must be entered in the same item cell.
target_ids	Array of strings A list of target IDs. Target IDs separated by a `+` indicate that both targets must be present in each element. Target IDs separated by a `,` indicate that at least one target must be present in each element. If there is not at least one resource that matches each `target_id` element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of target IDs separated by a `+` must be entered in the same item cell.
target_names	Array of strings A list of target names. Target names separated by a `+` indicate that both targets must be present in each element. Target names separated by a `,` indicate that at least one target must be present in each element. If there is not at least one resource that matches each `target_name` element, an error is returned. Single quotes are required around all strings. When using Try it Out in Swagger, a list of target names separated by a `+` must be entered in the same item cell.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"lag": 1560,
"paused": false,
"recovery_point": 0,
"status": "replicating",
"members": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"locations": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
]
}
],
"sources": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"locations": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
]
}
],
"targets": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"locations": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
]
}
]
}
]
}

Policies

Provides information about FlashBlade policies and the members they apply to.

Get policies

Retrieves policies and their rules.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "example_name",
"arrays": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
],
"enabled": true,
"rules": [{"at": 32400000,
"every": 86400000,
"keep_for": 86400000,
"time_zone": "America/Los_Angeles"
}
]
}
]
}

Get policy / FlashBlade file system pairs

Retrieves pairs of policy references and their FlashBlade file system members.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
member_ids	Array of strings A comma-separated list of member IDs. If there is not at least one resource that matches each `member_id` element, an error is returned. Single quotes are required around all strings.
member_names	Array of strings A comma-separated list of member names. If there is not at least one resource that matches each `member_name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
policy_ids	Array of strings A comma-separated list of policy IDs. If there is not at least one resource that matches each `policy_id` element, an error is returned. Single quotes are required around all strings.
policy_names	Array of strings A comma-separated list of policy names. If there is not at least one resource that matches each `policy_name` element, an error is returned. Single quotes are required around all strings.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"member": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"policy": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
}
}
]
}

Get policy / FlashBlade file system replica link pairs

Retrieves pairs of policy references and their FlashBlade file system replica link members.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
member_ids	Array of strings A comma-separated list of member IDs. If there is not at least one resource that matches each `member_id` element, an error is returned. Single quotes are required around all strings.
member_names	Array of strings A comma-separated list of member names. If there is not at least one resource that matches each `member_name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
policy_ids	Array of strings A comma-separated list of policy IDs. If there is not at least one resource that matches each `policy_id` element, an error is returned. Single quotes are required around all strings.
policy_names	Array of strings A comma-separated list of policy names. If there is not at least one resource that matches each `policy_name` element, an error is returned. Single quotes are required around all strings.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"member": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"policy": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
}
}
]
}

Get policy / FlashBlade file system snapshot pairs

Retrieves pairs of policy references and their FlashBlade file system snapshot members.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
member_ids	Array of strings A comma-separated list of member IDs. If there is not at least one resource that matches each `member_id` element, an error is returned. Single quotes are required around all strings.
member_names	Array of strings A comma-separated list of member names. If there is not at least one resource that matches each `member_name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
policy_ids	Array of strings A comma-separated list of policy IDs. If there is not at least one resource that matches each `policy_id` element, an error is returned. Single quotes are required around all strings.
policy_names	Array of strings A comma-separated list of policy names. If there is not at least one resource that matches each `policy_name` element, an error is returned. Single quotes are required around all strings.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"member": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"policy": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
}
}
]
}

Get policy / member pairs

Retrieves pairs of policy references and their members.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
member_ids	Array of strings A comma-separated list of member IDs. If there is not at least one resource that matches each `member_id` element, an error is returned. Single quotes are required around all strings.
member_names	Array of strings A comma-separated list of member names. If there is not at least one resource that matches each `member_name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
policy_ids	Array of strings A comma-separated list of policy IDs. If there is not at least one resource that matches each `policy_id` element, an error is returned. Single quotes are required around all strings.
policy_names	Array of strings A comma-separated list of policy names. If there is not at least one resource that matches each `policy_name` element, an error is returned. Single quotes are required around all strings.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"member": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"policy": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
}
}
]
}

Ports

Provides information about FlashArray ports.

Get ports

Retrieves information about FlashArray ports.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "example_name",
"arrays": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
],
"failover": "CT0.ETH2",
"iqn": "iqn.2010-06.com.purestorage:flasharray.393d930077be2977",
"nqn": "nqn.2010-06.com.purestorage:flasharray.512f7bb185978505",
"portal": "10.16.200.27:3260",
"wwn": "52:4A:93:70:4E:E5:68:00"
}
]
}

Recommendations

Provides proactive recommendations for Everpure assets, including FlashArray hardware upgrades, Evergreen//One license upgrades, support contracts and other assets.

Get recommendations

Retrieves proactive recommendations for Everpure assets across all recommendation types. Each item includes a recommendation_type field that identifies the type-specific endpoint for enriched details: /recommendations/flasharray-hardware-upgrade, /recommendations/license-upgrade, or /recommendations/support-contract-renewal.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters. Filterable fields: id, trigger.name, recommendation_type, target.id, target.name, target.resource_type, company.name, subscription_license.id. Subsequent requests with a continuation token must be used with the same filter parameters as the original request.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
sort	Array of strings Sort the response by the specified fields (in descending order if '-' is appended to the field name). Sortable fields: id, trigger.name, recommendation_type, target.id, target.name, target.resource_type, company.name, subscription_license.id, created_at, _as_of. Subsequent requests with a continuation token must be used with the same sort parameters as the original request.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "example_name",
"company": {"name": "Acme Corp"
},
"created_at": 1716000000000,
"description": "Analyzes FlashArray capacity utilization and load metrics, and recommends capacity expansion and/or controller upgrade if needed.",
"recommendation_type": "flasharray-hardware-upgrade",
"subscription_license": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"target": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"trigger": {"name": "prorec-capacity-upgrade"
}
}
]
}

Get FlashArray hardware upgrade recommendations

Retrieves FlashArray hardware upgrade recommendations. Response items include all base recommendation fields plus FlashArray hardware upgrade type-specific payload fields in a flat structure. Documented in the flasharray-hardware-upgrade-recommendation schema.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters. Filterable fields: id, trigger.name, recommendation_type, target.id, target.name, target.resource_type, company.name, subscription_license.id. Subsequent requests with a continuation token must be used with the same filter parameters as the original request.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
sort	Array of strings Sort the response by the specified fields (in descending order if '-' is appended to the field name). Sortable fields: id, trigger.name, recommendation_type, target.id, target.name, target.resource_type, company.name, subscription_license.id, created_at, _as_of. Subsequent requests with a continuation token must be used with the same sort parameters as the original request.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": null,
"total_item_count": 1,
"items": [{"_as_of": 1716000000000,
"id": "a1b2c3d4-0000-0000-0000-000000000001",
"name": "Production Array 01",
"created_at": 1715900000000,
"company": {"name": "Acme Corp"
},
"description": "Analyzes FlashArray capacity utilization and load metrics, and recommends\ncapacity expansion and/or controller upgrade if needed.\n",
"target": {"id": "array-12345",
"name": "Production Array 01",
"resource_type": "arrays"
},
"trigger": {"name": "prorec-capacity-upgrade"
},
"subscription_license": null,
"recommendation_type": "flasharray-hardware-upgrade",
"current_installed_capacity": 107374182400,
"current_model": "FA-X70R2",
"current_usable_capacity": 85899345920,
"end_of_life_components": [{"component_type": "SHELF",
"end_of_life": 1716103450000,
"protocol": "SAS"
}
],
"recommended_full_sku": "FA-X90R5-FULL",
"recommended_installed_capacity": 214748364800,
"recommended_model": "FA-X90R5",
"recommended_upgrade_sku": "FA-X90R5-UPG",
"recommended_usable_capacity": 171798691840
}
]
}

Get license upgrade recommendations

Retrieves Evergreen//One license upgrade recommendations. Response items include all base recommendation fields plus license upgrade type-specific payload fields in a flat structure. Documented in the license-upgrade-recommendation schema.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters. Filterable fields: id, trigger.name, recommendation_type, target.id, target.name, target.resource_type, company.name, subscription_license.id. Subsequent requests with a continuation token must be used with the same filter parameters as the original request.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
sort	Array of strings Sort the response by the specified fields (in descending order if '-' is appended to the field name). Sortable fields: id, trigger.name, recommendation_type, target.id, target.name, target.resource_type, company.name, subscription_license.id, created_at, _as_of. Subsequent requests with a continuation token must be used with the same sort parameters as the original request.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": null,
"total_item_count": 1,
"items": [{"_as_of": 1716000000000,
"id": "f1f1f1f1-0000-0000-0000-000000000002",
"name": "E1-US-West-01",
"created_at": 1715900000000,
"company": {"name": "Acme Corp"
},
"description": "Recommends upgrading the Evergreen//One license tier when workload performance demands warrant it.",
"target": {"id": "license-abc-123",
"name": "E1-US-West-01",
"resource_type": "subscription-licenses"
},
"trigger": {"name": "prorec-eone-tier-upgrade"
},
"subscription_license": {"id": "license-abc-123",
"name": "E1-US-West-01",
"resource_type": "subscription-licenses"
},
"recommendation_type": "license-upgrade",
"current_bandwidth_sla_bytes_per_sec": 5368709120,
"current_iops_sla": 40000,
"current_reserve_exceeded_in_days": 40,
"current_reserved_amount": 100,
"current_service_tier": "//Block - Capacity",
"recommended_bandwidth_sla_bytes_per_sec": 10737418240,
"recommended_iops_sla": 80000,
"recommended_reserved_amount": 200,
"recommended_service_tier": "//Block - Performance",
"reserved_unit": "TiB"
}
]
}

Get support contract renewal recommendations

Retrieves support contract renewal recommendations. Response items include all base recommendation fields plus support contract renewal type-specific payload fields in a flat structure. Documented in the support-contract-renewal-recommendation schema.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters. Filterable fields: id, trigger.name, recommendation_type, target.id, target.name, target.resource_type, company.name, subscription_license.id. Subsequent requests with a continuation token must be used with the same filter parameters as the original request.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
sort	Array of strings Sort the response by the specified fields (in descending order if '-' is appended to the field name). Sortable fields: id, trigger.name, recommendation_type, target.id, target.name, target.resource_type, company.name, subscription_license.id, created_at, _as_of. Subsequent requests with a continuation token must be used with the same sort parameters as the original request.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": null,
"total_item_count": 1,
"items": [{"_as_of": 1716000000000,
"id": "c9d8e7f6-0000-0000-0000-000000000003",
"name": "2024-Q4 Renewal",
"created_at": 1715900000000,
"company": {"name": "Acme Corp"
},
"description": "Recommends renewing the support contract based on a prepared renewal quote from Pure Storage.",
"target": {"id": "quote-98765",
"name": "2024-Q4 Renewal",
"resource_type": "quote"
},
"trigger": {"name": "quote-based-contract-renewal"
},
"subscription_license": null,
"recommendation_type": "support-contract-renewal",
"partner_name": "Partner Corp",
"subscription_term_months": 36,
"support_contracts": [{"expires": 1716200000000,
"subscription_evergreen_tier": "Evergreen//Forever",
"target": {"id": "target-id-00001",
"name": "FlashArray-X90R4",
"resource_type": "arrays"
},
"target_model": "FA-X90R4"
},
{"expires": 1716250000000,
"subscription_evergreen_tier": "Evergreen//Forever",
"target": {"id": "target-id-00002",
"name": "license-abc-123",
"resource_type": "licenses"
},
"target_model": null
}
]
}
]
}

Protection Group Snapshots

Protection group snapshots capture the content of all volumes on the source array for the specified protection group at a single point in time. The snapshot is an immutable image of the volume data at that instance in time. The volumes are either direct members of the protection group or connected to any of its hosts or host groups within a protection group. Volumes are protected through protection group snapshots that are retained locally, replicated to other arrays or storage systems, or both. Protection group snapshots can be manually generated on demand or enabled to automatically generate at scheduled intervals. After a protection group snapshot has been taken, it is either stored on the local array or replicated over to a remote (target) array.

Get protection group snapshots

Retrieves information about snapshots of protection groups

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.
source_ids	Array of strings A comma-separated list of ids for the source of the object. If there is not at least one resource that matches each `source_id` element, an error is returned. Single quotes are required around all strings.
source_names	Array of strings A comma-separated list of names for the source of the object. If there is not at least one resource that matches each `source_name` element, an error is returned. Single quotes are required around all strings.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "example_name",
"created": 1502729489760,
"on": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
},
"pod": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"source": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
}
}
]
}

Get protection group snapshots with transfer statistics

Retrieves information about snapshots of protection groups

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.
source_ids	Array of strings A comma-separated list of ids for the source of the object. If there is not at least one resource that matches each `source_id` element, an error is returned. Single quotes are required around all strings.
source_names	Array of strings A comma-separated list of names for the source of the object. If there is not at least one resource that matches each `source_name` element, an error is returned. Single quotes are required around all strings.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "example_name",
"completed": 0,
"data_transferred": 0,
"progress": 0.66,
"started": 0
}
]
}

Subscriptions

Provides information about Pure1 subscription offerings.

Get subscriptions

Retrieves information about Pure1 subscriptions.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "example_name",
"customer_name": "Everpure Customer",
"expiration_date": 1636238104000,
"initial_name": "example_name",
"last_updated_date": 1604702243000,
"organization": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"partner_name": "Everpure Partner",
"service": "PaaS (Block Storage Service)",
"service_details": {"service_sla": "NBD",
"service_tier": "Silver"
},
"start_date": 1604702243000,
"status": "active",
"subscription_term": 24
}
]
}

Get subscription licenses

Retrieves information about Pure1 subscription licenses.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
marketplace_partner_reference_ids	Array of strings A comma-separated list of marketplace partner reference IDs. If there is not at least one resource that matches each `marketplace_partner.reference_id` element, an error is returned. Single quotes are required around all strings.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.
subscription_ids	Array of strings A comma-separated list of subscription IDs. If there is not at least one resource that matches each `subscription.id` element, an error is returned. Single quotes are required around all strings.
subscription_names	Array of strings A comma-separated list of subscription names. If there is not at least one resource that matches each `subscription.name` element, an error is returned. Single quotes are required around all strings.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "example_name",
"add_on_slas": [{"name": "string"
}
],
"average_on_demand": {"data": 123,
"metric": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"unit": "B"
},
"expiration_date": 1636238104000,
"last_updated_date": 1604702243000,
"marketplace_partner": {"name": "pure1",
"reference_id": "string"
},
"pre_ratio": {"data": 3.3,
"metric": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"unit": "B"
},
"quarter_on_demand": {"data": 123,
"metric": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"unit": "B"
},
"reservation": {"data": 123,
"metric": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"unit": "B"
},
"resources": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com",
"activation_time": 1604702243000,
"usage": {"data": 123,
"metric": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"unit": "B"
}
}
],
"service_tier": "//Block - Ultra",
"site_address": {"city": "Mountain View",
"country": "United States",
"state": "CA"
},
"start_date": 1604702243000,
"subscription": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"usage": {"data": 123,
"metric": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"unit": "B"
}
}
]
}

Get subscription assets

Retrieves information about Pure1 subscription assets.

Authorizations:

AuthorizationHeader

query Parameters

advanced_space	boolean If `true`, returns the `advanced_space` field containing physical and effective space information.
continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
license_ids	Array of strings A comma-separated list of subscriptionLicense IDs. If there is not at least one resource that matches each `license.id` element, an error is returned. Single quotes are required around all strings.
license_names	Array of strings A comma-separated list of subscriptionLicense names. If there is not at least one resource that matches each `license.name` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.
subscription_ids	Array of strings A comma-separated list of subscription IDs. If there is not at least one resource that matches each `subscription.id` element, an error is returned. Single quotes are required around all strings.
subscription_names	Array of strings A comma-separated list of subscription names. If there is not at least one resource that matches each `subscription.name` element, an error is returned. Single quotes are required around all strings.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "example_name",
"activation_date": 1604702243000,
"array": {"advanced_space": {"effective": {"capacity": {"data": 123,
"metric": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"unit": "B"
},
"total_used": {"data": 123,
"metric": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"unit": "B"
},
"total_used_ratio": {"data": 0.5,
"metric": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"unit": "B"
}
},
"physical": {"capacity": {"data": 123,
"metric": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"unit": "B"
},
"total_used": {"data": 123,
"metric": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"unit": "B"
},
"total_used_ratio": {"data": 0.5,
"metric": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"unit": "B"
}
}
},
"chassis_serial_number": "string",
"model": "FA-X50R2",
"space": {"capacity": {"data": 123,
"metric": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"unit": "B"
},
"total_used": {"data": 123,
"metric": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"unit": "B"
},
"total_used_ratio": {"data": 0.5,
"metric": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"unit": "B"
}
},
"version": "5.0.0"
},
"customer_name": "Everpure Customer",
"end_of_life_date": 1636588800000,
"install_address": {"city": "Mountain View",
"country": "United States",
"state": "CA",
"street_address": "2555 Augustine Dr, Santa Clara, CA 95054, United States"
},
"license": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"organization": {"name": "Everpure"
},
"subscription": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"upgrade_details": {"action_needed": "Your Ever Modern Upgrade has been booked.",
"commitment_date": 1604702243000,
"upgrade_eligibility_date": 1604702243000
}
}
]
}

Security

Provides information about security posture of Pure Storage appliances.

Get security anomalies

Retrieves security anomalies detected on Pure Storage appliances. Results can be filtered by id, type, and status, and sorted by any of those fields.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"description": "Detects sudden drops in data reduction ratio for a storage object that may indicate encryption, compression changes, or ransomware activity.",
"end_time": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"resources": [{"arrays": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
],
"id": "bucket-id",
"metrics": [{"additional_data": {"value_change_percentage": 0.3661163395
},
"name": "capacity",
"resource_type": "metrics"
}
],
"name": "bucket-name",
"resource_type": "buckets"
}
],
"start_time": 1502729489760,
"status": "open",
"type": "drr"
}
]
}

Get common vulnerabilities and exposures

Retrieves common vulnerabilities and exposures (CVEs) and their details, including description, severity, affected and fixed versions, affected appliances, and link to additional information. Results can be filtered by id, severity, and cvss_score, and sorted by any of those fields.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"affected_resources": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com",
"os": "Purity//FA",
"version": "6.2.0"
}
],
"affected_versions": [{"os": "Purity//FA",
"version": "6.2.0"
}
],
"cvss_score": 7.5,
"description": "An issue was discovered in ksmbd in the Linux kernel 5.15 through 5.19 before 5.19.2. fs/ksmbd/smb2pdu.c has a use-after-free and OOPS for SMB2_TREE_DISCONNECT.",
"detected_at": 1502729489760,
"fixed_in_patches": [{"name": "security-patch-fa-2025-A",
"os": "Purity//FA"
}
],
"fixed_in_versions": [{"os": "Purity//FA",
"version": "6.2.0"
}
],
"kb_article": "https://support.purestorage.com/bundle/z-kb-articles-cve/page/CVE-2022-47939.html",
"severity": "critical",
"updated_at": 1502729489760
}
]
}

Get appliance security insights information.

Retrieves information about FlashArray and FlashBlade insights connected to security assessment.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"additional_data": {"cves": [{"id": "CVE-2021-3545",
"severity": "high"
}
]
},
"resource": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
},
"type": "end_of_life_purity_version_in_use"
}
]
}

Sustainability

Provides information about energy consumption and sustainability.

Get appliance sustainability information.

Retrieves information about FlashArray and FlashBlade size, power consumption, heat generation and its sustainability assessment.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
fqdns	Array of strings A comma-separated list of resource FQDNs. If there is not at least one resource that matches each `fqdn` element, an error is returned. Single quotes are required around all strings.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "example_name",
"assessment": {"_as_of": 1502729489760,
"_interval_end": 1502729489760,
"_interval_start": 1501519889760,
"array_data_reduction": 2.5,
"array_total_load": 0.23,
"assessment_level": "good",
"blades": 15,
"capacity_utilization": 0.68,
"chassis": 1,
"heat_average": 1787.69,
"heat_peak_spec": 2046,
"heat_typical_spec": 1705,
"power_average": 524.25,
"power_peak_spec": 600,
"power_per_usable_capacity": 5.4,
"power_per_used_space": 22.5,
"power_typical_spec": 500,
"rack_units": 4,
"shelves": 1
},
"install_address": {"geolocation": {"latitude": 23.234,
"longitude": 123.9834
},
"street_address": "599 Castro St, Mountain View, CA 94041 United States",
"updated": 1548080949
},
"reporting_status": "assessment_ready"
}
]
}

Get appliance sustainability insights information.

Retrieves information about FlashArray and FlashBlade insights connected to sustainability assessment.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"_interval_end": 1502729489760,
"_interval_start": 1501519889760,
"additional_data": {"required_version": "6.3.0"
},
"resource": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
},
"severity": "medium",
"type": "upgrade_purity_version_for_array_wide"
}
]
}

Targets

Provides information about FlashBlade external replication targets.

Get targets

Retrieves information about targets.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "example_name",
"arrays": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
],
"address": "example_name.dc1.example.com",
"status": "connected",
"status_details": "string"
}
]
}

Volumes

Provides information about block storage volumes on FlashArray arrays.

Get volumes

Retrieves information about FlashArray volume objects.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"arrays": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
],
"created": 1502729489760,
"destroyed": false,
"eradicated": false,
"pod": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"provisioned": 2048576,
"serial": "C68B5DCF2C1A4C9400012F92",
"source": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
}
}
]
}

Volume Snapshots

Provides information about snapshots of block storage volumes on FlashArray arrays.

Get volume snapshots

Retrieves information about snapshots of volumes.

Authorizations:

AuthorizationHeader

query Parameters

continuation_token	string An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings.
filter	string Exclude resources that don't match the specified criteria. Single quotes are required around all strings inside the filters.
ids	Array of strings A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings.
limit	integer <int32> Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client's page size request. If not specified, defaults to 1000.
names	Array of strings A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings[ items^[a-z]+(_[a-z]+)*-? ] Sort the response by the specified fields (in descending order if '-' is appended to the field name). If you provide a sort you will not get a continuation token in the response.
source_ids	Array of strings A comma-separated list of ids for the source of the object. If there is not at least one resource that matches each `source_id` element, an error is returned. Single quotes are required around all strings.
source_names	Array of strings A comma-separated list of names for the source of the object. If there is not at least one resource that matches each `source_name` element, an error is returned. Single quotes are required around all strings.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"continuation_token": "MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My",
"total_item_count": 1,
"items": [{"_as_of": 1502729489760,
"id": "01c2889a-4124-49ff-8cbd-c33405ede123",
"name": "example_name",
"arrays": [{"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
}
],
"created": 1502729489760,
"destroyed": false,
"on": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type",
"fqdn": "example_name.dc1.example.com"
},
"pod": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"provisioned": 2048576,
"serial": "C68B5DCF2C1A4C9400012F92",
"snapshot_group": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"source": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"suffix": "checkpoint_2018_01_01"
}
]
}

Pure1 Public REST API (1.latest)

Authorization

Get access token

header Parameters

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Response samples

Alerts

Get alerts

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Arrays

Get arrays

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Get array support contracts

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Get array tags

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Delete array tags

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Create or update array tags

Authorizations:

query Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Audits

Get audits

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Blades

Get blades

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Buckets

Get buckets

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Bucket Replica Links

Get bucket replica links

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Controllers

Get controllers

Authorizations:

query Parameters

header Parameters

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/json
required