Pure1 Public REST API (1.0)

Download OpenAPI specification:Download

Pure1 Public REST API, developed by Pure Storage, Inc.

The Pure1 REST API 2.0 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

Authentication

AuthorizationHeader

Security Scheme Type	API Key
Header parameter name:	Authorization

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

grant_type required	string (formData_OauthGrantType) Default: "urn:ietf:params:oauth:grant-type:token-exchange" The method by which the access token will be obtained. The Pure Storage 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 (formData_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 (formData_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 Pure Storage 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",
"issued_token_type": "urn:ietf:params:oauth:token-type:access_token",
"token_type": "Bearer",
"expires_in": 35999
}

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 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"
}
],
"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.
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 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",
"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_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 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": [{"start_date": 1550966400000,
"end_date": 1582502400000,
"resource": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
}
}
]
}

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

A list of tags to be upserted.

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 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"
}
],
"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 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",
"used_blades": 10,
"total_blades": 15
}
],
"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 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"
}
],
"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 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",
"status_details": "string",
"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"
}
}
],
"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"
}
}
],
"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"
}
}
]
}
]
}

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 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"
}
],
"mode": "primary",
"model": "FA-m50",
"status": "ready",
"type": "array_controller",
"version": "5.0.0"
}
]
}

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 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,
"total_capacity": 7625244672
}
],
"capacity": 494927872,
"details": "Slow link speed.",
"protocol": "SAS",
"status": "healthy",
"type": "SSD"
}
]
}

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 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"
}
],
"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"
}
]
}

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 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"
}
],
"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.
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.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings 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,
"policy": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"member": {"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 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",
"status_details": "string",
"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"
}
}
],
"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"
}
}
],
"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"
}
}
]
}
]
}

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.
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.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings 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,
"policy": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"member": {"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 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"
}
],
"created": 1502729489760,
"destroyed": false,
"on": {"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"
}
]
}

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.
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.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings 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,
"policy": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"member": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
}
}
]
}

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 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"
}
],
"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 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"
}
],
"connector_type": "QSFP",
"lane_speed": 10000000000,
"port_count": 1,
"transceiver_type": "40GBASE-LR4"
}
]
}

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 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"
}
],
"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 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"
}
],
"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 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"
}
],
"created": 1502729489760,
"object_count": 15
}
]
}

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 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",
"frozen_at": 1502729489760,
"mediator_status": "online",
"status": "resyncing"
}
],
"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 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"
}
]
}
],
"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"
}
]
}
],
"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"
}
]
}
]
}
]
}

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 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"
}
],
"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.
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.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings 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,
"policy": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"member": {"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.
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.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings 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,
"policy": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"member": {"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.
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.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings 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,
"policy": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"member": {"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.
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.
offset	integer <int32> >= 0 The offset of the first resource to return from a collection.
sort	Array of strings 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,
"policy": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"member": {"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 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"
}
],
"iqn": "iqn.2010-06.com.purestorage:flasharray.393d930077be2977",
"nqn": "nqn.2010-06.com.purestorage:flasharray.512f7bb185978505",
"wwn": "52:4A:93:70:4E:E5:68:00",
"portal": "10.16.200.27:3260",
"failover": "CT0.ETH2"
}
]
}

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 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"
}
],
"address": "example_name.dc1.example.com",
"status": "connected",
"status_details": "string"
}
]
}

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 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",
"expiration_date": 1636238104000,
"service": "PaaS (Block Storage Service)",
"start_date": 1604702243000,
"status": "active"
}
]
}

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 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",
"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,
"marketplace_partner": {"name": "pure1",
"reference_id": "string"
},
"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",
"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",
"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"
}
}
]
}

Volumes

Provides information about block storage volumes on FlashArray arrays.

Get volumes

Retrieves information about 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 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"
}
],
"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 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"
}
],
"created": 1502729489760,
"destroyed": false,
"on": {"id": "2a989a09-c851-4d52-9ec6-ab728b1c04db",
"name": "example_name",
"resource_type": "example_resource_type"
},
"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"
}
]
}