FlashArray REST API (2.1)

Download OpenAPI specification:Download

Authorization

Pure Storage uses the OAuth 2.0 Token Exchange authorization grant and JSON Web Tokens (JWTs) to authenticate to the Pure Storage REST API. Before you can exchange the ID Token for an access token, create and enable the API client to generate the key_id, id, and issuer values. These values will be used as JWT claims for the subject_token parameter.

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
}

List available API versions

Returns a list of available API versions. No authentication is required to access this endpoint.

header Parameters

X-Request-ID

string

Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"version": ["1.0",
"1.1",
"1.2",
"1.3",
"1.4",
"1.5",
"1.6",
"1.7",
"1.8",
"1.9",
"1.10",
"1.11",
"1.12",
"1.13",
"1.14",
"1.15",
"1.16",
"1.17",
"2.0"
]
}

POST login (placeholder)

Exchange an API token for a session token.

header Parameters

X-Request-ID	string Supplied by client during request or generated by server.
api-token	string Example: 0f2e2884-9486-c6c2-438c-f50418f2aac3 API token for a user.

Responses

Response samples

Content type

application/json

{"items": [{"username": "pureuser"
}
]
}

POST logout (placeholder)

Invalidate a session token.

header Parameters

X-Request-ID	string Supplied by client during request or generated by server.
x-auth-token	string Example: 3be3d489-55c6-4643-90ac-a476dbc98812 Session token for a user.

Responses

API Clients

An API client represents an identity type. API clients are created on the array. To create an API client, register and then enable it on the array. After the API client has been created, the user name (sub) and identity tokens (kid and aud tokens) that are issued by the API client are used as claims for the JSON Web Token that you create to authenticate into the REST API.

List API clients

Returns a list of API clients.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"id": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
"name": "NightlyStatsAggregationScript",
"max_role": "storage_admin",
"issuer": "https://purestorage.idp.okta.com",
"public_key": "-----BEGIN PUBLIC KEY----- MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArSe6chh1JzME9svOKjU0 eKTm8S23Ok3Vr2bWuPri/YHfLrlnRwWoCt+st0/BebKSJ+fQUWOaLlqpZQKpI8oR gJ9sWmwGibVG8cTuz7XMkskx9bsm/bjIenuB4W+s3g0BCsi9930mfdKgJgFzY69O nLh7d7hAFcmhSJa945PryQZpvJ/U4Ue5F4d+WXgEJ0SoSRaZ6bbeMPhcbMHTzTum 2ZrPBkK5cqPYitaso6BXeAlqNQPw4Kbu4Ugm0CTogrtImkwoonWDDP34XMOq+u7q sNTbJSvDKMTM1RPPrTWCaLiuZkdLVEVesZ9/8+XUMIgBTElwQJDCAQer03MJzqRr 1eCZGgLfDuYqwMG2MFaAX7kgqBwwyqRTd6MxaQxt2nkdfwiXSY71llzEQ23g3T+1 64zjwAL5f+dtu8PkGF7IdU2T8P2Qk9bG9pckwZHWYkBK77BAk5jbmSzsKGZgRb2R 1E+TWDKIaveFhQp251j/C5wkZwMXgjOzN+BOPo+OiLBGUl+jRybWA9f7Vq1MEdf6 SEdLiqYrXcZERkYBMieLXAfdtaztAIb96cUu+OKMSLDk+D0GHkUfm7lEbDK3ew1+ D6z+BnxDyH6oqZzz4lS2kPLBLsc+6pdTGuKLf0S9YuLiqJe659AdwU8+X/3KtwNd FVJSaxdFbWx0nj3hJqFkIO8CAwEAAQ== -----END PUBLIC KEY-----",
"key_id": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
"enabled": true,
"access_token_ttl_in_ms": 15000
}
]
}

Create an API client

Creates an API client. Newly created API clients are disabled by default. Enable an API client through the PATCH method. The names, max_role, issuer, and public_key parameters are required.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

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

Request Body schema: application/json

max_role	string The maximum role allowed for ID Tokens issued by this API client. The bearer of an access token will be authorized to perform actions within the intersection of this `max_role` and the role of the array user specified as the `sub`. Valid values are `array_admin`, `storage_admin`, `ops_admin`, and `readonly`. Users with the `readonly` (Read Only) role can perform operations that convey the state of the array. Read Only users cannot alter the state of the array. Users with the `ops_admin` (Ops Admin) role can perform the same operations as Read Only users plus enable and disable remote assistance sessions. Ops Admin users cannot alter the state of the array. Users with the `storage_admin` (Storage Admin) role can perform the same operations as Read Only users plus storage related operations, such as administering volumes, hosts, and host groups. Storage Admin users cannot perform operations that deal with global and system configurations. Users with the `array_admin` (Array Admin) role can perform the same operations as Storage Admin users plus array-wide changes dealing with global and system configurations. In other words, Array Admin users can perform all operations.
issuer	string The name of the identity provider that will be issuing ID Tokens for this API client. The `iss` claim in the JWT issued must match this string. If not specified, defaults to the API client name.
public_key	string The API client's PEM formatted (Base64 encoded) RSA public key. Include the `-----BEGIN PUBLIC KEY-----` and `-----END PUBLIC KEY-----` lines.
access_token_ttl_in_ms	integer <int64> The TTL (Time To Live) length of time for the exchanged access token. Measured in milliseconds. If not specified, defaults to `86400000`.

Responses

Request samples

Payload

Content type

application/json

{"max_role": "storage_admin",
"issuer": "https://purestorage.idp.okta.com",
"public_key": "-----BEGIN PUBLIC KEY----- MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArSe6chh1JzME9svOKjU0 eKTm8S23Ok3Vr2bWuPri/YHfLrlnRwWoCt+st0/BebKSJ+fQUWOaLlqpZQKpI8oR gJ9sWmwGibVG8cTuz7XMkskx9bsm/bjIenuB4W+s3g0BCsi9930mfdKgJgFzY69O nLh7d7hAFcmhSJa945PryQZpvJ/U4Ue5F4d+WXgEJ0SoSRaZ6bbeMPhcbMHTzTum 2ZrPBkK5cqPYitaso6BXeAlqNQPw4Kbu4Ugm0CTogrtImkwoonWDDP34XMOq+u7q sNTbJSvDKMTM1RPPrTWCaLiuZkdLVEVesZ9/8+XUMIgBTElwQJDCAQer03MJzqRr 1eCZGgLfDuYqwMG2MFaAX7kgqBwwyqRTd6MxaQxt2nkdfwiXSY71llzEQ23g3T+1 64zjwAL5f+dtu8PkGF7IdU2T8P2Qk9bG9pckwZHWYkBK77BAk5jbmSzsKGZgRb2R 1E+TWDKIaveFhQp251j/C5wkZwMXgjOzN+BOPo+OiLBGUl+jRybWA9f7Vq1MEdf6 SEdLiqYrXcZERkYBMieLXAfdtaztAIb96cUu+OKMSLDk+D0GHkUfm7lEbDK3ew1+ D6z+BnxDyH6oqZzz4lS2kPLBLsc+6pdTGuKLf0S9YuLiqJe659AdwU8+X/3KtwNd FVJSaxdFbWx0nj3hJqFkIO8CAwEAAQ== -----END PUBLIC KEY-----",
"access_token_ttl_in_ms": 15000
}

Response samples

Content type

application/json

{"items": [{"id": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
"name": "NightlyStatsAggregationScript",
"max_role": "storage_admin",
"issuer": "https://purestorage.idp.okta.com",
"public_key": "-----BEGIN PUBLIC KEY----- MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArSe6chh1JzME9svOKjU0 eKTm8S23Ok3Vr2bWuPri/YHfLrlnRwWoCt+st0/BebKSJ+fQUWOaLlqpZQKpI8oR gJ9sWmwGibVG8cTuz7XMkskx9bsm/bjIenuB4W+s3g0BCsi9930mfdKgJgFzY69O nLh7d7hAFcmhSJa945PryQZpvJ/U4Ue5F4d+WXgEJ0SoSRaZ6bbeMPhcbMHTzTum 2ZrPBkK5cqPYitaso6BXeAlqNQPw4Kbu4Ugm0CTogrtImkwoonWDDP34XMOq+u7q sNTbJSvDKMTM1RPPrTWCaLiuZkdLVEVesZ9/8+XUMIgBTElwQJDCAQer03MJzqRr 1eCZGgLfDuYqwMG2MFaAX7kgqBwwyqRTd6MxaQxt2nkdfwiXSY71llzEQ23g3T+1 64zjwAL5f+dtu8PkGF7IdU2T8P2Qk9bG9pckwZHWYkBK77BAk5jbmSzsKGZgRb2R 1E+TWDKIaveFhQp251j/C5wkZwMXgjOzN+BOPo+OiLBGUl+jRybWA9f7Vq1MEdf6 SEdLiqYrXcZERkYBMieLXAfdtaztAIb96cUu+OKMSLDk+D0GHkUfm7lEbDK3ew1+ D6z+BnxDyH6oqZzz4lS2kPLBLsc+6pdTGuKLf0S9YuLiqJe659AdwU8+X/3KtwNd FVJSaxdFbWx0nj3hJqFkIO8CAwEAAQ== -----END PUBLIC KEY-----",
"key_id": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
"enabled": true,
"access_token_ttl_in_ms": 15000
}
]
}

Delete an API client

Deletes an API client. The ids or names parameter is required, but they cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

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

Responses

Manage an API client

Enables or disables an API client. The ids or names parameter is required, but they cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

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

Request Body schema: application/json

enabled

boolean

Returns a value of true if the API client is permitted to exchange ID tokens for access tokens. API clients are disabled by default.

Responses

Request samples

Payload

Content type

application/json

{"enabled": true
}

Response samples

Content type

application/json

{"items": [{"id": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
"name": "NightlyStatsAggregationScript",
"max_role": "storage_admin",
"issuer": "https://purestorage.idp.okta.com",
"public_key": "-----BEGIN PUBLIC KEY----- MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArSe6chh1JzME9svOKjU0 eKTm8S23Ok3Vr2bWuPri/YHfLrlnRwWoCt+st0/BebKSJ+fQUWOaLlqpZQKpI8oR gJ9sWmwGibVG8cTuz7XMkskx9bsm/bjIenuB4W+s3g0BCsi9930mfdKgJgFzY69O nLh7d7hAFcmhSJa945PryQZpvJ/U4Ue5F4d+WXgEJ0SoSRaZ6bbeMPhcbMHTzTum 2ZrPBkK5cqPYitaso6BXeAlqNQPw4Kbu4Ugm0CTogrtImkwoonWDDP34XMOq+u7q sNTbJSvDKMTM1RPPrTWCaLiuZkdLVEVesZ9/8+XUMIgBTElwQJDCAQer03MJzqRr 1eCZGgLfDuYqwMG2MFaAX7kgqBwwyqRTd6MxaQxt2nkdfwiXSY71llzEQ23g3T+1 64zjwAL5f+dtu8PkGF7IdU2T8P2Qk9bG9pckwZHWYkBK77BAk5jbmSzsKGZgRb2R 1E+TWDKIaveFhQp251j/C5wkZwMXgjOzN+BOPo+OiLBGUl+jRybWA9f7Vq1MEdf6 SEdLiqYrXcZERkYBMieLXAfdtaztAIb96cUu+OKMSLDk+D0GHkUfm7lEbDK3ew1+ D6z+BnxDyH6oqZzz4lS2kPLBLsc+6pdTGuKLf0S9YuLiqJe659AdwU8+X/3KtwNd FVJSaxdFbWx0nj3hJqFkIO8CAwEAAQ== -----END PUBLIC KEY-----",
"key_id": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
"enabled": true,
"access_token_ttl_in_ms": 15000
}
]
}

Connections

A connection gives hosts access to volumes on the array. The system supports private (host-volume) connections and public (host group-volume) connections. A private connection connects one volume to one host. Private connections are typically used for boot volumes and for stand-alone (non-clustered) host applications. A shared connection connects a designated set of hosts (via a host group) to a designated set of volumes, providing the hosts with a consistent "view" of the volumes. All associated hosts use the same LUN to address a given associated volume. All hosts and volumes associated with a host group are automatically connected to each other by virtue of their associations with the group. Shared connections are useful for cluster applications in which several related hosts require consistent (same LUN) connectivity to a set of storage volumes.

List volume connections

Returns a list of connections between a volume and its hosts and host groups, and the LUNs used by the associated hosts to address these volumes.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
host_group_names	Array of strings Performs the operation on the host group specified. Enter multiple names in comma-separated format. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host group names and volume names; instead, at least one of the objects (e.g., `host_group_names`) must be set to only one name (e.g., `hgroup01`).
host_names	Array of strings Performs the operation on the hosts specified. Enter multiple names in comma-separated format. For example, `host01,host02`. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host names and volume names; instead, at least one of the objects (e.g., `host_names`) must be set to only one name (e.g., `host01`).
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
protocol_endpoint_names	Array of strings Performs the operation on the protocol endpoints specified. Enter multiple names in comma-separated format. For example, `pe01,pe02`. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple protocol endpoint names and host names; instead, at least one of the objects (e.g., `protocol_endpoint_names`) must be set to one name (e.g., `pe01`).
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
volume_names	Array of strings Performs the operation on the volume specified. Enter multiple names in comma-separated format. For example, `vol01,vol02`. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple volume names and host names; instead, at least one of the objects (e.g., `volume_names`) must be set to only one name (e.g., `vol01`).

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"host": {"name": "string"
},
"host_group": {"name": "string"
},
"lun": 7,
"protocol_endpoint": {"id": "string",
"name": "string"
},
"volume": {"id": "string",
"name": "string"
}
}
]
}

Create a connection between a volume and host or host group

Creates a connection between a volume and a host or host group. The volume_names and host_names or host_group_names query parameters are required.

query Parameters

host_group_names	Array of strings Performs the operation on the host group specified. Enter multiple names in comma-separated format. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host group names and volume names; instead, at least one of the objects (e.g., `host_group_names`) must be set to only one name (e.g., `hgroup01`).
host_names	Array of strings Performs the operation on the hosts specified. Enter multiple names in comma-separated format. For example, `host01,host02`. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host names and volume names; instead, at least one of the objects (e.g., `host_names`) must be set to only one name (e.g., `host01`).
volume_names	Array of strings Performs the operation on the volume specified. Enter multiple names in comma-separated format. For example, `vol01,vol02`. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple volume names and host names; instead, at least one of the objects (e.g., `volume_names`) must be set to only one name (e.g., `vol01`).

header Parameters

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

Request Body schema: application/json

lun

integer <int32> [ 1 .. 4095 ]

The logical unit number (LUN) by which the specified hosts are to address the specified volume. If the LUN is not specified, the system automatically assigns a LUN to the connection. To automatically assign a LUN to a private connection, the system starts at LUN 1 and counts up to the maximum LUN 4095, assigning the first available LUN to the connection. For shared connections, the system starts at LUN 254 and counts down to the minimum LUN 1, assigning the first available LUN to the connection. If all LUNs in the [1...254] range are taken, the system starts at LUN 255 and counts up to the maximum LUN 4095, assigning the first available LUN to the connection.

object

A protocol endpoint (also known as a conglomerate volume) which acts as a proxy through which virtual volumes are created and then connected to VMware ESXi hosts or host groups. The protocol endpoint itself does not serve I/Os; instead, its job is to form connections between FlashArray volumes and ESXi hosts and host groups.

Responses

Request samples

Payload

Content type

application/json

{"lun": 7,
"protocol_endpoint": {"id": "string",
"name": "string"
}
}

Response samples

Content type

application/json

{"items": [{"host": {"name": "string"
},
"host_group": {"name": "string"
},
"lun": 7,
"protocol_endpoint": {"id": "string",
"name": "string"
},
"volume": {"id": "string",
"name": "string"
}
}
]
}

Break a connection between a volume and its host or host group

Breaks the connection between a volume and its associated host or host group. The volume_names and host_names or host_group_names query parameters are required.

query Parameters

host_group_names	Array of strings Performs the operation on the host group specified. Enter multiple names in comma-separated format. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host group names and volume names; instead, at least one of the objects (e.g., `host_group_names`) must be set to only one name (e.g., `hgroup01`).
host_names	Array of strings Performs the operation on the hosts specified. Enter multiple names in comma-separated format. For example, `host01,host02`. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host names and volume names; instead, at least one of the objects (e.g., `host_names`) must be set to only one name (e.g., `host01`).
volume_names	Array of strings Performs the operation on the volume specified. Enter multiple names in comma-separated format. For example, `vol01,vol02`. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple volume names and host names; instead, at least one of the objects (e.g., `volume_names`) must be set to only one name (e.g., `vol01`).

header Parameters

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

Responses

Host Groups

Host groups implement consistent connections between a set of hosts and one or more volumes. Connections are consistent in the sense that all hosts associated with a host group address a volume connected to the group by the same LUN. Host groups are typically used to provide a common view of storage volumes to the hosts in a clustered application.

List host groups

Returns a list of host groups.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"name": "string",
"connection_count": 3,
"host_count": 3,
"is_local": true,
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
}
}
]
}

Create a host group

Creates a host group. The names query parameter is required.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

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

Responses

Response samples

Content type

application/json

{"items": [{"name": "string",
"connection_count": 3,
"host_count": 3,
"is_local": true,
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
}
}
]
}

Delete a host group

Deletes a host group. The names query parameter is required.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

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

Responses

Manage a host group

Manages a host group. The names query parameter is required.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

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

Request Body schema: application/json

name	string The new name for the resource.

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"connection_count": 3,
"host_count": 3,
"is_local": true,
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
}
}
]
}

List host groups that are associated with hosts

Returns a list of host groups that are associated with hosts.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"group": {"name": "string"
},
"member": {"name": "string"
}
}
]
}

Add a host to a host group

Adds a host to a host group. Adding a host to a host group automatically connects the host to all volumes associated with the group. Multiple hosts can be belong to a host group, but a host can only belong to one host group. Hosts can be added to host groups at any time. The group_names and member_names parameters are required and must be set together, and only one host group can be specified at a time.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"items": [{"group": {"name": "string"
},
"member": {"name": "string"
}
}
]
}

Remove a host from a host group

Removes a host from a host group. Removing a host from a host group automatically disconnects the host from all volumes associated with the group. Hosts can be removed from host groups at any time. The group_names and member_names parameters are required and must be set together, and only one host group can be specified at a time.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

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

Responses

List host group performance data

Returns real-time and historical performance data, real-time latency data, and average I/O sizes across all volumes, displayed both by host group and as a total across all host groups.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"name": "string",
"bytes_per_mirrored_write": 0,
"bytes_per_op": 0,
"bytes_per_read": 0,
"bytes_per_write": 0,
"mirrored_write_bytes_per_sec": 0,
"mirrored_writes_per_sec": 0,
"qos_rate_limit_usec_per_mirrored_write_op": 0,
"qos_rate_limit_usec_per_read_op": 0,
"qos_rate_limit_usec_per_write_op": 0,
"queue_usec_per_mirrored_write_op": 0,
"queue_usec_per_read_op": 0,
"queue_usec_per_write_op": 0,
"read_bytes_per_sec": 0,
"reads_per_sec": 0,
"san_usec_per_mirrored_write_op": 0,
"san_usec_per_read_op": 0,
"san_usec_per_write_op": 0,
"service_usec_per_mirrored_write_op": 0,
"service_usec_per_read_op": 0,
"service_usec_per_write_op": 0,
"time": 0,
"usec_per_mirrored_write_op": 0,
"usec_per_read_op": 0,
"usec_per_write_op": 0,
"write_bytes_per_sec": 0,
"writes_per_sec": 0
}
],
"total": [{"name": "string",
"bytes_per_mirrored_write": 0,
"bytes_per_op": 0,
"bytes_per_read": 0,
"bytes_per_write": 0,
"mirrored_write_bytes_per_sec": 0,
"mirrored_writes_per_sec": 0,
"qos_rate_limit_usec_per_mirrored_write_op": 0,
"qos_rate_limit_usec_per_read_op": 0,
"qos_rate_limit_usec_per_write_op": 0,
"queue_usec_per_mirrored_write_op": 0,
"queue_usec_per_read_op": 0,
"queue_usec_per_write_op": 0,
"read_bytes_per_sec": 0,
"reads_per_sec": 0,
"san_usec_per_mirrored_write_op": 0,
"san_usec_per_read_op": 0,
"san_usec_per_write_op": 0,
"service_usec_per_mirrored_write_op": 0,
"service_usec_per_read_op": 0,
"service_usec_per_write_op": 0,
"time": 0,
"usec_per_mirrored_write_op": 0,
"usec_per_read_op": 0,
"usec_per_write_op": 0,
"write_bytes_per_sec": 0,
"writes_per_sec": 0
}
]
}

List host group performance data by array

Returns real-time and historical performance data, real-time latency data, and average I/O size data. The data returned is for each volume that is connected to a host group on the current array and for each volume that is connected to a host group on any remote arrays that are visible to the current array. The data is displayed as a total across all host groups on each array and by individual host group.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"name": "string",
"bytes_per_mirrored_write": 0,
"bytes_per_op": 0,
"bytes_per_read": 0,
"bytes_per_write": 0,
"mirrored_write_bytes_per_sec": 0,
"mirrored_writes_per_sec": 0,
"qos_rate_limit_usec_per_mirrored_write_op": 0,
"qos_rate_limit_usec_per_read_op": 0,
"qos_rate_limit_usec_per_write_op": 0,
"queue_usec_per_mirrored_write_op": 0,
"queue_usec_per_read_op": 0,
"queue_usec_per_write_op": 0,
"read_bytes_per_sec": 0,
"reads_per_sec": 0,
"san_usec_per_mirrored_write_op": 0,
"san_usec_per_read_op": 0,
"san_usec_per_write_op": 0,
"service_usec_per_mirrored_write_op": 0,
"service_usec_per_read_op": 0,
"service_usec_per_write_op": 0,
"time": 0,
"usec_per_mirrored_write_op": 0,
"usec_per_read_op": 0,
"usec_per_write_op": 0,
"write_bytes_per_sec": 0,
"writes_per_sec": 0,
"array": {"id": "string",
"name": "string"
}
}
],
"total": [{"name": "string",
"bytes_per_mirrored_write": 0,
"bytes_per_op": 0,
"bytes_per_read": 0,
"bytes_per_write": 0,
"mirrored_write_bytes_per_sec": 0,
"mirrored_writes_per_sec": 0,
"qos_rate_limit_usec_per_mirrored_write_op": 0,
"qos_rate_limit_usec_per_read_op": 0,
"qos_rate_limit_usec_per_write_op": 0,
"queue_usec_per_mirrored_write_op": 0,
"queue_usec_per_read_op": 0,
"queue_usec_per_write_op": 0,
"read_bytes_per_sec": 0,
"reads_per_sec": 0,
"san_usec_per_mirrored_write_op": 0,
"san_usec_per_read_op": 0,
"san_usec_per_write_op": 0,
"service_usec_per_mirrored_write_op": 0,
"service_usec_per_read_op": 0,
"service_usec_per_write_op": 0,
"time": 0,
"usec_per_mirrored_write_op": 0,
"usec_per_read_op": 0,
"usec_per_write_op": 0,
"write_bytes_per_sec": 0,
"writes_per_sec": 0,
"array": {"id": "string",
"name": "string"
}
}
]
}

List host groups that are members of protection groups

Returns a list of host group members that belong to one or more protection groups.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"group": {"name": "string"
},
"member": {"name": "string"
}
}
]
}

Add a host group to a protection group

Adds a host group member to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host group. The group_names and member_names parameters are required and must be set together.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"items": [{"group": {"name": "string"
},
"member": {"name": "string"
}
}
]
}

Remove a host group from a protection group

Removes a host group member from a protection group. After the member has been removed, it is no longer protected by the group. Any protection group snapshots that were taken before the member was removed will not be affected. Removing a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host group. The group_names and member_names parameters are required and must be set together.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

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

Responses

List host group space information

Returns provisioned size and physical storage consumption data for each host group.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"name": "string",
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"time": 0
}
]
}

Hosts

Hosts organize the storage network addresses (iSCSI Qualified Names, NVMe qualified names, or Fibre Channel world wide names) of client computers to identify the host's intiators. Hosts also control communications between clients and volumes. After a volume has been created, establish a host-volume connection so that the host can read data from and write data to the volume.

List hosts

Returns a list of hosts.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"name": "string",
"chap": {"host_password": "string",
"host_user": "string",
"target_password": "string",
"target_user": "string"
},
"connection_count": 3,
"host_group": {"name": "string"
},
"iqns": ["iqn.2010-06.com.purestorage:linux.393d930077be2977"
],
"nqns": ["nqn.2010-06.com.purestorage:flasharray.512f7bb185978505"
],
"personality": "string",
"port_connectivity": {"details": "Redundant",
"status": "healthy"
},
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"preferred_arrays": [{"id": "string",
"name": "string"
}
],
"wwns": ["52:4A:93:70:4E:E5:68:00"
],
"is_local": true
}
]
}

Create a host

Creates a host. The names query parameter is required.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

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

Request Body schema: application/json

	object (_chap) Challenge-Handshake Authentication Protocol (CHAP).
iqns	Array of strings The iSCSI qualified name (IQN) associated with the host.
nqns	Array of strings The NVMe Qualified Name (NQN) associated with the host.
personality	string Determines how the system tunes the array to ensure that it works optimally with the host. Set `personality` to the name of the host operating system or virtual memory system. Valid values are `aix`, `esxi`, `hitachi-vsp`, `hpux`, `oracle-vm-server`, `solaris`, and `vms`. If your system is not listed as one of the valid host personalities, do not set the option. By default, the personality is not set.
	Array of objects (_reference) For synchronous replication configurations, sets a host's preferred array to specify which array exposes active/optimized paths to that host. Enter multiple preferred arrays in comma-separated format. If a preferred array is set for a host, then the other arrays in the same pod will expose active/non-optimized paths to that host. If the host is in a host group, `preferred_arrays` cannot be set because host groups have their own preferred arrays. On a preferred array of a certain host, all the paths on all the ports (for both the primary and secondary controllers) are set up as A/O (active/optimized) paths, while on a non-preferred array, all the paths are A/N (Active/Non-optimized) paths.
wwns	Array of strings The Fibre Channel World Wide Name (WWN) associated with the host.

Responses

Request samples

Payload

Content type

application/json

{"chap": {"host_password": "string",
"host_user": "string",
"target_password": "string",
"target_user": "string"
},
"iqns": ["iqn.2010-06.com.purestorage:linux.393d930077be2977"
],
"nqns": ["nqn.2010-06.com.purestorage:flasharray.512f7bb185978505"
],
"personality": "string",
"preferred_arrays": [{"id": "string",
"name": "string"
}
],
"wwns": ["52:4A:93:70:4E:E5:68:00"
]
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"chap": {"host_password": "string",
"host_user": "string",
"target_password": "string",
"target_user": "string"
},
"connection_count": 3,
"host_group": {"name": "string"
},
"iqns": ["iqn.2010-06.com.purestorage:linux.393d930077be2977"
],
"nqns": ["nqn.2010-06.com.purestorage:flasharray.512f7bb185978505"
],
"personality": "string",
"port_connectivity": {"details": "Redundant",
"status": "healthy"
},
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"preferred_arrays": [{"id": "string",
"name": "string"
}
],
"wwns": ["52:4A:93:70:4E:E5:68:00"
],
"is_local": true
}
]
}

Delete a host

Deletes an existing host. All volumes that are connected to the host, either through private or shared connections, must be disconnected from the host before the host can be deleted. The names query parameter is required.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

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

Responses

Manage a host

Manages an existing host, including its storage network addresses, CHAP, host personality, and preferred arrays, or associate a host to a host group. The names query parameter is required.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

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

Request Body schema: application/json

name	string The new name for the resource.
add_iqns	Array of strings Adds the specified iSCSI Qualified Names (IQNs) to those already associated with the specified host.
add_nqns	Array of strings Adds the specified NVMe Qualified Names (NQNs) to those already associated with the specified host.
add_wwns	Array of strings Adds the specified Fibre Channel World Wide Names (WWNs) to those already associated with the specified host.
	object (_chap) Challenge-Handshake Authentication Protocol (CHAP).
	object The host group to which the host should be associated.
iqns	Array of strings The iSCSI qualified name (IQN) associated with the host.
nqns	Array of strings The NVMe Qualified Name (NQN) associated with the host.
personality	string Determines how the system tunes the array to ensure that it works optimally with the host. Set `personality` to the name of the host operating system or virtual memory system. Valid values are `aix`, `esxi`, `hitachi-vsp`, `hpux`, `oracle-vm-server`, `solaris`, and `vms`. If your system is not listed as one of the valid host personalities, do not set the option. By default, the personality is not set.
	Array of objects (_reference) For synchronous replication configurations, sets a host's preferred array to specify which array exposes active/optimized paths to that host. Enter multiple preferred arrays in comma-separated format. If a preferred array is set for a host, then the other arrays in the same pod will expose active/non-optimized paths to that host. If the host is in a host group, `preferred_arrays` cannot be set because host groups have their own preferred arrays. On a preferred array of a certain host, all the paths on all the ports (for both the primary and secondary controllers) are set up as A/O (active/optimized) paths, while on a non-preferred array, all the paths are A/N (Active/Non-optimized) paths.
remove_iqns	Array of strings Disassociates the specified iSCSI Qualified Names (IQNs) from the specified host.
remove_nqns	Array of strings Disassociates the specified NVMe Qualified Names (NQNs) from the specified host.
remove_wwns	Array of strings Disassociates the specified Fibre Channel World Wide Names (WWNs) from the specified host.
wwns	Array of strings The Fibre Channel World Wide Name (WWN) associated with the host.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"add_iqns": ["iqn.2010-06.com.purestorage:linux.393d930077be2977"
],
"add_nqns": ["nqn.2010-06.com.purestorage:flasharray.512f7bb185978505"
],
"add_wwns": ["52:4A:93:70:4E:E5:68:00"
],
"chap": {"host_password": "string",
"host_user": "string",
"target_password": "string",
"target_user": "string"
},
"host_group": {"name": "string"
},
"iqns": ["iqn.2010-06.com.purestorage:linux.393d930077be2977"
],
"nqns": ["nqn.2010-06.com.purestorage:flasharray.512f7bb185978505"
],
"personality": "string",
"preferred_arrays": [{"id": "string",
"name": "string"
}
],
"remove_iqns": ["iqn.2010-06.com.purestorage:linux.393d930077be2977"
],
"remove_nqns": ["nqn.2010-06.com.purestorage:flasharray.512f7bb185978505"
],
"remove_wwns": ["52:4A:93:70:4E:E5:68:00"
],
"wwns": ["52:4A:93:70:4E:E5:68:00"
]
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"chap": {"host_password": "string",
"host_user": "string",
"target_password": "string",
"target_user": "string"
},
"connection_count": 3,
"host_group": {"name": "string"
},
"iqns": ["iqn.2010-06.com.purestorage:linux.393d930077be2977"
],
"nqns": ["nqn.2010-06.com.purestorage:flasharray.512f7bb185978505"
],
"personality": "string",
"port_connectivity": {"details": "Redundant",
"status": "healthy"
},
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"preferred_arrays": [{"id": "string",
"name": "string"
}
],
"wwns": ["52:4A:93:70:4E:E5:68:00"
],
"is_local": true
}
]
}

List hosts that are associated with host groups

Returns a list of hosts that are associated with host groups.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"group": {"name": "string"
},
"member": {"name": "string"
}
}
]
}

Add a host to a host group

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"items": [{"group": {"name": "string"
},
"member": {"name": "string"
}
}
]
}

Remove a host from a host group

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

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

Responses

List host performance data

Returns real-time and historical performance data, real-time latency data, and average I/O sizes across all volumes, displayed both by host and as a total across all hosts.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"name": "string",
"bytes_per_mirrored_write": 0,
"bytes_per_op": 0,
"bytes_per_read": 0,
"bytes_per_write": 0,
"mirrored_write_bytes_per_sec": 0,
"mirrored_writes_per_sec": 0,
"qos_rate_limit_usec_per_mirrored_write_op": 0,
"qos_rate_limit_usec_per_read_op": 0,
"qos_rate_limit_usec_per_write_op": 0,
"queue_usec_per_mirrored_write_op": 0,
"queue_usec_per_read_op": 0,
"queue_usec_per_write_op": 0,
"read_bytes_per_sec": 0,
"reads_per_sec": 0,
"san_usec_per_mirrored_write_op": 0,
"san_usec_per_read_op": 0,
"san_usec_per_write_op": 0,
"service_usec_per_mirrored_write_op": 0,
"service_usec_per_read_op": 0,
"service_usec_per_write_op": 0,
"time": 0,
"usec_per_mirrored_write_op": 0,
"usec_per_read_op": 0,
"usec_per_write_op": 0,
"write_bytes_per_sec": 0,
"writes_per_sec": 0
}
],
"total": [{"name": "string",
"bytes_per_mirrored_write": 0,
"bytes_per_op": 0,
"bytes_per_read": 0,
"bytes_per_write": 0,
"mirrored_write_bytes_per_sec": 0,
"mirrored_writes_per_sec": 0,
"qos_rate_limit_usec_per_mirrored_write_op": 0,
"qos_rate_limit_usec_per_read_op": 0,
"qos_rate_limit_usec_per_write_op": 0,
"queue_usec_per_mirrored_write_op": 0,
"queue_usec_per_read_op": 0,
"queue_usec_per_write_op": 0,
"read_bytes_per_sec": 0,
"reads_per_sec": 0,
"san_usec_per_mirrored_write_op": 0,
"san_usec_per_read_op": 0,
"san_usec_per_write_op": 0,
"service_usec_per_mirrored_write_op": 0,
"service_usec_per_read_op": 0,
"service_usec_per_write_op": 0,
"time": 0,
"usec_per_mirrored_write_op": 0,
"usec_per_read_op": 0,
"usec_per_write_op": 0,
"write_bytes_per_sec": 0,
"writes_per_sec": 0
}
]
}

List host performance data by array

Returns real-time and historical performance data, real-time latency data, and average I/O size data. The data returned is for each volume that is connected to a host on the current array and for each volume that is connected to a host on any remote arrays that are visible to the current array. The data is displayed as a total across all hosts on each array and by individual host.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"name": "string",
"bytes_per_mirrored_write": 0,
"bytes_per_op": 0,
"bytes_per_read": 0,
"bytes_per_write": 0,
"mirrored_write_bytes_per_sec": 0,
"mirrored_writes_per_sec": 0,
"qos_rate_limit_usec_per_mirrored_write_op": 0,
"qos_rate_limit_usec_per_read_op": 0,
"qos_rate_limit_usec_per_write_op": 0,
"queue_usec_per_mirrored_write_op": 0,
"queue_usec_per_read_op": 0,
"queue_usec_per_write_op": 0,
"read_bytes_per_sec": 0,
"reads_per_sec": 0,
"san_usec_per_mirrored_write_op": 0,
"san_usec_per_read_op": 0,
"san_usec_per_write_op": 0,
"service_usec_per_mirrored_write_op": 0,
"service_usec_per_read_op": 0,
"service_usec_per_write_op": 0,
"time": 0,
"usec_per_mirrored_write_op": 0,
"usec_per_read_op": 0,
"usec_per_write_op": 0,
"write_bytes_per_sec": 0,
"writes_per_sec": 0,
"array": {"id": "string",
"name": "string"
}
}
],
"total": [{"name": "string",
"bytes_per_mirrored_write": 0,
"bytes_per_op": 0,
"bytes_per_read": 0,
"bytes_per_write": 0,
"mirrored_write_bytes_per_sec": 0,
"mirrored_writes_per_sec": 0,
"qos_rate_limit_usec_per_mirrored_write_op": 0,
"qos_rate_limit_usec_per_read_op": 0,
"qos_rate_limit_usec_per_write_op": 0,
"queue_usec_per_mirrored_write_op": 0,
"queue_usec_per_read_op": 0,
"queue_usec_per_write_op": 0,
"read_bytes_per_sec": 0,
"reads_per_sec": 0,
"san_usec_per_mirrored_write_op": 0,
"san_usec_per_read_op": 0,
"san_usec_per_write_op": 0,
"service_usec_per_mirrored_write_op": 0,
"service_usec_per_read_op": 0,
"service_usec_per_write_op": 0,
"time": 0,
"usec_per_mirrored_write_op": 0,
"usec_per_read_op": 0,
"usec_per_write_op": 0,
"write_bytes_per_sec": 0,
"writes_per_sec": 0,
"array": {"id": "string",
"name": "string"
}
}
]
}

List hosts that are members of protection groups

Returns a list of host members that belong to one or more protection groups.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"group": {"name": "string"
},
"member": {"name": "string"
}
}
]
}

Add a host to a protection group

Adds a host member to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host. The group_names and member_names parameters are required and must be set together.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"items": [{"group": {"name": "string"
},
"member": {"name": "string"
}
}
]
}

Remove a host from a protection group

Removes a host member from a protection group. After the member has been removed, it is no longer protected by the group. Any protection group snapshots that were taken before the member was removed will not be affected. Removing a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host. The group_names and member_names parameters are required and must be set together.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

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

Responses

List host space information

Returns provisioned size and physical storage consumption data for each host.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"name": "string",
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"time": 0
}
]
}

Offloads

The offload feature enables system administrators to replicate point-in-time volume snapshots from the array to an external storage system for long-term retention. Each offload target represents an external storage system, such as an Azure Blob container, NFS device, or S3 bucket, to where Purity//FA volume snapshots can be replicated.

List offload targets

Returns a list of offload targets that are connected to the array.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
protocol	string Protocol type. Valid values are `nfs`, `s3`, and `azure`.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"nfs": {"address": "string",
"mount_options": "string",
"mount_point": "string"
},
"s3": {"access_key_id": "string",
"bucket": "string",
"placement_strategy": "string",
"secret_access_key": "string",
"uri": "string"
},
"azure": {"container_name": "string",
"account_name": "string",
"secret_access_key": "string"
},
"name": "string",
"protocol": "string",
"target_id": "string",
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"status": "string"
}
],
"total": [{"nfs": {"address": "string",
"mount_options": "string",
"mount_point": "string"
},
"s3": {"access_key_id": "string",
"bucket": "string",
"placement_strategy": "string",
"secret_access_key": "string",
"uri": "string"
},
"azure": {"container_name": "string",
"account_name": "string",
"secret_access_key": "string"
},
"name": "string",
"protocol": "string",
"target_id": "string",
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"status": "string"
}
]
}

Connect to an offload target

Connects the array to an offload target. Before you can connect to, manage, and replicate to an offload target, the respective Purity//FA app must be installed. For more information about Purity//FA apps, refer to the Apps section of this guide.

query Parameters

initialize	boolean If set to `true`, initializes the Amazon S3 or Azure Blob container in preparation for offloading. The parameter must be set to `true` if this is the first time the array is connecting to the offload target.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

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

Request Body schema: application/json

	object The NFS storage settings. Deprecated from version 6.6.0 onwards - Contact support for additional information.
	object The Amazon S3 storage settings.
	object The Microsoft Azure Blob storage settings.

Responses

Request samples

Payload

Content type

application/json

{"nfs": {"address": "string",
"mount_options": "string",
"mount_point": "string"
},
"s3": {"access_key_id": "string",
"bucket": "string",
"placement_strategy": "string",
"secret_access_key": "string",
"uri": "string"
},
"azure": {"container_name": "string",
"account_name": "string",
"secret_access_key": "string"
}
}

Response samples

Content type

application/json

{"items": [{"nfs": {"address": "string",
"mount_options": "string",
"mount_point": "string"
},
"s3": {"access_key_id": "string",
"bucket": "string",
"placement_strategy": "string",
"secret_access_key": "string",
"uri": "string"
},
"azure": {"container_name": "string",
"account_name": "string",
"secret_access_key": "string"
},
"name": "string",
"protocol": "string",
"target_id": "string",
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"status": "string"
}
]
}

Disconnect from an offload target

Disconnects the array from an offload target.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

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

Responses

Pods

Synchronous replication is managed through pods. A pod representing a collection of protection groups and volumes is created on one array and stretched to another array, resulting in fully synchronized writes between the two arrays. A pod can contain a mix of volumes, and protection groups with member volumes. Writes to the pod coming into either array are immediately synchronized and seen on both arrays.

List pods

Returns a list of pods that are stretched to this array.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"id": "string",
"name": "string",
"arrays": [{"id": "string",
"name": "string",
"frozen_at": 1492662000,
"mediator_status": "string",
"pre_elected": true,
"progress": 0.66,
"status": "resyncing"
}
],
"destroyed": true,
"failover_preferences": [{"id": "string",
"name": "string"
}
],
"footprint": 0,
"mediator": "https://mediator.cloud-support.purestorage.com",
"mediator_version": "1.0.0",
"source": {"id": "string",
"name": "string"
},
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"time_remaining": 0
}
],
"total": [{"id": "string",
"name": "string",
"arrays": [{"id": "string",
"name": "string",
"frozen_at": 1492662000,
"mediator_status": "string",
"pre_elected": true,
"progress": 0.66,
"status": "resyncing"
}
],
"destroyed": true,
"failover_preferences": [{"id": "string",
"name": "string"
}
],
"footprint": 0,
"mediator": "https://mediator.cloud-support.purestorage.com",
"mediator_version": "1.0.0",
"source": {"id": "string",
"name": "string"
},
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"time_remaining": 0
}
]
}

Create a pod

Creates a pod on the local array. Each pod must be given a name that is unique across the arrays to which they are stretched, so a pod cannot be stretched to an array that already contains a pod with the same name. After a pod has been created, add volumes and protection groups to the pod, and then stretch the pod to another (connected) array.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

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

Request Body schema: application/json

object

The source pod from where data is cloned to create the new pod.

Array of objects (_reference)

Determines which array within a stretched pod should be given priority to stay online should the arrays ever lose contact with each other. The current array and any peer arrays that are connected to the current array for synchronous replication can be added to a pod for failover preference. By default, failover_preferences=null, meaning no arrays have been configured for failover preference. Enter multiple arrays in comma-separated format. To clear the list of failover preferences, set to an empty list [].

Responses

Request samples

Payload

Content type

application/json

{"source": {"id": "string",
"name": "string"
},
"failover_preferences": [{"id": "string",
"name": "string"
}
]
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"arrays": [{"id": "string",
"name": "string",
"frozen_at": 1492662000,
"mediator_status": "string",
"pre_elected": true,
"progress": 0.66,
"status": "resyncing"
}
],
"destroyed": true,
"failover_preferences": [{"id": "string",
"name": "string"
}
],
"footprint": 0,
"mediator": "https://mediator.cloud-support.purestorage.com",
"mediator_version": "1.0.0",
"source": {"id": "string",
"name": "string"
},
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"time_remaining": 0
}
]
}

Eradicate a pod

Eradicates a pod that has been destroyed and is pending eradication. Eradicated pods cannot be recovered. Pods are destroyed through the PATCH method. The ids or names parameter is required, but they cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

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

Responses

Manage a pod

Manages the details of a pod.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

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

Request Body schema: application/json

name	string A user-specified name. The name must be locally unique and can be changed.
destroyed	boolean If set to `true`, the pod has been destroyed and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed pod is permanently eradicated. A pod can only be destroyed if it is empty, so before destroying a pod, ensure all volumes and protection groups inside the pod have been either moved out of the pod or destroyed. A stretched pod cannot be destroyed unless you unstretch it first. Before the `time_remaining` period has elapsed, the destroyed pod can be recovered by setting `destroyed=false`. Once the `time_remaining` period has elapsed, the pod is permanently eradicated and can no longer be recovered.
	Array of objects (_reference) Determines which array within a stretched pod should be given priority to stay online should the arrays ever lose contact with each other. The current array and any peer arrays that are connected to the current array for synchronous replication can be added to a pod for failover preference. By default, `failover_preferences=null`, meaning no arrays have been configured for failover preference. Enter multiple arrays in comma-separated format.
mediator	string Sets the URL of the mediator for this pod, replacing the URL of the current mediator. By default, the Pure1 Cloud Mediator (`purestorage`) serves as the mediator.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"destroyed": true,
"failover_preferences": [{"id": "string",
"name": "string"
}
],
"mediator": "https://mediator.cloud-support.purestorage.com"
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"arrays": [{"id": "string",
"name": "string",
"frozen_at": 1492662000,
"mediator_status": "string",
"pre_elected": true,
"progress": 0.66,
"status": "resyncing"
}
],
"destroyed": true,
"failover_preferences": [{"id": "string",
"name": "string"
}
],
"footprint": 0,
"mediator": "https://mediator.cloud-support.purestorage.com",
"mediator_version": "1.0.0",
"source": {"id": "string",
"name": "string"
},
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"time_remaining": 0
}
]
}

List pods and their the array members

Returns a list of pods and the local and remote arrays over which the pods are stretched. The optional group_names parameter represents the name of the pod. The optional member_names parameter represents the name of the array over which the pod is stretched.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
group_ids	Array of strings A comma-separated list of group IDs.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` or `member_names` parameter is required, but they cannot be set together.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"group": {"id": "string",
"name": "string"
},
"member": {"id": "string",
"name": "string"
}
}
]
}

Stretch a pod to an array

Stretches a pod to an array. When a pod is stretched to an array, the data in the arrays over which the pod is stretched is synchronously replicated. The group_names parameter represents the name of the pod to be stretched. The member_names parameter represents the name of the array over which the pod is to be stretched. The group_names and member_names parameters are required and must be set together.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
group_ids	Array of strings A comma-separated list of group IDs.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` or `member_names` parameter is required, but they cannot be set together.

header Parameters

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

Responses

Response samples

Content type

application/json

{"items": [{"group": {"id": "string",
"name": "string"
},
"member": {"id": "string",
"name": "string"
}
}
]
}

Unstretch a pod from an array

Unstretches a pod from an array, collapsing the pod to a single array. Unstretch a pod from an array when the volumes within the stretched pod no longer need to be synchronously replicated between the two arrays. After a pod has been unstretched, synchronous replication stops. A destroyed version of the pod with "restretch" appended to the pod name is created on the array that no longer has the pod. The restretch pod represents a point-in-time snapshot of the pod, just before it was unstretched. The restretch pod enters an eradication pending period starting from the time that the pod was unstretched. A restretch can pod can be cloned or destroyed, but it cannot be explicitly recovered. The group_names parameter represents the name of the pod to be unstretched. The member_names parameter represents the name of the array from which the pod is to be unstretched. The group_names and member_names parameters are required and must be set together.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
group_ids	Array of strings A comma-separated list of group IDs.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` or `member_names` parameter is required, but they cannot be set together.
with_unknown	boolean If set to `true`, unstretches the specified pod from the specified array by force. Use the `with_unknown` parameter in the following rare event: the local array goes offline while the pod is still stretched across two arrays, the status of the remote array becomes unknown, and there is no guarantee that the pod is online elsewhere.

header Parameters

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

Responses

List pod performance data

Returns real-time and historical performance data, real-time latency data, and average I/O sizes across all pods, displayed both by pod and as a total across all pods.

query Parameters

destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"id": "string",
"name": "string",
"bytes_per_mirrored_write": 0,
"bytes_per_op": 0,
"bytes_per_read": 0,
"bytes_per_write": 0,
"mirrored_write_bytes_per_sec": 0,
"mirrored_writes_per_sec": 0,
"qos_rate_limit_usec_per_mirrored_write_op": 0,
"qos_rate_limit_usec_per_read_op": 0,
"qos_rate_limit_usec_per_write_op": 0,
"queue_usec_per_mirrored_write_op": 0,
"queue_usec_per_read_op": 0,
"queue_usec_per_write_op": 0,
"read_bytes_per_sec": 0,
"reads_per_sec": 0,
"san_usec_per_mirrored_write_op": 0,
"san_usec_per_read_op": 0,
"san_usec_per_write_op": 0,
"service_usec_per_mirrored_write_op": 0,
"service_usec_per_read_op": 0,
"service_usec_per_write_op": 0,
"time": 0,
"usec_per_mirrored_write_op": 0,
"usec_per_read_op": 0,
"usec_per_write_op": 0,
"write_bytes_per_sec": 0,
"writes_per_sec": 0
}
],
"total": [{"id": "string",
"name": "string",
"bytes_per_mirrored_write": 0,
"bytes_per_op": 0,
"bytes_per_read": 0,
"bytes_per_write": 0,
"mirrored_write_bytes_per_sec": 0,
"mirrored_writes_per_sec": 0,
"qos_rate_limit_usec_per_mirrored_write_op": 0,
"qos_rate_limit_usec_per_read_op": 0,
"qos_rate_limit_usec_per_write_op": 0,
"queue_usec_per_mirrored_write_op": 0,
"queue_usec_per_read_op": 0,
"queue_usec_per_write_op": 0,
"read_bytes_per_sec": 0,
"reads_per_sec": 0,
"san_usec_per_mirrored_write_op": 0,
"san_usec_per_read_op": 0,
"san_usec_per_write_op": 0,
"service_usec_per_mirrored_write_op": 0,
"service_usec_per_read_op": 0,
"service_usec_per_write_op": 0,
"time": 0,
"usec_per_mirrored_write_op": 0,
"usec_per_read_op": 0,
"usec_per_write_op": 0,
"write_bytes_per_sec": 0,
"writes_per_sec": 0
}
]
}

List pod performance data by array

Returns real-time and historical performance data, real-time latency data, and average I/O size data. The data is displayed as a total across all pods on the local array and by individual pod.

query Parameters

destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"id": "string",
"name": "string",
"bytes_per_mirrored_write": 0,
"bytes_per_op": 0,
"bytes_per_read": 0,
"bytes_per_write": 0,
"mirrored_write_bytes_per_sec": 0,
"mirrored_writes_per_sec": 0,
"qos_rate_limit_usec_per_mirrored_write_op": 0,
"qos_rate_limit_usec_per_read_op": 0,
"qos_rate_limit_usec_per_write_op": 0,
"queue_usec_per_mirrored_write_op": 0,
"queue_usec_per_read_op": 0,
"queue_usec_per_write_op": 0,
"read_bytes_per_sec": 0,
"reads_per_sec": 0,
"san_usec_per_mirrored_write_op": 0,
"san_usec_per_read_op": 0,
"san_usec_per_write_op": 0,
"service_usec_per_mirrored_write_op": 0,
"service_usec_per_read_op": 0,
"service_usec_per_write_op": 0,
"time": 0,
"usec_per_mirrored_write_op": 0,
"usec_per_read_op": 0,
"usec_per_write_op": 0,
"write_bytes_per_sec": 0,
"writes_per_sec": 0,
"array": {"id": "string",
"name": "string"
}
}
],
"total": [{"id": "string",
"name": "string",
"bytes_per_mirrored_write": 0,
"bytes_per_op": 0,
"bytes_per_read": 0,
"bytes_per_write": 0,
"mirrored_write_bytes_per_sec": 0,
"mirrored_writes_per_sec": 0,
"qos_rate_limit_usec_per_mirrored_write_op": 0,
"qos_rate_limit_usec_per_read_op": 0,
"qos_rate_limit_usec_per_write_op": 0,
"queue_usec_per_mirrored_write_op": 0,
"queue_usec_per_read_op": 0,
"queue_usec_per_write_op": 0,
"read_bytes_per_sec": 0,
"reads_per_sec": 0,
"san_usec_per_mirrored_write_op": 0,
"san_usec_per_read_op": 0,
"san_usec_per_write_op": 0,
"service_usec_per_mirrored_write_op": 0,
"service_usec_per_read_op": 0,
"service_usec_per_write_op": 0,
"time": 0,
"usec_per_mirrored_write_op": 0,
"usec_per_read_op": 0,
"usec_per_write_op": 0,
"write_bytes_per_sec": 0,
"writes_per_sec": 0,
"array": {"id": "string",
"name": "string"
}
}
]
}

List pod space information

Returns provisioned size and physical storage consumption data for each pod on the local array.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"id": "string",
"name": "string",
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"time": 0
}
],
"total": [{"id": "string",
"name": "string",
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"time": 0
}
]
}

Protection Groups

A protection group defines a set of volumes, hosts, or host groups (called members) that are protected together through snapshots with point-in-time consistency across the member volumes. The members within the protection group have common data protection requirements and the same snapshot, replication, and retention schedules. Protection group members include volumes, hosts, and host groups. After a protection group has been created, configure the protection group schedule to generate and replicate snapshots to another array or to an external storage system.

List protection groups

Returns a list of protection groups, including their associated source arrays, replication targets, hosts, host groups, and volumes. The list includes protection groups that were created on the local array to replicate snapshot data to other arrays or offload targets, created on a remote array and replicated asynchronously to this array, or created inside a pod on a remote array and stretched to the local array.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"name": "string",
"destroyed": true,
"host_count": 3,
"host_group_count": 3,
"is_local": true,
"pod": {"id": "string",
"name": "string"
},
"replication_schedule": {"at": 7200,
"enabled": false,
"frequency": 259200000,
"blackout": {"start": 3600000,
"end": 46800000
}
},
"snapshot_schedule": {"at": 7200,
"enabled": false,
"frequency": 259200000
},
"source": {"id": "string",
"name": "string"
},
"source_retention": {"all_for_sec": 86400,
"days": 7,
"per_day": 3
},
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"target_retention": {"all_for_sec": 86400,
"days": 7,
"per_day": 3
},
"target_count": 3,
"time_remaining": 0,
"volume_count": 3
}
],
"total": [{"name": "string",
"destroyed": true,
"host_count": 3,
"host_group_count": 3,
"is_local": true,
"pod": {"id": "string",
"name": "string"
},
"replication_schedule": {"at": 7200,
"enabled": false,
"frequency": 259200000,
"blackout": {"start": 3600000,
"end": 46800000
}
},
"snapshot_schedule": {"at": 7200,
"enabled": false,
"frequency": 259200000
},
"source": {"id": "string",
"name": "string"
},
"source_retention": {"all_for_sec": 86400,
"days": 7,
"per_day": 3
},
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"target_retention": {"all_for_sec": 86400,
"days": 7,
"per_day": 3
},
"target_count": 3,
"time_remaining": 0,
"volume_count": 3
}
]
}

Create a protection group

Creates a protection group on the local array for asynchronous replication.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
source_names	Array of strings The name of the protection group or protection group snapshot to be copied into a new or existing protection group. If the destination protection group and all of its volumes already exist, include the `overwrite` parameter to overwrite all of the existing volumes with the snapshot contents. If including the `overwrite` parameter, the names of the volumes that are being overwritten must match the names of the volumes that are being restored. If the source is a protection group, the latest snapshot of the protection group will be used as the source during the copy operation.
overwrite	boolean If set to `true`, overwrites an existing object during an object copy operation. If set to `false` or not set at all and the target name is an existing object, the copy operation fails. Required if the `source` body parameter is set and the source overwrites an existing object during the copy operation.

header Parameters

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

Responses

Response samples

Content type

application/json

{"items": [{"name": "string",
"destroyed": true,
"host_count": 3,
"host_group_count": 3,
"is_local": true,
"pod": {"id": "string",
"name": "string"
},
"replication_schedule": {"at": 7200,
"enabled": false,
"frequency": 259200000,
"blackout": {"start": 3600000,
"end": 46800000
}
},
"snapshot_schedule": {"at": 7200,
"enabled": false,
"frequency": 259200000
},
"source": {"id": "string",
"name": "string"
},
"source_retention": {"all_for_sec": 86400,
"days": 7,
"per_day": 3
},
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"target_retention": {"all_for_sec": 86400,
"days": 7,
"per_day": 3
},
"target_count": 3,
"time_remaining": 0,
"volume_count": 3
}
]
}

Eradicate a protection group

Eradicates a protection group that has been destroyed and is pending eradication. Eradicated protection groups cannot be recovered. Protection groups are destroyed through the PATCH method. Theids or names parameter is required, but they cannot be set together.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

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

Responses

Manage a protection group

Configures the protection group schedules to generate and replicate snapshots to another array or to an external storage system. Also renames or destroys a protection group.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

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

Request Body schema: application/json

name	string A user-specified name. The name must be locally unique and can be changed.
destroyed	boolean Has this protection group been destroyed? To destroy a protection group, patch to `true`. To recover a destroyed protection group, patch to `false`. If not specified, defaults to `false`.
	object The pod in which the protection group resides.
	object The schedule settings for asynchronous replication.
	object The schedule settings for protection group snapshots.
	object The array or pod on which the protection group was created.
	object The retention policy for the source array of the protection group.
	object Returns provisioned size and physical storage consumption data for each protection group.
	object The retention policy for the target(s) of the protection group.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"destroyed": true,
"pod": { },
"replication_schedule": {"at": 7200,
"enabled": false,
"frequency": 259200000,
"blackout": {"start": 3600000,
"end": 46800000
}
},
"snapshot_schedule": {"at": 7200,
"enabled": false,
"frequency": 259200000
},
"source": { },
"source_retention": {"all_for_sec": 86400,
"days": 7,
"per_day": 3
},
"space": { },
"target_retention": {"all_for_sec": 86400,
"days": 7,
"per_day": 3
}
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"destroyed": true,
"host_count": 3,
"host_group_count": 3,
"is_local": true,
"pod": {"id": "string",
"name": "string"
},
"replication_schedule": {"at": 7200,
"enabled": false,
"frequency": 259200000,
"blackout": {"start": 3600000,
"end": 46800000
}
},
"snapshot_schedule": {"at": 7200,
"enabled": false,
"frequency": 259200000
},
"source": {"id": "string",
"name": "string"
},
"source_retention": {"all_for_sec": 86400,
"days": 7,
"per_day": 3
},
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"target_retention": {"all_for_sec": 86400,
"days": 7,
"per_day": 3
},
"target_count": 3,
"time_remaining": 0,
"volume_count": 3
}
]
}

List protection groups with host members

Returns a list of protection groups that have host members.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"group": {"name": "string"
},
"member": {"name": "string"
}
}
]
}

Add a host to a protection group

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"items": [{"group": {"name": "string"
},
"member": {"name": "string"
}
}
]
}

Remove a host from a protection group

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

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

Responses

List protection groups with host group members

Returns a list of protection groups that have host group members.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"group": {"name": "string"
},
"member": {"name": "string"
}
}
]
}

Add a host group to a protection group

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"items": [{"group": {"name": "string"
},
"member": {"name": "string"
}
}
]
}

Remove a host group from a protection group

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

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

Responses

List protection group replication performance data

Returns the total number of bytes of replication data transmitted and received per second. The data is grouped by protection group.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"name": "string",
"bytes_per_sec": 0,
"time": 0
}
]
}

List protection group replication performance data with array details

Returns the total number of bytes of replication data transmitted and received per second. The data is grouped by protection group and includes the names of the source array and targets for each protection group.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"name": "string",
"bytes_per_sec": 0,
"source": "string",
"target": "string",
"time": 0
}
]
}

List protection group space information

Returns provisioned size and physical storage consumption data for each protection group.

query Parameters

destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"name": "string",
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"time": 0
}
]
}

List protection groups with targets

Returns a list of protection groups that have target arrays or offload targets.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"group": {"name": "string"
},
"member": {"name": "string"
},
"allowed": true
}
]
}

Add a target to a protection group

Adds an array or offload target to a protection group. The group_names parameter represents the name of the protection group. The member_names parameter represents the name of the array or offload target that is being added to the protection group. The group_names and member_names parameters are required and must be set together.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"items": [{"group": {"name": "string"
},
"member": {"name": "string"
},
"allowed": true
}
]
}

Removes a target from a protection group

Removes an array or offload target from a protection group. The group_names parameter represents the name of the protection group. The member_names parameter represents the name of the array or offload target that is being removed from the protection group. The group_names and member_names parameters are required and must be set together.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

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

Responses

Manage a protection group target

Allows the source array to replicate protection group data to the target array, or disallows the source array from replicating protection group data to the target array. The allowed parameter must be set from the target array. The group_names parameter represents the name of the protection group. The allowed and group_names parameters are required and must be set together. Offload targets do not support the allowed parameter.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

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

Request Body schema: application/json

	object (_fixedReferenceNoId)
	object (_fixedReferenceNoId)
allowed	boolean If set to `true`, the target array has allowed the source array to replicate protection group data to the target array. If set to `false`, the target array has not allowed the source array to replicate protection group data to the target. target-protection-group

Responses

Request samples

Payload

Content type

application/json

{"protection_group": { },
"target": { },
"allowed": true
}

Response samples

Content type

application/json

{"items": [{"group": {"name": "string"
},
"member": {"name": "string"
},
"allowed": true
}
]
}

List protection groups with volume members

Returns a list of protection groups that have volume members.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"group": {"name": "string"
},
"member": {"name": "string"
}
}
]
}

Add a volume to a protection group

Adds a volume member to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the volume. The group_names and member_names parameters are required and must be set together.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"items": [{"group": {"name": "string"
},
"member": {"name": "string"
}
}
]
}

Remove a volume from a protection group

Removes a volume member from a protection group. After the member has been removed, it is no longer protected by the group. Any protection group snapshots that were taken before the member was removed will not be affected. Removing a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the volume. The group_names and member_names parameters are required and must be set together.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

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

Responses

Protection Group Snapshots

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

List protection group snapshots

Returns a list of protection group snapshots, including those pending eradication.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
source_names	Array of strings Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, `name01,name02`.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"name": "string",
"created": 1503520993,
"destroyed": true,
"pod": {"id": "string",
"name": "string"
},
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"source": {"id": "string",
"name": "string"
},
"suffix": "string",
"time_remaining": 0
}
],
"total": [{"name": "string",
"created": 1503520993,
"destroyed": true,
"pod": {"id": "string",
"name": "string"
},
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"source": {"id": "string",
"name": "string"
},
"suffix": "string",
"time_remaining": 0
}
]
}

Generate a protection group snapshot

Creates a point-in-time snapshot of the contents of a protection group. The source_ids or source_names parameter is required, but they cannot be set together.

query Parameters

apply_retention	boolean If `true`, applies the local and remote retention policy to the snapshots.
source_names	Array of strings Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, `name01,name02`.

header Parameters

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

Request Body schema: application/json

	object The pod in which the protection group of the protection group snapshot resides.
	object Returns provisioned size and physical storage consumption data for each protection group.
	object The original protection group from which this snapshot was taken. For a replicated protection group snapshot being viewed on the target side, the `source` is the replica protection group.
suffix	string The name suffix appended to the protection group name to make up the full protection group snapshot name in the form `PGROUP.SUFFIX`. If `suffix` is not specified, the protection group name is in the form `PGROUP.NNN`, where `NNN` is a unique monotonically increasing number. If multiple protection group snapshots are created at a time, the suffix name is appended to those snapshots.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"destroyed": true,
"pod": { },
"space": { },
"source": { },
"suffix": "string"
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"created": 1503520993,
"destroyed": true,
"pod": {"id": "string",
"name": "string"
},
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"source": {"id": "string",
"name": "string"
},
"suffix": "string",
"time_remaining": 0
}
]
}

Eradicate a protection group snapshot

Eradicates a protection group snapshot that has been destroyed and is pending eradication. Eradicating a protection group snapshot eradicates all of its protection group snapshots. Eradicated protection group snapshots cannot be recovered. Protection group snapshots are destroyed through the PATCH method. The ids or names parameter is required, but they cannot be set together.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

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

Responses

Manage a protection group snapshot

Destroys a protection group snapshot. To destroy a volume, set destroyed=true. To recover a volume that has been destroyed and is pending eradication, set destroyed=false. The names parameter is required.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

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

Request Body schema: application/json

name	string A user-specified name. The name must be locally unique and can be changed.
destroyed	boolean Returns a value of `true` if the protection group snapshot has been destroyed and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed snapshot is permanently eradicated. Before the `time_remaining` period has elapsed, the destroyed snapshot can be recovered by setting `destroyed=false`. Once the `time_remaining` period has elapsed, the snapshot is permanently eradicated and can no longer be recovered.
	object The pod in which the protection group of the protection group snapshot resides.
	object Returns provisioned size and physical storage consumption data for each protection group.
	object The original protection group from which this snapshot was taken. For a replicated protection group snapshot being viewed on the target side, the `source` is the replica protection group.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"destroyed": true,
"pod": { },
"space": { },
"source": { },
"suffix": "string"
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"created": 1503520993,
"destroyed": true,
"pod": {"id": "string",
"name": "string"
},
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"source": {"id": "string",
"name": "string"
},
"suffix": "string",
"time_remaining": 0
}
]
}

List protection group snapshots with transfer statistics

Returns a list of protection group snapshots and their transfer statistics.

query Parameters

destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
source_names	Array of strings Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, `name01,name02`.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"name": "string",
"destroyed": true,
"started": 0,
"progress": 0.66,
"completed": 0,
"data_transferred": 0,
"physical_bytes_written": 0
}
],
"total": [{"name": "string",
"destroyed": true,
"started": 0,
"progress": 0.66,
"completed": 0,
"data_transferred": 0,
"physical_bytes_written": 0
}
]
}

Remote Pods

A remote pod represents a pod that is on a connected array but not stretched to this array.

List remote pods

Returns a list of pods that that are on connected arrays but not stretched to this array.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
on	Array of strings Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, `targetName01,targetName02`.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"id": "string",
"name": "string",
"arrays": [{"id": "string",
"name": "string"
}
]
}
]
}

Remote Protection Groups

A remote protection group represents a protection group that resides on an offload target with the source side of the remote protection group being another array that is connected to the local array. The local array can only see the remote protection groups of other arrays if the two arrays are connected.

List remote protection groups

Returns a list of remote protection groups.

query Parameters

destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
on	Array of strings Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, `targetName01,targetName02`.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"id": "string",
"name": "string",
"destroyed": true,
"is_local": true,
"remote": {"id": "string",
"name": "string"
},
"source": {"id": "string",
"name": "string"
},
"target_retention": {"all_for_sec": 86400,
"days": 7,
"per_day": 3
},
"time_remaining": 0
}
]
}

Eradicate a remote protection group

Eradicates a remote protection group that has been destroyed and is pending eradication. Eradicated remote protection groups cannot be recovered. Remote protection groups are destroyed through the PATCH method. The on parameter represents the name of the offload target. The ids or names parameter and the on parameter are required and must be used together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
on	string Performs the operation on the target name specified. For example, `targetName01`.

header Parameters

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

Responses

Manage a remote protection group

Configures the snapshot retention schedule of a remote protection group. Also destroys a remote protection group from the offload target. Before the remote protection group can be destroyed, the offload target must first be removed from the protection group via the source array. The on parameter represents the name of the offload target. The ids or names parameter and the on parameter are required and must be used together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
on	string Performs the operation on the target name specified. For example, `targetName01`.

header Parameters

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

Request Body schema: application/json

destroyed	boolean Returns a value of `true` if the remote protection group has been destroyed and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed remote protection group is permanently eradicated. Before the `time_remaining` period has elapsed, the destroyed remote protection group can be recovered by setting `destroyed=false`. Once the `time_remaining` period has elapsed, the remote protection group is permanently eradicated and can no longer be recovered.
	object The offload target that the remote protection group is on.
	object The array where the remote protection group is replicated from.
	object The retention policy for the remote protection group.

Responses

Request samples

Payload

Content type

application/json

{"destroyed": true,
"remote": { },
"source": { },
"target_retention": {"all_for_sec": 86400,
"days": 7,
"per_day": 3
}
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"destroyed": true,
"is_local": true,
"remote": {"id": "string",
"name": "string"
},
"source": {"id": "string",
"name": "string"
},
"target_retention": {"all_for_sec": 86400,
"days": 7,
"per_day": 3
},
"time_remaining": 0
}
]
}

Remote Protection Group Snapshots

A remote protection group snapshot represents a protection group snapshot that resides on an offload target with the source side of the remote protection group snapshot being another array that is connected to the local array. The local array can only see the remote protection group snapshots of other arrays if the two arrays are connected.

List remote protection group snapshots

Returns a list of remote protection group snapshots.

query Parameters

destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
on	Array of strings Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, `targetName01,targetName02`.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
source_names	Array of strings Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, `name01,name02`.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"name": "string",
"created": 1503520993,
"destroyed": true,
"is_local": true,
"remote": {"id": "string",
"name": "string"
},
"source": {"name": "string"
},
"suffix": "string",
"time_remaining": 0
}
]
}

Eradicate a remote protection group snapshot

Eradicates a remote protection group snapshot that has been destroyed and is pending eradication. Eradicated remote protection group snapshots cannot be recovered. Remote protection group snapshots are destroyed through the PATCH method. The names parameter represents the name of the protection group snapshot. The on parameter represents the name of the offload target. The names and on parameters are required and must be used together.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
on	string Performs the operation on the target name specified. For example, `targetName01`.

header Parameters

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

Responses

Manage a remote protection group

Destroys a remote protection group snapshot from the offload target. The on parameter represents the name of the offload target. The ids or names parameter and the on parameter are required and must be used together.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
on	string Performs the operation on the target name specified. For example, `targetName01`.

header Parameters

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

Request Body schema: application/json

destroyed

boolean

If set to true, destroys a resource. Once set to true, the time_remaining value will display the amount of time left until the destroyed resource is permanently eradicated. Before the time_remaining period has elapsed, the destroyed resource can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the resource is permanently eradicated and can no longer be recovered.

Responses

Request samples

Payload

Content type

application/json

{"destroyed": true
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"created": 1503520993,
"destroyed": true,
"is_local": true,
"remote": {"id": "string",
"name": "string"
},
"source": {"name": "string"
},
"suffix": "string",
"time_remaining": 0
}
]
}

List remote protection groups with transfer statistics

Returns a list of remote protection groups and their transfer statistics.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
on	Array of strings Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, `targetName01,targetName02`.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
source_names	Array of strings Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, `name01,name02`.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"name": "string",
"destroyed": true,
"started": 0,
"progress": 0.66,
"completed": 0,
"data_transferred": 0,
"physical_bytes_written": 0
}
],
"total": [{"name": "string",
"destroyed": true,
"started": 0,
"progress": 0.66,
"completed": 0,
"data_transferred": 0,
"physical_bytes_written": 0
}
]
}

Remote Volume Snapshots

A remote volume snapshot represents a volume snapshot that resides on an offload target with the source side of the remote volume snapshot being another array that is connected to the local array. The local array can only see the remote volume snapshots of other arrays if the two arrays are connected.

List remote volume snapshots

Returns a list of remote volume snapshots.

query Parameters

destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
on	Array of strings Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, `targetName01,targetName02`.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
source_ids	Array of strings Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.
source_names	Array of strings Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, `name01,name02`.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"id": "string",
"name": "string",
"created": 0,
"destroyed": true,
"pod": {"id": "string",
"name": "string"
},
"provisioned": 0,
"source": {"id": "string",
"name": "string"
},
"suffix": "string",
"time_remaining": 0,
"remote": {"id": "string",
"name": "string"
}
}
]
}

List remote volume snapshots with transfer statistics

Returns a list of remote volume snapshots and their transfer statistics.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
on	Array of strings Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, `targetName01,targetName02`.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
source_ids	Array of strings Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.
source_names	Array of strings Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, `name01,name02`.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"id": "string",
"name": "string",
"destroyed": true,
"started": 0,
"progress": 0.66,
"completed": 0,
"data_transferred": 0,
"physical_bytes_written": 0
}
],
"total": [{"id": "string",
"name": "string",
"destroyed": true,
"started": 0,
"progress": 0.66,
"completed": 0,
"data_transferred": 0,
"physical_bytes_written": 0
}
]
}

Volumes

A volume represents a container that manages the storage space on the array. After a volume has been created, establish a host-volume connection so that the host can read data from and write data to the volume. Furthermore, protect the volume data through asynchronous replication to a remote array, synchronous replication between remote arrays, and replication to external storage systems.

List volumes

Returns a list of volumes, including those pending eradication.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"id": "string",
"name": "string",
"connection_count": 0,
"created": 0,
"destroyed": true,
"host_encryption_key_status": "detected",
"provisioned": 0,
"qos": {"bandwidth_limit": 1048576,
"iops_limit": 100
},
"serial": "string",
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"time_remaining": 0,
"pod": {"id": "string",
"name": "string"
},
"source": {"id": "string",
"name": "string"
},
"subtype": "string",
"volume_group": {"id": "string",
"name": "string"
}
}
],
"total": [{"id": "string",
"name": "string",
"connection_count": 0,
"created": 0,
"destroyed": true,
"host_encryption_key_status": "detected",
"provisioned": 0,
"qos": {"bandwidth_limit": 1048576,
"iops_limit": 100
},
"serial": "string",
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"time_remaining": 0,
"pod": {"id": "string",
"name": "string"
},
"source": {"id": "string",
"name": "string"
},
"subtype": "string",
"volume_group": {"id": "string",
"name": "string"
}
}
]
}

Create a volume

Creates one or more virtual storage volumes of the specified size. If provisioned is not specified, the size of the new volume defaults to 1 MB in size. The names query parameter is required.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
overwrite	boolean If set to `true`, overwrites an existing object during an object copy operation. If set to `false` or not set at all and the target name is an existing object, the copy operation fails. Required if the `source` body parameter is set and the source overwrites an existing object during the copy operation.

header Parameters

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

Request Body schema: application/json

destroyed	boolean If set to `true`, destroys a resource. Once set to `true`, the `time_remaining` value will display the amount of time left until the destroyed resource is permanently eradicated. Before the `time_remaining` period has elapsed, the destroyed resource can be recovered by setting `destroyed=false`. Once the `time_remaining` period has elapsed, the resource is permanently eradicated and can no longer be recovered.
provisioned	integer <int64> <= 4503599627370496 Sets the virtual size of the volume. Measured in bytes.
	object Sets QoS limits.
	object The source volume of a volume copy.
subtype	string The type of volume. Valid values are `protocol_endpoint` and `regular`.

Responses

Request samples

Payload

Content type

application/json

{"destroyed": true,
"provisioned": 0,
"qos": {"bandwidth_limit": 1048576,
"iops_limit": 100
},
"source": {"id": "string",
"name": "string"
},
"subtype": "string"
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"connection_count": 0,
"created": 0,
"destroyed": true,
"host_encryption_key_status": "detected",
"provisioned": 0,
"qos": {"bandwidth_limit": 1048576,
"iops_limit": 100
},
"serial": "string",
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"time_remaining": 0,
"pod": {"id": "string",
"name": "string"
},
"source": {"id": "string",
"name": "string"
},
"subtype": "string",
"volume_group": {"id": "string",
"name": "string"
}
}
]
}

Eradicate a volume

Eradicates a volume that has been destroyed and is pending eradication. Eradicated volumes cannot be recovered. Volumes are destroyed through the PATCH method. The ids or names parameter is required, but they cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

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

Responses

Manage a volume

Renames, destroys, or resizes a volume. To rename a volume, set name to the new name. To destroy a volume, set destroyed=true. To recover a volume that has been destroyed and is pending eradication, set destroyed=false. Sets the bandwidth and IOPs limits of a volume through the respective bandwidth_limit and iops_limit parameter. Moves the volume into a pod or volume group through the respective pod or volume_group parameter. The ids or names parameter is required, but they cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
truncate	boolean If set to `true`, reduces the size of a volume during a volume resize operation. When a volume is truncated, Purity automatically takes an undo snapshot, providing a 24-hour window during which the previous contents can be retrieved. After truncating a volume, its provisioned size can be subsequently increased, but the data in truncated sectors cannot be retrieved. If set to `false` or not set at all and the volume is being reduced in size, the volume copy operation fails. Required if the `provisioned` parameter is set to a volume size that is smaller than the original size.

header Parameters

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

Request Body schema: application/json

destroyed	boolean If set to `true`, destroys a resource. Once set to `true`, the `time_remaining` value will display the amount of time left until the destroyed resource is permanently eradicated. Before the `time_remaining` period has elapsed, the destroyed resource can be recovered by setting `destroyed=false`. Once the `time_remaining` period has elapsed, the resource is permanently eradicated and can no longer be recovered.
name	string The new name for the resource.
	object Moves the volume into the specified pod.
provisioned	integer <int64> <= 4503599627370496 Updates the virtual size of the volume. Measured in bytes.
	object Sets QoS limits.
	object Adds the volume to the specified volume group.

Responses

Request samples

Payload

Content type

application/json

{"destroyed": true,
"name": "string",
"pod": {"id": "string",
"name": "string"
},
"provisioned": 0,
"qos": {"bandwidth_limit": 1048576,
"iops_limit": 100
},
"volume_group": {"id": "string",
"name": "string"
}
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"connection_count": 0,
"created": 0,
"destroyed": true,
"host_encryption_key_status": "detected",
"provisioned": 0,
"qos": {"bandwidth_limit": 1048576,
"iops_limit": 100
},
"serial": "string",
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"time_remaining": 0,
"pod": {"id": "string",
"name": "string"
},
"source": {"id": "string",
"name": "string"
},
"subtype": "string",
"volume_group": {"id": "string",
"name": "string"
}
}
]
}

List volume performance data

Returns real-time and historical performance data, real-time latency data, and average I/O sizes for each volume and and as a total of all volumes across the entire array.

query Parameters

destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"id": "string",
"name": "string",
"bytes_per_mirrored_write": 0,
"bytes_per_op": 0,
"bytes_per_read": 0,
"bytes_per_write": 0,
"mirrored_write_bytes_per_sec": 0,
"mirrored_writes_per_sec": 0,
"qos_rate_limit_usec_per_mirrored_write_op": 0,
"qos_rate_limit_usec_per_read_op": 0,
"qos_rate_limit_usec_per_write_op": 0,
"queue_usec_per_mirrored_write_op": 0,
"queue_usec_per_read_op": 0,
"queue_usec_per_write_op": 0,
"read_bytes_per_sec": 0,
"reads_per_sec": 0,
"san_usec_per_mirrored_write_op": 0,
"san_usec_per_read_op": 0,
"san_usec_per_write_op": 0,
"service_usec_per_mirrored_write_op": 0,
"service_usec_per_read_op": 0,
"service_usec_per_write_op": 0,
"time": 0,
"usec_per_mirrored_write_op": 0,
"usec_per_read_op": 0,
"usec_per_write_op": 0,
"write_bytes_per_sec": 0,
"writes_per_sec": 0
}
],
"total": [{"id": "string",
"name": "string",
"bytes_per_mirrored_write": 0,
"bytes_per_op": 0,
"bytes_per_read": 0,
"bytes_per_write": 0,
"mirrored_write_bytes_per_sec": 0,
"mirrored_writes_per_sec": 0,
"qos_rate_limit_usec_per_mirrored_write_op": 0,
"qos_rate_limit_usec_per_read_op": 0,
"qos_rate_limit_usec_per_write_op": 0,
"queue_usec_per_mirrored_write_op": 0,
"queue_usec_per_read_op": 0,
"queue_usec_per_write_op": 0,
"read_bytes_per_sec": 0,
"reads_per_sec": 0,
"san_usec_per_mirrored_write_op": 0,
"san_usec_per_read_op": 0,
"san_usec_per_write_op": 0,
"service_usec_per_mirrored_write_op": 0,
"service_usec_per_read_op": 0,
"service_usec_per_write_op": 0,
"time": 0,
"usec_per_mirrored_write_op": 0,
"usec_per_read_op": 0,
"usec_per_write_op": 0,
"write_bytes_per_sec": 0,
"writes_per_sec": 0
}
]
}

List volume performance data by array

Return real-time and historical performance data, real-time latency data, and average I/O size data. The data returned is for each volume on the current array and for each volume on any remote arrays that are visible to the current array. The data is grouped by individual volumes and as a total across all volumes on each array.

query Parameters

destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"id": "string",
"name": "string",
"bytes_per_mirrored_write": 0,
"bytes_per_op": 0,
"bytes_per_read": 0,
"bytes_per_write": 0,
"mirrored_write_bytes_per_sec": 0,
"mirrored_writes_per_sec": 0,
"qos_rate_limit_usec_per_mirrored_write_op": 0,
"qos_rate_limit_usec_per_read_op": 0,
"qos_rate_limit_usec_per_write_op": 0,
"queue_usec_per_mirrored_write_op": 0,
"queue_usec_per_read_op": 0,
"queue_usec_per_write_op": 0,
"read_bytes_per_sec": 0,
"reads_per_sec": 0,
"san_usec_per_mirrored_write_op": 0,
"san_usec_per_read_op": 0,
"san_usec_per_write_op": 0,
"service_usec_per_mirrored_write_op": 0,
"service_usec_per_read_op": 0,
"service_usec_per_write_op": 0,
"time": 0,
"usec_per_mirrored_write_op": 0,
"usec_per_read_op": 0,
"usec_per_write_op": 0,
"write_bytes_per_sec": 0,
"writes_per_sec": 0,
"array": {"id": "string",
"name": "string"
}
}
],
"total": [{"id": "string",
"name": "string",
"bytes_per_mirrored_write": 0,
"bytes_per_op": 0,
"bytes_per_read": 0,
"bytes_per_write": 0,
"mirrored_write_bytes_per_sec": 0,
"mirrored_writes_per_sec": 0,
"qos_rate_limit_usec_per_mirrored_write_op": 0,
"qos_rate_limit_usec_per_read_op": 0,
"qos_rate_limit_usec_per_write_op": 0,
"queue_usec_per_mirrored_write_op": 0,
"queue_usec_per_read_op": 0,
"queue_usec_per_write_op": 0,
"read_bytes_per_sec": 0,
"reads_per_sec": 0,
"san_usec_per_mirrored_write_op": 0,
"san_usec_per_read_op": 0,
"san_usec_per_write_op": 0,
"service_usec_per_mirrored_write_op": 0,
"service_usec_per_read_op": 0,
"service_usec_per_write_op": 0,
"time": 0,
"usec_per_mirrored_write_op": 0,
"usec_per_read_op": 0,
"usec_per_write_op": 0,
"write_bytes_per_sec": 0,
"writes_per_sec": 0,
"array": {"id": "string",
"name": "string"
}
}
]
}

List volumes that are members of protection groups

Returns a list of volume members that belong to one or more protection groups.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"group": {"name": "string"
},
"member": {"name": "string"
}
}
]
}

Add a volume to a protection group

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"items": [{"group": {"name": "string"
},
"member": {"name": "string"
}
}
]
}

Remove a volume from a protection group

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

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

Responses

List volume space information

Returns the provisioned size and physical storage consumption data for each volume.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"id": "string",
"name": "string",
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"time": 0
}
],
"total": [{"id": "string",
"name": "string",
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"time": 0
}
]
}

List volumes that are in volume groups

Returns a list of volumes that are in a volume group.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
group_ids	Array of strings A comma-separated list of group IDs.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` or `member_names` parameter is required, but they cannot be set together.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"group": {"id": "string",
"name": "string"
},
"member": {"id": "string",
"name": "string"
}
}
]
}

Volume Groups

Volume groups organize volumes into logical groupings. If virtual volumes are configured, each volume group on the FlashArray array represents its associated virtual machine, and inside each of those volumes groups are the FlashArray volumes that are assigned to the virtual machine. Volume groups that are associated with virtual machines have names that begin with vvol- and end with the virtual machine name.

List volume groups

Returns a list of volume groups, including those pending eradication.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"id": "string",
"name": "string",
"destroyed": true,
"qos": {"bandwidth_limit": 1048576,
"iops_limit": 100
},
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"time_remaining": 0,
"volume_count": 3
}
],
"total": [{"id": "string",
"name": "string",
"destroyed": true,
"qos": {"bandwidth_limit": 1048576,
"iops_limit": 100
},
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"time_remaining": 0,
"volume_count": 3
}
]
}

Create a volume group

Creates a volume group. The volume group itself does not contain any meaningful content; instead, it acts as a container that is used to organize volumes. Once a volume group has been created, volumes can be created inside the volume group or moved into and out of the volume group.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

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

Request Body schema: application/json

	object (_qos)
	object (_space)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"destroyed": true,
"qos": {"bandwidth_limit": 1048576,
"iops_limit": 100
},
"space": { }
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"destroyed": true,
"qos": {"bandwidth_limit": 1048576,
"iops_limit": 100
},
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"time_remaining": 0,
"volume_count": 3
}
]
}

Eradicate a volume group

Eradicates a volume group that has been destroyed and is pending eradication. Eradicated volume groups cannot be recovered. Volume groups are destroyed through the PATCH method. The ids or names parameter is required, but they cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

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

Responses

Manage a volume group

Renames, destroys, or sets the QoS limits for the To rename a volume group, set name to the new name. To destroy a volume group, set destroyed=true. To recover a volume group that has been destroyed and is pending eradication, set destroyed=false. Sets the bandwidth and IOPs limits of a volume group through the respective bandwidth_limit and iops_limit parameter. The ids or names parameter is required, but they cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

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

Request Body schema: application/json

name	string A user-specified name. The name must be locally unique and can be changed.
destroyed	boolean Returns a value of `true` if the volume group has been destroyed and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed volume group is permanently eradicated. Before the `time_remaining` period has elapsed, the destroyed volume group can be recovered by setting `destroyed=false`. Once the `time_remaining` period has elapsed, the volume group is permanently eradicated and can no longer be recovered.
	object (_qos)
	object (_space)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"destroyed": true,
"qos": {"bandwidth_limit": 1048576,
"iops_limit": 100
},
"space": { }
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"destroyed": true,
"qos": {"bandwidth_limit": 1048576,
"iops_limit": 100
},
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"time_remaining": 0,
"volume_count": 3
}
]
}

List volume group performance data

Returns real-time and historical performance data, real-time latency data, and average I/O sizes for each volume group and and as a total of all volume groups across the entire array.

query Parameters

destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"id": "string",
"name": "string",
"bytes_per_mirrored_write": 0,
"bytes_per_op": 0,
"bytes_per_read": 0,
"bytes_per_write": 0,
"mirrored_write_bytes_per_sec": 0,
"mirrored_writes_per_sec": 0,
"qos_rate_limit_usec_per_mirrored_write_op": 0,
"qos_rate_limit_usec_per_read_op": 0,
"qos_rate_limit_usec_per_write_op": 0,
"queue_usec_per_mirrored_write_op": 0,
"queue_usec_per_read_op": 0,
"queue_usec_per_write_op": 0,
"read_bytes_per_sec": 0,
"reads_per_sec": 0,
"san_usec_per_mirrored_write_op": 0,
"san_usec_per_read_op": 0,
"san_usec_per_write_op": 0,
"service_usec_per_mirrored_write_op": 0,
"service_usec_per_read_op": 0,
"service_usec_per_write_op": 0,
"time": 0,
"usec_per_mirrored_write_op": 0,
"usec_per_read_op": 0,
"usec_per_write_op": 0,
"write_bytes_per_sec": 0,
"writes_per_sec": 0
}
],
"total": [{"id": "string",
"name": "string",
"bytes_per_mirrored_write": 0,
"bytes_per_op": 0,
"bytes_per_read": 0,
"bytes_per_write": 0,
"mirrored_write_bytes_per_sec": 0,
"mirrored_writes_per_sec": 0,
"qos_rate_limit_usec_per_mirrored_write_op": 0,
"qos_rate_limit_usec_per_read_op": 0,
"qos_rate_limit_usec_per_write_op": 0,
"queue_usec_per_mirrored_write_op": 0,
"queue_usec_per_read_op": 0,
"queue_usec_per_write_op": 0,
"read_bytes_per_sec": 0,
"reads_per_sec": 0,
"san_usec_per_mirrored_write_op": 0,
"san_usec_per_read_op": 0,
"san_usec_per_write_op": 0,
"service_usec_per_mirrored_write_op": 0,
"service_usec_per_read_op": 0,
"service_usec_per_write_op": 0,
"time": 0,
"usec_per_mirrored_write_op": 0,
"usec_per_read_op": 0,
"usec_per_write_op": 0,
"write_bytes_per_sec": 0,
"writes_per_sec": 0
}
]
}

List volume group space information

Returns the provisioned size and physical storage consumption data for each volume group.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"id": "string",
"name": "string",
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"time": 0
}
],
"total": [{"id": "string",
"name": "string",
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"time": 0
}
]
}

List volume groups with volumes

Returns a list of volume groups that contain volumes.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
group_ids	Array of strings A comma-separated list of group IDs.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` or `member_names` parameter is required, but they cannot be set together.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"group": {"id": "string",
"name": "string"
},
"member": {"id": "string",
"name": "string"
}
}
]
}

Volume Snapshots

Volume snapshots are immutable, point-in-time images of the contents of one or more volumes. There are two types of volume snapshots: volume snapshots and protection group volume snapshots. A volume snapshot is a snapshot that captures the contents of a single volume. A protection group volume snapshot is a volume snapshot that is created from a group of volumes that are part of the same protection group. All of the volume snapshots created from a protection group snapshot are point-in-time consistent with each other.

List volume snapshots

Return a list of volume snapshots, including those pending eradication.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
source_ids	Array of strings Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.
source_names	Array of strings Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, `name01,name02`.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"id": "string",
"name": "string",
"created": 0,
"destroyed": true,
"pod": {"id": "string",
"name": "string"
},
"provisioned": 0,
"source": {"id": "string",
"name": "string"
},
"suffix": "string",
"time_remaining": 0,
"serial": "string",
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"volume_group": {"id": "string",
"name": "string"
}
}
],
"total": [{"id": "string",
"name": "string",
"created": 0,
"destroyed": true,
"pod": {"id": "string",
"name": "string"
},
"provisioned": 0,
"source": {"id": "string",
"name": "string"
},
"suffix": "string",
"time_remaining": 0,
"serial": "string",
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"volume_group": {"id": "string",
"name": "string"
}
}
]
}

Generate a volume snapshot

Create a point-in-time snapshot of the contents of a volume. The source_ids or source_names parameter is required, but they cannot be set together.

query Parameters

on	string Performs the operation on the target name specified. For example, `targetName01`.
source_ids	Array of strings Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.
source_names	Array of strings Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, `name01,name02`.

header Parameters

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

Request Body schema: application/json

destroyed

boolean

suffix

string

The suffix that is appended to the source_name value to generate the full volume snapshot name in the form VOL.SUFFIX. If the suffix is not specified, the system constructs the snapshot name in the form VOL.NNN, where VOL is the volume name, and NNN is a monotonically increasing number.

Responses

Request samples

Payload

Content type

application/json

{"destroyed": true,
"suffix": "string"
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"created": 0,
"destroyed": true,
"pod": {"id": "string",
"name": "string"
},
"provisioned": 0,
"source": {"id": "string",
"name": "string"
},
"suffix": "string",
"time_remaining": 0,
"serial": "string",
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"volume_group": {"id": "string",
"name": "string"
}
}
]
}

Eradicate a volume snapshot

Eradicate a volume snapshot that has been destroyed and is pending eradication. Eradicated volumes snapshots cannot be recovered. Volume snapshots are destroyed through the PATCH method. The ids or names parameter is required, but they cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

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

Responses

Manage a volume snapshot

Rename, destroy, or recover a volume snapshot. To rename the suffix of a volume snapshot, set name to the new suffix name. To recover a volume snapshot that has been destroyed and is pending eradication, set destroyed=true. The ids or names parameter is required, but they cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

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

Request Body schema: application/json

destroyed

boolean

name

string

The new name for the resource.

Responses

Request samples

Payload

Content type

application/json

{"destroyed": true,
"name": "string"
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"created": 0,
"destroyed": true,
"pod": {"id": "string",
"name": "string"
},
"provisioned": 0,
"source": {"id": "string",
"name": "string"
},
"suffix": "string",
"time_remaining": 0,
"serial": "string",
"space": {"data_reduction": 0,
"shared": 111863360624,
"snapshots": 0,
"system": 0,
"thin_provisioning": 0,
"total_physical": 0,
"total_provisioned": 19937690345472,
"total_reduction": 0,
"unique": 0,
"virtual": 0
},
"volume_group": {"id": "string",
"name": "string"
}
}
]
}

List volume snapshots with transfer statistics

Returns a list of volume snapshots and their transfer statistics.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together.
limit	integer <int32> >= 0 Example: limit=10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: offset=10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
source_ids	Array of strings Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.
source_names	Array of strings Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, `name01,name02`.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

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

Responses

Response samples

Content type

application/json

{"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items": [{"id": "string",
"name": "string",
"destroyed": true,
"started": 0,
"progress": 0.66,
"completed": 0,
"data_transferred": 0,
"physical_bytes_written": 0
}
],
"total": [{"id": "string",
"name": "string",
"destroyed": true,
"started": 0,
"progress": 0.66,
"completed": 0,
"data_transferred": 0,
"physical_bytes_written": 0
}
]
}