FlashArray REST API (2.37)

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

Active Directory

Active Directory configuration authenticates users for NFS using Kerberos or SMB using Kerberos or New Technology LAN Manager (NTLM). Active Directory is also used to authorize users by mapping identities across the NFS and SMB protocols by using LDAP queries.

List Active Directory accounts

Displays configured Active Directory accounts.

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",
"computer_name": "FLASHARRAY01",
"directory_servers": ["ldap.my-corporation.com"
],
"domain": "my-corporation.com",
"kerberos_servers": ["kdc.my-corporation.com"
],
"tls": "required"
}
]
}

Create Active Directory account

Creates one or more Active Directory accounts. The user and password provided are used to join the array to the specified domain.

query Parameters

names

required

Array of strings

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

join_existing_account

boolean

If specified as true, the domain is searched for a pre-existing computer account to join to, and no new account will be created within the domain. The user specified when joining a pre-existing account must have permissions to 'read all properties from' and 'reset the password of' the pre-existing account. join_ou will be read from the pre-existing account and cannot be specified when joining to an existing account. 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.

Request Body schema: application/json

computer_name	string The name of the computer account to be created in the Active Directory domain. If not specified, defaults to the name of the Active Directory configuration.
directory_servers	Array of strings A list of directory servers used for lookups related to user authorization. Servers must be specified in FQDN format. All specified servers must be registered to the domain appropriately in the configured DNS of the array and are only communicated with over the secure LDAP (LDAPS) protocol. If not specified, servers are resolved for the domain in DNS.
domain	string The Active Directory domain to join.
kerberos_servers	Array of strings A list of key distribution servers to use for Kerberos protocol. Servers must be specified in FQDN format. All specified servers must be registered to the domain appropriately in the configured DNS of the array. If not specified, servers are resolved for the domain in DNS.
password	string The login password of the user with privileges to create the computer account in the domain. This is not persisted on the array.
user	string The login name of the user with privileges to create the computer account in the domain. This is not persisted on the array.
join_ou	string The distinguished name of the organizational unit in which the computer account should be created when joining the domain. The `DC=...` components of the distinguished name can be optionally omitted. If not specified, defaults to `CN=Computers`.
tls	string TLS mode for communication with domain controllers. Valid values are `required` and `optional`. `required` forces TLS communication with a domain controller. `optional` allows the use of non-TLS communication, TLS will still be preferred, if available. If not specified, defaults to `required`.

Responses

Request samples

Payload

Content type

application/json

{"computer_name": "FLASHARRAY01",
"directory_servers": ["ldap.my-corporation.com"
],
"domain": "my-corporation.com",
"kerberos_servers": ["kdc.my-corporation.com"
],
"password": "password",
"user": "Administrator",
"join_ou": "OU=Dev,OU=Sweden,DC=purestorage,DC=com",
"tls": "required"
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"computer_name": "FLASHARRAY01",
"directory_servers": ["ldap.my-corporation.com"
],
"domain": "my-corporation.com",
"kerberos_servers": ["kdc.my-corporation.com"
],
"tls": "required"
}
]
}

Delete Active Directory account

Deletes one or more specified Active Directory accounts.

query Parameters

local_only	boolean If specified as `true`, only delete the Active Directory configuration on the local array, without deleting the computer account created in the Active Directory domain. If not specified, defaults to `false`.
names required	Array of strings Performs the operation on the unique name specified. For example, `name01`. Enter multiple names in comma-separated format.

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

Modify Active Directory account

Modifies specified Active Directory account.

query Parameters

names

required

Array of strings

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

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

tls

string

TLS mode for communication with domain controllers. Valid values are required and optional. required forces TLS communication with domain controller. optional allows the use of non-TLS communication, TLS will still be preferred, if available. If not specified, defaults to required.

Responses

Request samples

Payload

Content type

application/json

{"tls": "required"
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"computer_name": "FLASHARRAY01",
"directory_servers": ["ldap.my-corporation.com"
],
"domain": "my-corporation.com",
"kerberos_servers": ["kdc.my-corporation.com"
],
"tls": "required"
}
]
}

Administrators

The FlashArray has a single default administrative account named pureuser. The administrator can add, delete, and modify administrators on the array. Administrators are assigned management access policies to give different levels of permissions.

List administrators

Displays a list of administrators.

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.
expose_api_token	boolean If `true`, exposes the API token of the current user.
expose_public_key	boolean If `true`, exposes the public key of the current user.
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",
"api_token": {"created_at": 0,
"expires_at": 0,
"token": "string"
},
"is_local": true,
"locked": false,
"lockout_remaining": 0,
"password": "string",
"public_key": "string",
"role": {"name": "string"
},
"management_access_policies": [{"id": "string",
"name": "string",
"resource_type": "string"
}
]
}
]
}

Create an administrator

Creates an administrator.

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

password	string Password associated with the account.
	object (_adminRole) This field has been deprecated. Predecessor to management access policies.
	Array of objects (_referenceWithType) List of management access policies to associate with the administrator. Policies can be specified by the `name` or `ID` parameter, but they cannot be set together.

Responses

Request samples

Payload

Content type

application/json

{"password": "string",
"role": {"name": "string"
},
"management_access_policies": [{"id": "string",
"name": "string",
"resource_type": "string"
}
]
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"api_token": {"created_at": 0,
"expires_at": 0,
"token": "string"
},
"is_local": true,
"locked": false,
"lockout_remaining": 0,
"password": "string",
"public_key": "string",
"role": {"name": "string"
},
"management_access_policies": [{"id": "string",
"name": "string",
"resource_type": "string"
}
]
}
]
}

Delete an administrator

Deletes the specified administrator.

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

Modify an administrator

Modifies properties for the specified administrator.

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 (_apiToken) API token
locked	boolean Returns a value of `true` if the user is currently locked out. otherwise `false`. Change to `false` to unlock a user. This field is only visible to `array_admin` roles. For all other users, the value is always `null`.
password	string Password associated with the account.
public_key	string Public key for SSH access. Multiple public keys can be specified, separated by newlines.
	object (_adminRole) This field has been deprecated. Predecessor to management access policies.
old_password	string The current password.

Responses

Request samples

Payload

Content type

application/json

{"api_token": { },
"locked": false,
"password": "string",
"public_key": "string",
"role": {"name": "string"
},
"old_password": "string"
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"api_token": {"created_at": 0,
"expires_at": 0,
"token": "string"
},
"is_local": true,
"locked": false,
"lockout_remaining": 0,
"password": "string",
"public_key": "string",
"role": {"name": "string"
},
"management_access_policies": [{"id": "string",
"name": "string",
"resource_type": "string"
}
]
}
]
}

List management access policies attached to administrators

Displays a list of management access policies that are attached to administrators.

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.
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.
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`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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": [{"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

Create a membership between an administrator with one or more management access policies.

Creates a membership between an administrator with one or more management access policies. The member_ids or member_names parameter is required, but they cannot be set together.

query Parameters

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.
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

Array of objects (PolicyAssignmentPostPolicy)

A list of policies to apply to the resource. One of id or name is required in each policy.

Responses

Request samples

Payload

Content type

application/json

{"policies": [{"policy": {"id": "string",
"name": "string"
}
}
]
}

Response samples

Content type

application/json

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

Delete a membership between an administrator and one or more management access policies

Deletes a membership between an administrator with one or more management access policies. Thepolicy_ids or policy_names is required, but they cannot be set together. The member_ids or member_names is required, but they cannot be set together.

query Parameters

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.
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`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

List API tokens

Displays API tokens for the specified administrators.

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.
expose_api_token	boolean If `true`, exposes the API token of the current user.
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",
"api_token": {"created_at": 0,
"expires_at": 0,
"token": "string"
}
}
]
}

Create API tokens

Creates API tokens for the specified administrators.

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`.
timeout	integer <int64> The duration of API token validity, in milliseconds.

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",
"api_token": {"created_at": 0,
"expires_at": 0,
"token": "string"
}
}
]
}

Delete API tokens

Deletes the API tokens of the specified administrators.

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

List administrator cache entries

Displays entries in the administrator cache.

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",
"cached_at": 0,
"role": {"name": "string"
},
"management_access_policies": [{"id": "string",
"name": "string",
"resource_type": "string"
}
]
}
]
}

Update or refresh entries in the administrator cache

Updates entries in the cache for administrators who currently do not have a cache entry, otherwise refreshes the existing entry.

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",
"cached_at": 0,
"role": {"name": "string"
},
"management_access_policies": [{"id": "string",
"name": "string",
"resource_type": "string"
}
]
}
]
}

Delete cache entries

Deletes all entries from the administrator cache.

query Parameters

remove_all_entries

required

boolean

If set to true, removes all entries from the administrator cache.

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 administrator settings

Displays the global administrator settings for 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.
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

{"items": [{"lockout_duration": 3600000,
"max_login_attempts": 10,
"min_password_length": 1,
"single_sign_on_enabled": true,
"required_authentication_methods": {"ssh": ["password",
"key"
],
"web_ui": ["password",
"webauthn"
]
}
}
],
"more_items_remaining": false,
"total_item_count": 0
}

Modify administrator settings

Modifies the global administrator settings for the array.

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

lockout_duration	integer <int64> [ 1000 .. 7776000000 ] The lockout duration, in milliseconds, if a user is locked out after reaching the maximum number of login attempts. Ranges from 1 second to 90 days.
max_login_attempts	integer <int32> [ 1 .. 20 ] Maximum number of failed login attempts allowed before the user is locked out.
min_password_length	integer <int32> Minimum password length. If not specified, defaults to 1.
single_sign_on_enabled	boolean If `true`, then single sign-on is enabled for the array.
	object (_adminSettingsRequiredAuthenticationMethods) Authentication methods that are required for the array on specific user interfaces.

Responses

Request samples

Payload

Content type

application/json

{"lockout_duration": 3600000,
"max_login_attempts": 10,
"min_password_length": 1,
"single_sign_on_enabled": true,
"required_authentication_methods": {"ssh": ["password",
"key"
],
"web_ui": ["password",
"webauthn"
]
}
}

Response samples

Content type

application/json

{"items": [{"lockout_duration": 3600000,
"max_login_attempts": 10,
"min_password_length": 1,
"single_sign_on_enabled": true,
"required_authentication_methods": {"ssh": ["password",
"key"
],
"web_ui": ["password",
"webauthn"
]
}
}
]
}

Alerts

Alerts indicate significant events that occur on an array, including whenever a component degrades or the capacity threshold of the component is reached.

List alerts

Displays a list of alerts.

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.
flagged	boolean If set to `true`, lists only flagged messages. If set to `false`, lists only unflagged messages. if not specified, lists all messages.
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": "string",
"name": "string",
"actual": "95%",
"category": "array",
"closed": 1578440492342,
"code": 7,
"component_name": "vm-tom",
"component_type": "storage",
"created": 1576275532434,
"description": "boot drive overutilization",
"expected": "90%",
"flagged": true,
"issue": "boot drive overutilization",
"knowledge_base_url": "https://support.purestorage.com/?cid=Alert_0007",
"notified": 1578440491109,
"severity": "critical",
"state": "open",
"summary": "boot drive overutilization",
"updated": 1578440491109
}
]
}

Modify flagged state

Modifies one or more alerts and display updated information about these alerts.

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

flagged

boolean

If set to true, the message is flagged. Important messages can can be flagged and listed separately.

Responses

Request samples

Payload

Content type

application/json

{"flagged": true
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"actual": "95%",
"category": "array",
"closed": 1578440492342,
"code": 7,
"component_name": "vm-tom",
"component_type": "storage",
"created": 1576275532434,
"description": "boot drive overutilization",
"expected": "90%",
"flagged": true,
"issue": "boot drive overutilization",
"knowledge_base_url": "https://support.purestorage.com/?cid=Alert_0007",
"notified": 1578440491109,
"severity": "critical",
"state": "open",
"summary": "boot drive overutilization",
"updated": 1578440491109
}
]
}

List alert events

Displays a list of alert events.

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.
flagged	boolean If set to `true`, lists only flagged messages. If set to `false`, lists only unflagged messages. if not specified, lists all messages.
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. For example, `name01`. Enter multiple names in comma-separated format. The `ids` or `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": [{"name": "string",
"actual": "95%",
"alert": {"id": "string",
"name": "string"
},
"created": 1576275532434,
"code": 7,
"component_name": "vm-tom",
"component_type": "storage",
"expected": "90%",
"issue": "boot drive overutilization",
"knowledge_base_url": "https://support.purestorage.com/?cid=Alert_0007",
"severity": "critical",
"state": "open",
"summary": "boot drive overutilization",
"time": 1578440491109
}
]
}

List custom alert rules

Displays a list of custom alert rules.

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.
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`.
code	integer <int32> The alert code to display.

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": [{"code": 25,
"parameter": "info",
"value": "85"
}
]
}

Create a custom alert rule

Creates an alert rule with a custom value.

query Parameters

code required	integer <int32> The alert code that the rule applies to. Available alert codes for customization can be found in the alert rules catalog.
parameter required	string The parameter of the custom alert rule to modify. Values include `info` and `warning`. Available parameter values can be found in the alert rules catalog.

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

value

string

The value to use for the custom alert rule. Valid values for an alert code and parameter combination can be found in the alert rules catalog.

Responses

Request samples

Payload

Content type

application/json

{"value": "85"
}

Response samples

Content type

application/json

{"items": [{"code": 25,
"parameter": "info",
"value": "85"
}
]
}

Delete a custom alert rule

Deletes a custom alert rule.

query Parameters

code required	integer <int32> The alert code that the rule applies to. Available alert codes for customization can be found in the alert rules catalog.
parameter required	string The parameter of the custom alert rule to modify. Values include `info` and `warning`. Available parameter values can be found in the alert rules catalog.

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

Modify a custom alert rule

Modifies a custom alert rule to a new value.

query Parameters

code required	integer <int32> The alert code that the rule applies to. Available alert codes for customization can be found in the alert rules catalog.
parameter required	string The parameter of the custom alert rule to modify. Values include `info` and `warning`. Available parameter values can be found in the alert rules catalog.

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

value

string

The value to use for the custom alert rule. Valid values for an alert code and parameter combination can be found in the alert rules catalog.

Responses

Request samples

Payload

Content type

application/json

{"value": "85"
}

Response samples

Content type

application/json

{"items": [{"code": 25,
"parameter": "info",
"value": "85"
}
]
}

List available customizable alert codes

Displays a list of available customizable alert codes.

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.
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`.
code	integer <int32> The alert code to display.

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": [{"code": 25,
"subject": "Storage consumption has reached {percent_usage}% of usable capacity",
"parameter": "info",
"allowed_values": "Range 0-100 (must be equal to or lower than Warning Threshold)",
"default_value": "80%"
}
]
}

Alert Watchers

Alert watchers receive email notifications when alerts occur on an array.

List alert watchers

Displays alert watcher email addressess and indicates whether they are enabled.

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

Create alert watcher

Creates one or more alert watcher email addresses, adding them to the list of alert watchers.

query Parameters

names

required

Array of strings

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

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

If set to true, email notifications will be sent to this watcher for alerts. If set to false, email notifications are disabled. If not specified, defaults to true.

Responses

Request samples

Payload

Content type

application/json

{"enabled": true
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"enabled": true
}
]
}

Delete alert watcher

Delete alert watcher email address from the list of alert watchers.

query Parameters

names

required

Array of strings

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

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

Modify alert watcher

Modify alert watcher email address by enabling or disabling it.

query Parameters

names

required

Array of strings

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

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

If set to true, email notifications will be sent to this watcher for alerts. If set to false, email notifications are disabled.

Responses

Request samples

Payload

Content type

application/json

{"enabled": true
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"enabled": true
}
]
}

List alert watcher test

Displays alert watcher email test results.

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

{"total_item_count": 0,
"items": [{"component_address": "10.230.94.21",
"component_name": "CT0",
"description": "Testing phonehome connectivity",
"destination": "ra.cloud-support.purestorage.com",
"enabled": true,
"result_details": "Timeout connecting to phonehome endpoint",
"success": true,
"test_type": "phonehome",
"resource": {"name": "string"
}
}
]
}

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

Displays 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",
"access_policies": [{"id": "string",
"name": "string",
"resource_type": "string"
}
],
"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, issuer, and public_key parameters are required. The access_policies or max_role 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.

Request Body schema: application/json

max_role	string Deprecated. The maximum Admin Access Policy (previously '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 policy and that of the array user specified as the JWT `sub` (subject) claim. `max_role` is deprecated in favor of `access_policies`, but remains for backwards compatibility. If `max_role` is the name of a valid legacy role, it will be interpreted as the corresponding access policy of the same name. Otherwise, it's invalid.
	Array of objects (_referenceWithType) The access policies 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 these policies and those of the array user specified as the JWT `sub` (subject) claim.
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",
"access_policies": [{"id": "string",
"name": "string",
"resource_type": "string"
}
],
"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",
"access_policies": [{"id": "string",
"name": "string",
"resource_type": "string"
}
],
"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",
"access_policies": [{"id": "string",
"name": "string",
"resource_type": "string"
}
],
"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
}
]
}

Apps

Apps that extend array functionality can be integrated into the Purity//FA operating system.

List apps

Displays a list of installed apps.

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",
"description": "Snapshot offload to NFS or Amazon S3",
"enabled": true,
"status": "healthy",
"version": "1.0.0",
"details": "Insufficient resources to operate",
"vnc_enabled": true
}
]
}

Modify app

Modifies an installed app or modifies Virtual Network Computing (VNC) access for apps that are being patched.

query Parameters

names

required

Array of strings

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

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 If set to `true`, the app is enabled. By default, apps are disabled.
vnc_enabled	boolean If set to `true`, VNC access is enabled. By default, VNC access is disabled.

Responses

Request samples

Payload

Content type

application/json

{"enabled": true,
"vnc_enabled": true
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"description": "Snapshot offload to NFS or Amazon S3",
"enabled": true,
"status": "healthy",
"version": "1.0.0",
"details": "Insufficient resources to operate",
"vnc_enabled": true
}
]
}

List app nodes

Displays a list of installed apps and their nodes.

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.
app_names	Array of strings The name of the installed app. Enter multiple names in comma-separated format.
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.
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": [{"app": {"id": "string",
"name": "string"
},
"index": 0,
"status": "healthy",
"version": "1.0.0",
"vnc": ["10.1.1.10:5900"
]
}
]
}

Arrays

Array features provide the ability to configure settings that affect the operation of the array as a whole and monitor array I/O performance.

List arrays

Displays general array properties including the array name, login banner, idle timeout for management sessions, and NTP servers.

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.
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": "string",
"name": "string",
"_as_of": 1684403432765,
"banner": "Restricted area. Authorized personnel only.",
"capacity": 10995116277760,
"console_lock_enabled": false,
"encryption": {"data_at_rest": {"algorithm": "AES-256-CTR",
"enabled": true
},
"module_version": "FA-1.3"
},
"eradication_config": {"disabled_delay": 86400000,
"eradication_delay": 86400000,
"enabled_delay": 86400000,
"manual_eradication": "all-disabled"
},
"idle_timeout": 300000,
"ntp_servers": ["time.acme.com"
],
"ntp_symmetric_key": "string",
"os": "Purity//FA",
"parity": 0.99,
"scsi_timeout": 60000,
"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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0,
"shared_effective": 0,
"snapshots_effective": 0,
"unique_effective": 0,
"total_effective": 0,
"replication": 0
},
"time_zone": "America/Los_Angeles",
"version": "5.0.0"
}
]
}

Delete an array

Deletes an array. For physical appliances, deleting an array restores the hardware to factory settings. This entails deleting all data, metadata, configuration, and logs. The array returns to the state it was in prior to any configuration changes being made. If the hardware is reused, it must be as a different array with a new ID. For virtual appliances, deleting an array puts it into an unusable state. Virtual resources (e.g., virtual machines) can later be freed, which deletes any remaining data, metadata, configuration, and logs. Prior to factory reset, an array must be manually prepared (e.g., all volumes and snapshots must be eradicated) and a factory reset token must be created.

query Parameters

eradicate_all_data	boolean Set to `true` to perform a factory reset.
factory_reset_token	integer <int64> A token required to perform a factory reset.

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

Modify an array

Modifies general array properties such as the array name, login banner, idle timeout for management sessions, and NTP servers.

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.
banner	string
console_lock_enabled	boolean If `true`, console lock is enabled for the array. If the user does not have sufficient access, this field will return `null`.
	object If the user does not have sufficient access, all fields will return `null`.
	object (Eradication_config) The configuration of eradication feature.
idle_timeout	integer <int32> The idle timeout in milliseconds. Valid values include `0` and any multiple of `60000` in the range of `300000` and `10800000`. Any other values are rounded down to the nearest multiple of `60000`.
ntp_servers	Array of strings NTP Servers. If the user does not have sufficient access, this field will return `null`.
ntp_symmetric_key	string The text of ntp symmetric authentication key. Supported formats include a hex-encoded string no longer than 64 characters, or an ASCII string no longer than 20 characters, excluding "#". Any configured key will be masked as "****" on return. If the user does not have sufficient access, this field will return `null`.
scsi_timeout	integer <int32> The SCSI timeout. If not specified, defaults to `60s`. If the user does not have sufficient access, this field will return `null`.
	object If the user does not have sufficient access, all fields will return `null`.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"banner": "Restricted area. Authorized personnel only.",
"console_lock_enabled": false,
"encryption": {"data_at_rest": {"algorithm": "AES-256-CTR",
"enabled": true
}
},
"eradication_config": {"disabled_delay": 86400000,
"eradication_delay": 86400000,
"enabled_delay": 86400000
},
"idle_timeout": 300000,
"ntp_servers": ["time.acme.com"
],
"ntp_symmetric_key": "string",
"scsi_timeout": 60000,
"space": { }
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"_as_of": 1684403432765,
"banner": "Restricted area. Authorized personnel only.",
"capacity": 10995116277760,
"console_lock_enabled": false,
"encryption": {"data_at_rest": {"algorithm": "AES-256-CTR",
"enabled": true
},
"module_version": "FA-1.3"
},
"eradication_config": {"disabled_delay": 86400000,
"eradication_delay": 86400000,
"enabled_delay": 86400000,
"manual_eradication": "all-disabled"
},
"idle_timeout": 300000,
"ntp_servers": ["time.acme.com"
],
"ntp_symmetric_key": "string",
"os": "Purity//FA",
"parity": 0.99,
"scsi_timeout": 60000,
"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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0,
"shared_effective": 0,
"snapshots_effective": 0,
"unique_effective": 0,
"total_effective": 0,
"replication": 0
},
"time_zone": "America/Los_Angeles",
"version": "5.0.0"
}
]
}

List CBS array capacity status

Displays the capacity status of the CBS array including the progress of the capacity update. Requests for non-CBS arrays will receive an error response.

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.
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": "string",
"name": "string",
"current_capacity": 10995116277760,
"details": "string",
"requested_capacity": 10995116277760,
"status": "idle"
}
]
}

Modify CBS array capacity

Modifies the raw capacity of the CBS array. This should trigger a backend process that will update the CBS array capacity. The array capacity can be updated only to values defined by the capacity steps endpoint. When an existing capacity update request is in progress, any new request to update of the capacity will receive an error response. For non-CBS arrays, this feature is not supported and requests will receive an error response.

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

The requested capacity of the CBS array.

requested_capacity

integer <int64>

The requested raw capacity of the CBS array in bytes. When the capacity update process finishes, it should be the same as current_capacity.

Responses

Request samples

Payload

Content type

application/json

{"requested_capacity": 10995116277760
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"current_capacity": 10995116277760,
"details": "string",
"requested_capacity": 10995116277760,
"status": "idle"
}
]
}

List CBS array capacity steps

Displays the list of supported raw capacity sizes in bytes the CBS array can be upgraded to. Requests for non-CBS arrays will receive an error response.

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.
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": [{"supported_capacity": 10995116277760
}
]
}

List user tags on the cloud.

Displays the list of user tags on deployed cloud resources of a CBS 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.
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.
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": [{"key": "environment",
"value": "staging",
"details": "partially applied"
}
]
}

Delete user tags from the cloud.

Deletes user tags from deployed cloud resources of a CBS array.

query Parameters

keys	Array of strings A comma-separated list of tag keys.

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

Update user tags on the cloud.

Updates users tags to deployed cloud resources of a CBS array.

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

A list of tags to be created or, if already existing, updated.

Array ()

key	string Key of the tag. Supports UTF-8 Unicode characters. Please refer to the offical document from cloud providers for limitations.
value	string Value of the tag. Supports UTF-8 Unicode characters. Please refer to the offical document from cloud providers for limitations.

Responses

Request samples

Payload

Content type

application/json

[{"key": "environment",
"value": "staging"
}
]

Response samples

Content type

application/json

{"items": [{"key": "environment",
"value": "staging",
"details": "partially applied"
}
]
}

List factory reset details

Displays a list of factory reset processes.

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.
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": "string",
"name": "string",
"status": "resetting",
"image_source": "auto",
"image_version": "6.6.6",
"image_download_progress": 0.32,
"details": "string",
"sanitization_certificate": "string"
}
]
}

Create a process for factory reset

Creates the initiation of the factory reset process

query Parameters

eradicate_all_data required	boolean Set to `true` to perform a factory reset.
preserve_configuration_data required	Array of strings A comma-separated list of configuration data types to preserve. A value of `all` will preserve all configuration data types. Valid values include `all`.
skip_phonehome_check	boolean A flag to skip phonehome connectivity check. If `skip_phonehome_check` is not set, the factory reset will fail if phonehome connectivity check fails. Arrays that intentionally disable phonehome or do not permit connectivity to Pure Storage's cloud servers must set this flag to `true` in order to start factory reset.

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": [{"id": "string",
"name": "string",
"status": "resetting",
"image_source": "auto",
"image_version": "6.6.6",
"image_download_progress": 0.32,
"details": "string",
"sanitization_certificate": "string"
}
]
}

Delete factory reset

Deletes the factory reset process when it is failed.

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

Update factory reset

Modifies the factory reset process to finalize.

query Parameters

delete_sanitization_certificate required	boolean Set to `true` to finalize factory reset and acknowledge the deletion of sanitization certificate.
eradicate_all_data required	boolean Set to `true` to perform a factory reset.
finalize required	boolean Must be `true` to finalize factory reset.
reinstall_image required	boolean Set to `true` to reinstall image, or `false` to skip reinstalling image.

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

image_source	string Source of the ISO image to download. Valid values include `auto` and URLs. `auto` means download the image from Pure1 cloud, and a URL means download the image from the specified URL. Default value is `auto`.
image_version	string Version of the image to download. `image_version` is optional, and the default value is the current running Purity version. If `image_source` is `auto`, the image with the specified version will be downloaded from Pure1 cloud. If `image_source` is a URL, `image_version` will be used to compare to the downloaded image version for the purpose of validation.

Responses

Request samples

Payload

Content type

application/json

{"image_source": "auto",
"image_version": "6.6.6"
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"status": "resetting",
"image_source": "auto",
"image_version": "6.6.6",
"image_download_progress": 0.32,
"details": "string",
"sanitization_certificate": "string"
}
]
}

List End User Agreement and signature

Displays the End User Agreement and signature.

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.
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": [{"agreement": "string",
"signature": {"name": "John Doe",
"title": "Admin",
"company": "Example Inc.",
"accepted": 1577880000000
}
}
]
}

Modify signature on the End User Agreement

Modifies the signature on the End User Agreement.

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 (_eula_signature)

Responses

Request samples

Payload

Content type

application/json

{"signature": {"name": "John Doe",
"title": "Admin",
"company": "Example Inc."
}
}

Response samples

Content type

application/json

{"items": [{"agreement": "string",
"signature": {"name": "John Doe",
"title": "Admin",
"company": "Example Inc.",
"accepted": 1577880000000
}
}
]
}

List factory reset tokens

Displays a list of tokens used to perform a factory reset on 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.
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": "string",
"name": "string",
"token": 4671919
}
]
}

Create a factory reset token

Creates a token that can be used to perform a factory reset on the array. Factory reset tokens can only be created after the array has been prepared for reset (e.g., all volumes and snapshots must first be eradicated). After a token has been created, operations that would take the array out of the prepared state are disabled (e.g., creating volumes) until all tokens have been deleted.

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": [{"id": "string",
"name": "string",
"token": 4671919
}
]
}

Delete a factory reset token

Deletes an existing token that could be used to perform a factory reset on the array.

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 NTP test results

Displays test results for configured NTP servers.

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": [{"component_address": "10.230.94.21",
"component_name": "CT0",
"description": "Testing phonehome connectivity",
"destination": "ra.cloud-support.purestorage.com",
"enabled": true,
"result_details": "Timeout connecting to phonehome endpoint",
"success": true,
"test_type": "phonehome"
}
]
}

List array front-end performance data

Displays real-time and historical front-end performance data at the array level including latency, bandwidth, IOPS, average I/O size, and queue depth.

query Parameters

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.
protocol	string Protocol type. Valid values are `nfs`, `smb`, and `all`.
protocol_group	string Protocol group type. Valid values are `block`, `file`, and `all`.
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": [{"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,
"service_usec_per_read_op_cache_reduction": 0,
"id": "string",
"name": "string",
"queue_depth": 0,
"local_queue_usec_per_op": 0,
"usec_per_other_op": 0,
"others_per_sec": 0
}
]
}

List array front-end IO performance data by link

Displays real-time and historical front-end performance data at the array level including latency, bandwidth, IOPS, average I/O size, and queue depth. Group output is shown by link. A link represents a set of arrays that an I/O operation depends on. For local-only I/Os, this is a local array. For mirrored I/Os, this is a set of synchronous replication peer arrays.

query Parameters

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": [{"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,
"service_usec_per_read_op_cache_reduction": 0,
"id": "string",
"name": "string",
"queue_depth": 0,
"local_queue_usec_per_op": 0,
"usec_per_other_op": 0,
"others_per_sec": 0,
"link": [{"id": "string",
"name": "string"
}
]
}
]
}

List array space information

Displays real-time and historical array space information including unique volume and snapshot space, shared space, data reduction, provisioned capacity, usable capacity, and parity.

query Parameters

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": [{"id": "string",
"name": "string",
"capacity": 10995116277760,
"parity": 0.99,
"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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0,
"shared_effective": 0,
"snapshots_effective": 0,
"unique_effective": 0,
"total_effective": 0,
"replication": 0
},
"time": 0
}
]
}

List tags

Displays the list of tags on array objects.

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.
namespaces	Array of strings A comma-separated list of namespaces.
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": [{"copyable": true,
"key": "environment",
"namespace": "default",
"resource": {"id": "string",
"name": "string"
},
"value": "staging"
}
]
}

Delete tags

Deletes specified tags on array objects.

query Parameters

keys	Array of strings A comma-separated list of tag keys.
namespaces	Array of strings A comma-separated list of namespaces.

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

Update tags

Updates tags.

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

A list of tags to be created or, if already existing, updated.

Array ()

key	string Key of the tag. Supports up to 64 Unicode characters.
namespace	string Optional namespace of the tag. Namespace identifies the category of the tag. Omitting the namespace defaults to the namespace `default`. The `pure*` namespaces are reserved for plugins and integration partners. It is recommended that customers avoid using reserved namespaces.
	object (_fixedReference)
value	string Value of the tag. Supports up to 256 Unicode characters.

Responses

Request samples

Payload

Content type

application/json

[{"key": "environment",
"namespace": "default",
"resource": { },
"value": "staging"
}
]

Response samples

Content type

application/json

{"items": [{"copyable": true,
"key": "environment",
"namespace": "default",
"resource": {"id": "string",
"name": "string"
},
"value": "staging"
}
]
}

Array Connections

Manages connections between arrays.

List the connected arrays

Displays a list of connected arrays.

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": [{"id": "string",
"name": "string",
"management_address": "10.202.101.78",
"replication_addresses": ["10.202.101.70"
],
"status": "string",
"type": "string",
"replication_transport": "ip",
"version": "5.0.0",
"throttle": {"default_limit": 1073741824,
"window": {"start": 3600000,
"end": 46800000
},
"window_limit": 2097152
},
"encryption": "encrypted",
"encryption_mode": "TLS-PSK-AES-256"
}
]
}

Create an array connection

Creates a connection between this array and the specified array.

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

management_address	string Management IP address of the target array.
replication_addresses	Array of strings IP addresses and FQDNs of the target arrays. Configurable only when `replication_transport` is set to `ip`. If not configured, will be set to all the replication addresses available on the target array at the time of the POST.
type	string The type of replication. Valid values are `async-replication` and `sync-replication`.
replication_transport	string The protocol used to transport data between the local array and the remote array. Valid values are `ip` and `fc`. The default is `ip`.
connection_key	string The connection key of the target array.
encryption	string If `encrypted`, all traffic over this array connection will be encrypted. If `unencrypted`, all traffic over this array connection will be unencrypted. Defaults to `unencrypted`.

Responses

Request samples

Payload

Content type

application/json

{"management_address": "10.202.101.78",
"replication_addresses": ["10.202.101.70"
],
"type": "async-replication",
"replication_transport": "ip",
"connection_key": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
"encryption": "encrypted"
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"management_address": "10.202.101.78",
"replication_addresses": ["10.202.101.70"
],
"status": "string",
"type": "string",
"replication_transport": "ip",
"version": "5.0.0",
"throttle": {"default_limit": 1073741824,
"window": {"start": 3600000,
"end": 46800000
},
"window_limit": 2097152
},
"encryption": "encrypted",
"encryption_mode": "TLS-PSK-AES-256"
}
]
}

Delete an array connection

Deletes the connection between this array and the specified 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.

Responses

Modify an array connection

Modifies attributes for an array connection.

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`.
refresh	boolean If set to `true`, the array will attempt to communicate with the connection peer in order to update the connection attributes on both arrays with any changes that have occurred. If set to `true`, other array connection attributes may not be modified in requests. Default value is `false`.
renew_encryption_key	boolean If set to `true`, update array connection with a new encryption key. If set to `true`, other array connection attributes may not be modified in requests. 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.

Request Body schema: application/json

default_limit	integer <int64> Deprecated. Default maximum bandwidth threshold for outbound traffic in bytes. Once exceeded, bandwidth throttling occurs.
	object Deprecated. The time during which the `window_limit` threshold is in effect.
window_limit	integer <int64> Deprecated. Maximum bandwidth threshold for outbound traffic during the specified `window_limit` time range in bytes. Once exceeded, bandwidth throttling occurs.
management_address	string Management IP address of the target array.
replication_addresses	Array of strings IP addresses and FQDNs of the target arrays. Configurable only when `replication_transport` is set to `ip`.
type	string The type of replication. Valid values are `async-replication` and `sync-replication`.
connection_key	string The connection key of the target array. It is only required when `encryption` is changed from `unencrypted` to `encrypted`, or when `type` is changed from `async-replication` to `sync-replication`.
encryption	string If `encrypted`, encryption will be enabled for all traffic over this array connection. `connection_key` must be specified when encrypted is set to `true`. If `unencrypted`, encryption will be disabled for all traffic over this array connection. If not specified, the current encryption option for the array connection will remain unchanged.
	object (_throttle) The bandwidth throttling for an array connection. Configurable on PATCH only.

Responses

Request samples

Payload

Content type

application/json

{"default_limit": 1073741824,
"window": {"start": 3600000,
"end": 46800000
},
"window_limit": 2097152,
"management_address": "10.202.101.78",
"replication_addresses": ["10.202.101.70"
],
"type": "string",
"connection_key": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
"encryption": "encrypted",
"throttle": {"default_limit": 1073741824,
"window": {"start": 3600000,
"end": 46800000
},
"window_limit": 2097152
}
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"management_address": "10.202.101.78",
"replication_addresses": ["10.202.101.70"
],
"status": "string",
"type": "string",
"replication_transport": "ip",
"version": "5.0.0",
"throttle": {"default_limit": 1073741824,
"window": {"start": 3600000,
"end": 46800000
},
"window_limit": 2097152
},
"encryption": "encrypted",
"encryption_mode": "TLS-PSK-AES-256"
}
]
}

List connection key

Displays the connection key for the array.

query Parameters

encrypted

boolean

If true, the returned array connection key will encode an encryption key used to establish trust and secure replication traffic. If false, the returned array connection key will not encode an encryption key. 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": [{"connection_key": "6207d123-d123-0b5c-5fa1-95fabc5c7123"
}
]
}

List connection path

Displays the connection path from the array to which the connection was made.

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",
"local_port": "ct0.eth0",
"local_address": "10.202.101.70",
"remote_port": "ct1.eth0",
"remote_address": "10.202.101.78",
"status": "string",
"replication_transport": "string",
"encryption": "encrypted",
"encryption_mode": "TLS-PSK-AES-256"
}
]
}

Audits

Audit trail records describe administrative actions performed by a user to modify the configuration of an array.

List audits

Displays a list of audits.

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.
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": "string",
"name": "string",
"arguments": "--size 1G vol2",
"command": "purevol",
"subcommand": "create",
"time": 1577402821354,
"user": "pureuser",
"origin": {"id": "string",
"name": "string"
},
"user_interface": "CLI"
}
]
}

Certificates

Purity//FA creates a self-signed certificate and private key when you start the system for the first time. You can use the default certificate, change the certificate attributes, create a new self-signed certificate, or import an SSL certificate signed by a certificate authority.

List certificate attributes

Displays certificate attributes.

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",
"certificate": "string",
"common_name": "Pure Storage Inc.",
"country": "CA",
"email": "tcrisp@veridiandynamics.com",
"intermediate_certificate": "string",
"issued_by": "Symantec, Inc.",
"issued_to": "Pure Storage, Inc.",
"key_size": 2048,
"locality": "Toronto",
"organization": "Veridian Dynamics",
"organizational_unit": "Research & Development",
"state": "Ontario",
"status": "string",
"valid_from": 1491070899,
"valid_to": 1524248499
}
]
}

Create certificate

Creates a certificate object and specifies the valid time period and organization details of the certificate. A certificate can be imported or manually configured.

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

certificate	string The text of the certificate.
common_name	string The common name field listed in the certificate.
country	string Two-letter country (ISO) code listed in the certificate.
email	string The email field listed in the certificate.
intermediate_certificate	string The text of the intermediate certificate chains.
key_size	integer <int32> The size of the private key for the certificate in bits. Default is 2048 bits.
locality	string The locality field listed in the certificate.
organization	string The organization field listed in the certificate.
organizational_unit	string The organizational unit field listed in the certificate.
state	string The state/province field listed in the certificate.
days	integer <int32> The number of days that the self-signed certificate is valid. If not specified, defaults to 3650.
key	string The text of private key.
passphrase	string The passphrase used to encrypt `private_key`.

Responses

Request samples

Payload

Content type

application/json

{"certificate": "string",
"common_name": "Pure Storage Inc.",
"country": "CA",
"email": "tcrisp@veridiandynamics.com",
"intermediate_certificate": "string",
"key_size": 2048,
"locality": "Toronto",
"organization": "Veridian Dynamics",
"organizational_unit": "Research & Development",
"state": "Ontario",
"days": 3650,
"key": "string",
"passphrase": "string"
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"certificate": "string",
"common_name": "Pure Storage Inc.",
"country": "CA",
"email": "tcrisp@veridiandynamics.com",
"intermediate_certificate": "string",
"issued_by": "Symantec, Inc.",
"issued_to": "Pure Storage, Inc.",
"key_size": 2048,
"locality": "Toronto",
"organization": "Veridian Dynamics",
"organizational_unit": "Research & Development",
"state": "Ontario",
"status": "string",
"valid_from": 1491070899,
"valid_to": 1524248499
}
]
}

Delete certificate

Deletes a specific certificate object.

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

Modify certificates

Modifies certificate attributes. When you modify the attributes of a self-signed certificate, Purity//FA replaces the existing certificate with a new certificate, which is generated with the specified attributes.

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`.
generate_new_key	boolean If set to `true`, a new private key is generated when generating a new certificate with the specified attributes. This may not be set to `true` when importing a certificate and private key, and may not be set to `false` when generating a new self-signed certificate to replace a certificate that was imported. Default setting is `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.

Request Body schema: application/json

certificate	string The text of the certificate.
common_name	string The common name field listed in the certificate.
country	string Two-letter country (ISO) code listed in the certificate.
email	string The email field listed in the certificate.
intermediate_certificate	string The text of the intermediate certificate chains.
key_size	integer <int32> The size of the private key for the certificate in bits. Default is 2048 bits.
locality	string The locality field listed in the certificate.
organization	string The organization field listed in the certificate.
organizational_unit	string The organizational unit field listed in the certificate.
state	string The state/province field listed in the certificate.
days	integer <int32> The number of days that the self-signed certificate is valid. If not specified, defaults to 3650.
key	string The text of private key.
passphrase	string The passphrase used to encrypt `private_key`.

Responses

Request samples

Payload

Content type

application/json

{"certificate": "string",
"common_name": "Pure Storage Inc.",
"country": "CA",
"email": "tcrisp@veridiandynamics.com",
"intermediate_certificate": "string",
"key_size": 2048,
"locality": "Toronto",
"organization": "Veridian Dynamics",
"organizational_unit": "Research & Development",
"state": "Ontario",
"days": 3650,
"key": "string",
"passphrase": "string"
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"certificate": "string",
"common_name": "Pure Storage Inc.",
"country": "CA",
"email": "tcrisp@veridiandynamics.com",
"intermediate_certificate": "string",
"issued_by": "Symantec, Inc.",
"issued_to": "Pure Storage, Inc.",
"key_size": 2048,
"locality": "Toronto",
"organization": "Veridian Dynamics",
"organizational_unit": "Research & Development",
"state": "Ontario",
"status": "string",
"valid_from": 1491070899,
"valid_to": 1524248499
}
]
}

List certificates/certificate-groups

Displays membership associations between groups and certificates.

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.
certificate_group_ids	Array of strings A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of `certificate_group_ids`, then an error is returned. This cannot be provided in conjunction with the `certificate_group_names` parameter.
certificate_group_names	Array of strings A comma-separated list of certificate group names. If no resource matches each of the elements of `certificate_group_names`, then an error is returned. This cannot be provided in conjunction with the `certificate_group_ids` parameter.
certificate_names	Array of strings The names of one or more certificates. Enter multiple names in comma-separated format. For example, `cert01,cert02`.
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.
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",
"resource_type": "string"
},
"member": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

Create certificates/certificate-groups

Creates one or more certificates to one or more certificate groups.

query Parameters

certificate_group_ids	Array of strings A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of `certificate_group_ids`, then an error is returned. This cannot be provided in conjunction with the `certificate_group_names` parameter.
certificate_group_names	Array of strings A comma-separated list of certificate group names. If no resource matches each of the elements of `certificate_group_names`, then an error is returned. This cannot be provided in conjunction with the `certificate_group_ids` parameter.
certificate_names	Array of strings The names of one or more certificates. Enter multiple names in comma-separated format. For example, `cert01,cert02`.

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",
"resource_type": "string"
},
"member": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

Delete certificates/certificate-groups

Deletes one or more certificates from one or more certificate groups.

query Parameters

certificate_group_ids	Array of strings A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of `certificate_group_ids`, then an error is returned. This cannot be provided in conjunction with the `certificate_group_names` parameter.
certificate_group_names	Array of strings A comma-separated list of certificate group names. If no resource matches each of the elements of `certificate_group_names`, then an error is returned. This cannot be provided in conjunction with the `certificate_group_ids` parameter.
certificate_names	Array of strings The names of one or more certificates. Enter multiple names in comma-separated format. For example, `cert01,cert02`.

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

Create certificate signing request

Creates a certificate signing request based on the certificate type and parameters.

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 (_referenceNoId)
common_name	string The common name field listed in the certificate.
country	string Two-letter country (ISO) code listed in the certificate.
email	string The email field listed in the certificate.
locality	string The locality field listed in the certificate.
organization	string The organization field listed in the certificate.
organizational_unit	string The organizational unit field listed in the certificate.
state	string The state/province field listed in the certificate.

Responses

Request samples

Payload

Content type

application/json

{"certificate": {"name": "string"
},
"common_name": "Pure Storage Inc.",
"country": "CA",
"email": "tcrisp@veridiandynamics.com",
"locality": "Toronto",
"organization": "Veridian Dynamics",
"organizational_unit": "Research & Development",
"state": "Ontario"
}

Response samples

Content type

application/json

{"items": [{"certificate_signing_request": "string"
}
]
}

Certificate Groups

Certificate groups, also known as certificate bundles, are collections of digital certificates. Each certificate can belong to one or more groups in order to serve different purposes.

List certificate-groups

Display all array certificate 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.
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": "string",
"name": "string"
}
]
}

Create certificate-groups

Creates one or more certificate groups on the 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.

Responses

Response samples

Content type

application/json

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

Delete certificate-groups

Deletes one or more certificate groups from the array.

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

List certificate-groups/certificates

Displays membership associations between groups and certificates on the 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.
certificate_group_ids	Array of strings A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of `certificate_group_ids`, then an error is returned. This cannot be provided in conjunction with the `certificate_group_names` parameter.
certificate_group_names	Array of strings A comma-separated list of certificate group names. If no resource matches each of the elements of `certificate_group_names`, then an error is returned. This cannot be provided in conjunction with the `certificate_group_ids` parameter.
certificate_names	Array of strings The names of one or more certificates. Enter multiple names in comma-separated format. For example, `cert01,cert02`.
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.
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",
"resource_type": "string"
},
"member": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

Create certificate-groups/certificates

Creates one or more certificates to one or more certificate groups on the array.

query Parameters

certificate_group_ids	Array of strings A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of `certificate_group_ids`, then an error is returned. This cannot be provided in conjunction with the `certificate_group_names` parameter.
certificate_group_names	Array of strings A comma-separated list of certificate group names. If no resource matches each of the elements of `certificate_group_names`, then an error is returned. This cannot be provided in conjunction with the `certificate_group_ids` parameter.
certificate_names	Array of strings The names of one or more certificates. Enter multiple names in comma-separated format. For example, `cert01,cert02`.

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",
"resource_type": "string"
},
"member": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

Delete certificate-groups/certificates

Deletes one or more certificate groups.

query Parameters

certificate_group_ids	Array of strings A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of `certificate_group_ids`, then an error is returned. This cannot be provided in conjunction with the `certificate_group_names` parameter.
certificate_group_names	Array of strings A comma-separated list of certificate group names. If no resource matches each of the elements of `certificate_group_names`, then an error is returned. This cannot be provided in conjunction with the `certificate_group_ids` parameter.
certificate_names	Array of strings The names of one or more certificates. Enter multiple names in comma-separated format. For example, `cert01,cert02`.

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

Connections

A connection gives hosts access to volumes on the array.

List volume connections

Displays a list of connections between a volume and its hosts and host groups, as well as the logical unit numbers (LUNs) or NVMe Namespace IDs (NSIDs) 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_ids	Array of strings Performs the operation on the protocol endpoints specified. Enter multiple IDs in comma-separated format. For example, `peid01,peid02`. A request cannot include a mix of multiple objects with multiple IDs. For example, a request cannot include a mix of multiple protocol endpoint IDs and host names. Instead, at least one of the objects (e.g., `protocol_endpoint_ids`) must be set to one ID (e.g., `peid01`).
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`).
volume_ids	Array of strings Performs the operation on the specified volume. Enter multiple ids in comma-separated format. For example, `vol01id,vol02id`. A request cannot include a mix of multiple objects with multiple IDs. For example, a request cannot include a mix of multiple volume IDs and host names; instead, at least one of the objects (e.g., `volume_ids`) must be set to only one name (e.g., `vol01id`). Only one of the two between `volume_names` and `volume_ids` may be used at a time.

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

Create a connection between a volume and host or host group

Creates a connection between a volume and a host or host group. One of volume_names or volume_ids and one of 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`).
volume_ids	Array of strings Performs the operation on the specified volume. Enter multiple ids in comma-separated format. For example, `vol01id,vol02id`. A request cannot include a mix of multiple objects with multiple IDs. For example, a request cannot include a mix of multiple volume IDs and host names; instead, at least one of the objects (e.g., `volume_ids`) must be set to only one name (e.g., `vol01id`). Only one of the two between `volume_names` and `volume_ids` may be used at a time.

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. Should not be used together with an NVMe host or host group.

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

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

Deletes the connection between a volume and its associated host or host group. One of volume_names or volume_ids and one of 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`).
volume_ids	Array of strings Performs the operation on the specified volume. Enter multiple ids in comma-separated format. For example, `vol01id,vol02id`. A request cannot include a mix of multiple objects with multiple IDs. For example, a request cannot include a mix of multiple volume IDs and host names; instead, at least one of the objects (e.g., `volume_ids`) must be set to only one name (e.g., `vol01id`). Only one of the two between `volume_names` and `volume_ids` may be used at a time.

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

Container Default Protections

Default protection is a list of protection groups that are applied to newly created volumes. Volumes can opt out of the default protection at creation. The pod's default_protections defaults to the array's default_protections at pod creation. Default protection can be configured on the array and the pod.

List container default protections

Displays a list of containers with its default protections.

query Parameters

ids	Array of strings Performs the operation on the container ID specified. Enter multiple source IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together. Specifying `ids` or `names` with no value will perform the operation on local array.
names	Array of strings Performs the operation on the unique container name specified. Enter multiple names in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together. Specifying `ids` or `names` with no value will perform the operation on local array.
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.
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": "string",
"name": "string",
"type": "string",
"default_protections": [{"id": "string",
"name": "string",
"type": "protection_group"
}
]
}
]
}

Modify a container's default protections

Modifies a container's default protections. To modify, set default_protections to the new list.

query Parameters

ids	Array of strings Performs the operation on the container ID specified. Enter multiple source IDs in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together. Specifying `ids` or `names` with no value will perform the operation on local array.
names	Array of strings Performs the operation on the unique container name specified. Enter multiple names in comma-separated format. The `ids` or `names` parameter is required, but they cannot be set together. Specifying `ids` or `names` with no value will perform the operation on local array.

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

Array of objects (_default_protection_reference)

The default protection that is applied to newly created volumes. Volumes can opt out of the default protection at creation. The pod's default_protections defaults to the array's default_protections at pod creation. To clear the list of default protections, set to an empty list [].

Responses

Request samples

Payload

Content type

application/json

{"default_protections": [{"id": "string",
"name": "string",
"type": "protection_group"
}
]
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"type": "string",
"default_protections": [{"id": "string",
"name": "string",
"type": "protection_group"
}
]
}
]
}

Controllers

Controller data includes the name, mode, FlashArray model, Purity//FA software version, and status of each controller in the array.

List controller information and status

Displays the name, mode, FlashArray model, Purity//FA software version, and status of each controller in the 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.
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",
"mode": "primary",
"model": "FA-m50",
"status": "ready",
"type": "string",
"version": "5.0.0",
"mode_since": 1687086901996
}
]
}

Directories

Important file system directories should be set up as managed directories. Managed directories can have policies attached to them. Managed directories differ from standard directories in that they provide space reporting and metrics.

List directories

Displays a list of directories, 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.
file_system_ids	Array of strings Performs the operation on the file system ID specified. Enter multiple file system IDs in comma-separated format. The `file_system_ids` or `file_system_names` parameter is required, but they cannot be set together.
file_system_names	Array of strings Performs the operation on the file system name specified. Enter multiple file system names in comma-separated format. For example, `filesystem01,filesystem02`.
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",
"created": 0,
"destroyed": true,
"directory_name": "string",
"file_system": {"id": "string",
"name": "string"
},
"path": "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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0
},
"time_remaining": 0,
"limited_by": {"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
}
],
"total": [{"id": "string",
"name": "string",
"created": 0,
"destroyed": true,
"directory_name": "string",
"file_system": {"id": "string",
"name": "string"
},
"path": "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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0
},
"time_remaining": 0,
"limited_by": {"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
}
]
}

Create directory

Creates a managed directory at the specified path. The managed directory name must consist of a file system name prefix and a managed directory name suffix (separated with ':'). The suffix must be between 1 and 63 characters (alphanumeric and '-') in length and begin and end with a letter or number. The suffix must include at least one letter or '-'. Set names to create a managed directory with the specified full managed directory name, or set file_system_names or file_system_ids in the query parameters and suffix in the body parameters to create a managed directory in the specified file system with the specified suffix. These two options are exclusive.

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`.
file_system_names	Array of strings Performs the operation on the file system name specified. Enter multiple file system names in comma-separated format. For example, `filesystem01,filesystem02`.
file_system_ids	Array of strings Performs the operation on the file system ID specified. Enter multiple file system IDs in comma-separated format. The `file_system_ids` or `file_system_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.

Request Body schema: application/json

directory_name	string The managed directory name without the file system name prefix. A full managed directory name is constructed in the form of `FILE_SYSTEM:DIR` where `FILE_SYSTEM` is the file system name and `DIR` is the value of this field. `directory_name` is required if `file_system_names` or `file_system_ids` is set. `directory_name` cannot be set if `names` is set.
path	string Path of the managed directory in the file system.

Responses

Request samples

Payload

Content type

application/json

{"directory_name": "string",
"path": "string"
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"created": 0,
"destroyed": true,
"directory_name": "string",
"file_system": {"id": "string",
"name": "string"
},
"path": "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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0
},
"time_remaining": 0,
"limited_by": {"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
}
]
}

Delete managed directories

Deletes one or more managed directories. To be deleted, a managed directory must be empty and not attached to any enabled export policies. Deleted managed directories cannot be recovered. The ids or names parameter is required, but 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

Modify a managed directory

Modifies a managed directory. To rename a managed directory, set name to the new name. The ids or names parameter is required, but cannot be set together. The name or directory_name parameter is required.

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 The new name for the resource.
directory_name	string The managed directory name without the file system name prefix. A full managed directory name is constructed in the form of `FILE_SYSTEM:DIR` where `FILE_SYSTEM` is the file system name and `DIR` is the value of this field.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"directory_name": "string"
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"created": 0,
"destroyed": true,
"directory_name": "string",
"file_system": {"id": "string",
"name": "string"
},
"path": "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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0
},
"time_remaining": 0,
"limited_by": {"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
}
]
}

List directory performance data

Displays real-time and historical performance data, real-time latency data, and average I/O sizes for each directory and as a total of all directories 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.
protocol	string Protocol type. Valid values are `nfs`, `smb`, and `all`.
protocol_group	string Protocol group type. Valid values are `block`, `file`, and `all`.
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_op": 0,
"bytes_per_read": 0,
"bytes_per_write": 0,
"others_per_sec": 0,
"read_bytes_per_sec": 0,
"reads_per_sec": 0,
"time": 0,
"usec_per_other_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_op": 0,
"bytes_per_read": 0,
"bytes_per_write": 0,
"others_per_sec": 0,
"read_bytes_per_sec": 0,
"reads_per_sec": 0,
"time": 0,
"usec_per_other_op": 0,
"usec_per_read_op": 0,
"usec_per_write_op": 0,
"write_bytes_per_sec": 0,
"writes_per_sec": 0
}
]
}

List policies

Displays a list of policies that are attached to directories.

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.
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.
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`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0
}
]
}

List audit policies attached to a directory

Displays a list of audit policies that are attached to directories.

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.
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.
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`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0
}
]
}

Create a membership between a directory and one or more audit policies

Creates a membership between a directory and one or more audit policies. Either the member_ids or member_names parameter is required, but they cannot be set together.

query Parameters

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.
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

Array of objects (_directorypolicypostPolicies)

A list of policies to apply to the resource. The id or name field in each policy parameter is required, but they cannot be set together.

Responses

Request samples

Payload

Content type

application/json

{"policies": [{"policy": {"id": "string",
"name": "string"
}
}
]
}

Response samples

Content type

application/json

{"items": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0
}
]
}

Delete a membership between a directory and one or more audit policies

Deletes a membership between a directory and one or more audit policies. Either the policy_ids or policy_names parameter is required, but they cannot be set together. Either the member_ids or member_names parameter is required, but they cannot be set together.

query Parameters

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.
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`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

List auto managed directory policies attached to a directory

Displays a list of auto managed directory policies that are attached to directories.

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.
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.
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`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0
}
]
}

Create a membership between a directory with one or more auto managed directory policies

Creates a membership between a directory with one or more auto managed directory policies. The member_ids or member_names parameter is required, but they cannot be set together.

query Parameters

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.
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

Array of objects (_directorypolicypostPolicies)

A list of policies to apply to the resource. The id or name field in each policy parameter is required, but they cannot be set together.

Responses

Request samples

Payload

Content type

application/json

{"policies": [{"policy": {"id": "string",
"name": "string"
}
}
]
}

Response samples

Content type

application/json

{"items": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0
}
]
}

Delete a membership between a directory and one or more auto managed directory policies

Deletes a membership between a directory with one or more auto managed directory policies. The policy_ids or policy_names parameter is required, but they cannot be set together. The member_ids or member_names parameter is required, but they cannot be set together.

query Parameters

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.
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`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

List NFS policies attached to a directory

Displays a list of NFS policies that are attached to directories.

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.
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.
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`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0,
"export_name": "string",
"status": "string"
}
]
}

Create a membership between a directory and one or more NFS policies

Creates a membership between a directory and one or more NFS policies. The member_ids or member_names parameter is required but cannot be set together.

query Parameters

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.
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

Array of objects (_directorypolicyexportpostPolicies)

A list of export policies to apply to the directory. The id and name fields in each policy parameter are required, but cannot be set together.

Responses

Request samples

Payload

Content type

application/json

{"policies": [{"policy": {"id": "string",
"name": "string"
},
"export_enabled": false,
"export_name": "string"
}
]
}

Response samples

Content type

application/json

{"items": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0,
"export_name": "string",
"status": "string"
}
]
}

Delete a membership between a directory and one or more NFS policies

Deletes a membership between a directory and one or more NFS policies. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

query Parameters

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.
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`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

List quota policies attached to a directory

Displays a list of quota policies that are attached to directories.

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.
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.
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`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0
}
]
}

Create a membership between a directory and one or more quota policies

Creates a membership between a directory and one or more quota policies. The member_ids or member_names parameter is required, but cannot be set together.

query Parameters

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.
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`.
ignore_usage	boolean Flag used to override checks for quota management operations. If set to `true`, directory usage is not checked against the `quota_limits` that are set. If set to `false`, the actual logical bytes in use are prevented from exceeding the limits set on the directory. Client operations might be impacted. If the limit exceeds the quota, the client operation is not allowed. 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.

Request Body schema: application/json

Array of objects (_directorypolicypostPolicies)

A list of policies to apply to the resource. The id or name field in each policy parameter is required, but they cannot be set together.

Responses

Request samples

Payload

Content type

application/json

{"policies": [{"policy": {"id": "string",
"name": "string"
}
}
]
}

Response samples

Content type

application/json

{"items": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0
}
]
}

Delete a membership between a directory and one or more quota policies

Deletes a membership between a directory and one or more quota policies. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

query Parameters

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.
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`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

List SMB policies attached to a directory

Displays a list of SMB policies that are attached to directories.

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.
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.
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`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0,
"export_name": "string",
"status": "string"
}
]
}

Create a membership between a directory and one or more SMB policies

Creates a membership between a directory and one or more SMB policies. The member_ids or member_names parameter is required, but cannot be set together.

query Parameters

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.
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

Array of objects (_directorypolicyexportpostPolicies)

A list of export policies to apply to the directory. The id and name fields in each policy parameter are required, but cannot be set together.

Responses

Request samples

Payload

Content type

application/json

{"policies": [{"policy": {"id": "string",
"name": "string"
},
"export_enabled": false,
"export_name": "string"
}
]
}

Response samples

Content type

application/json

{"items": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0,
"export_name": "string",
"status": "string"
}
]
}

Delete a membership between a directory and one or more SMB policies

Deletes a membership between a directory and one or more SMB policies. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

query Parameters

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.
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`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

List snapshot policies attached to a directory

Displays a list of snapshot policies that are attached to directories.

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.
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.
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`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0
}
]
}

Create a membership between a directory with one or more snapshot policies

Creates a membership between a directory with one or more snapshot policies. The member_ids or member_names parameter is required, but cannot be set together.

query Parameters

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.
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

Array of objects (_directorypolicypostPolicies)

A list of policies to apply to the resource. The id or name field in each policy parameter is required, but they cannot be set together.

Responses

Request samples

Payload

Content type

application/json

{"policies": [{"policy": {"id": "string",
"name": "string"
}
}
]
}

Response samples

Content type

application/json

{"items": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0
}
]
}

Delete a membership between a directory and one or more snapshot policies

Deletes a membership between a directory and one or more snapshot policies. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

query Parameters

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.
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`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

List directory space information

Displays physical storage consumption data for each directory.

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",
"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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0
},
"time": 0
}
]
}

Initiate NLM reclamation.

NLM reclamation is a system-wide operation, affecting all clients, and so only one may be in progress at a time. Attempting to initiate reclamation while one is in progress will result in an error. When NLM reclamation is initiated, all NLM locks are deleted and client applications are notified that they can reacquire their locks within a grace period.

header Parameters

X-Request-ID

string

Supplied by client during request or generated by server.

Responses

Response samples

Content type

application/json

{"items": [{"start": 0,
"end": 0
}
]
}

Directory Exports

Managed directory exports are created by adding NFS or SMB export policies to managed directories.

List directory exports

Displays a list of directory exports.

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.
directory_ids	Array of strings Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The `directory_ids` or `directory_names` parameter is required, but they cannot be set together.
directory_names	Array of strings Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. For example, `fs:dir01,fs:dir02`.
export_names	Array of strings Performs the operation on the export names specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
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.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.
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": [{"enabled": true,
"export_name": "string",
"status": "string",
"destroyed": true,
"directory": {"id": "string",
"name": "string",
"resource_type": "string"
},
"path": "string",
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

Create directory exports

Creates an export of a managed directory. The directory_ids or directory_names parameter is required, but cannot be set together. The policy_ids or policy_names parameter is required, but cannot be set together.

query Parameters

directory_ids	Array of strings Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The `directory_ids` or `directory_names` parameter is required, but they cannot be set together.
directory_names	Array of strings Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. For example, `fs:dir01,fs:dir02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

export_name	string The name of the export to create. Export names must be unique within the same protocol.
export_enabled	boolean If set to `true`, the export is enabled. If not specified, defaults to `true`.

Responses

Request samples

Payload

Content type

application/json

{"export_name": "string",
"export_enabled": false
}

Response samples

Content type

application/json

{"items": [{"enabled": true,
"export_name": "string",
"status": "string",
"destroyed": true,
"directory": {"id": "string",
"name": "string",
"resource_type": "string"
},
"path": "string",
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

Delete directory exports

Deletes one or more directory exports. If any of the export_names is not unique across the system, policy_ids or policy_names must be specified to determine the exports.

query Parameters

directory_ids	Array of strings Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The `directory_ids` or `directory_names` parameter is required, but they cannot be set together.
directory_names	Array of strings Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. For example, `fs:dir01,fs:dir02`.
export_names	Array of strings Performs the operation on the export names specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

Modify directory exports

Modifies a directory export. Used for manually renaming, enabling, and disabling directory exports. To rename a directory export, set 'export_name' to the new name.

query Parameters

directory_ids	Array of strings Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The `directory_ids` or `directory_names` parameter is required, but they cannot be set together.
directory_names	Array of strings Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. For example, `fs:dir01,fs:dir02`.
export_names	Array of strings Performs the operation on the export names specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

export_enabled	boolean If set to `true`, the export is enabled. If not specified, defaults to `true`.
export_name	string The new name of the export. Export names must be unique within the same protocol.

Responses

Request samples

Payload

Content type

application/json

{"export_enabled": false,
"export_name": "string"
}

Response samples

Content type

application/json

{"items": [{"enabled": true,
"export_name": "string",
"status": "string",
"destroyed": true,
"directory": {"id": "string",
"name": "string",
"resource_type": "string"
},
"path": "string",
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

Directory Quotas

Directory quotas provide the ability to set capacity limits on managed directories.

List directories with attached quota policies

Displays a list of directories and the quota policies attached to them. Directories with multiple policies are listed repeatedly (once per policy). The directories without a policy attached are not listed.

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.
directory_ids	Array of strings Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The `directory_ids` or `directory_names` parameter is required, but they cannot be set together.
directory_names	Array of strings Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. For example, `fs:dir01,fs:dir02`.
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.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.
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": [{"directory": {"id": "string",
"name": "string",
"resource_type": "string"
},
"enabled": true,
"enforced": true,
"quota_limit": 0,
"path": "string",
"percentage_used": 0,
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"rule_name": "string",
"usage": 0
}
]
}

Directory Services

Manages directory service configurations for integration with LDAP servers (e.g. Active Directory and OpenLDAP) in order to support various array services.

List directory services configuration

Displays the directory services configuration settings for manageability.

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",
"base_dn": "DC=mycompany,DC=com",
"bind_password": "****",
"bind_user": "CN=John,OU=Users,DC=example,DC=com",
"ca_certificate": "string",
"check_peer": false,
"enabled": true,
"services": ["data",
"management"
],
"uris": ["ldaps://ad1.mycompany.com"
],
"management": {"user_login_attribute": "email",
"user_object_class": "inetOrgPerson",
"ssh_public_key_attribute": "sshPublicKey"
}
}
]
}

Modify directory services configuration

Modifies the directory service configuration.

query Parameters

names

required

Array of strings

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

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

base_dn	string Base of the Distinguished Name (DN) of the directory service groups.
bind_password	string Masked password used to query the directory.
bind_user	string Username used to query the directory.
ca_certificate	string The certificate of the Certificate Authority (CA) that signed the certificates of the directory servers, which is used to validate the authenticity of the configured servers.
check_peer	boolean Whether or not server authenticity is enforced when a certificate is provided.
enabled	boolean Whether or not the directory service is enabled.
uris	Array of strings List of URIs for the configured directory servers.
	object (_directoryServiceManagement) Properties specific to the management service.

Responses

Request samples

Payload

Content type

application/json

{"base_dn": "DC=mycompany,DC=com",
"bind_password": "****",
"bind_user": "CN=John,OU=Users,DC=example,DC=com",
"ca_certificate": "string",
"check_peer": false,
"enabled": true,
"uris": ["ldaps://ad1.mycompany.com"
],
"management": {"user_login_attribute": "email",
"user_object_class": "inetOrgPerson",
"ssh_public_key_attribute": "sshPublicKey"
}
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"base_dn": "DC=mycompany,DC=com",
"bind_password": "****",
"bind_user": "CN=John,OU=Users,DC=example,DC=com",
"ca_certificate": "string",
"check_peer": false,
"enabled": true,
"services": ["data",
"management"
],
"uris": ["ldaps://ad1.mycompany.com"
],
"management": {"user_login_attribute": "email",
"user_object_class": "inetOrgPerson",
"ssh_public_key_attribute": "sshPublicKey"
}
}
]
}

List group to management access policy mappings

Displays access control settings for remote 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.
names	Array of strings Performs the operation on the unique names specified. For example, `GroupRoleMappingName`. Enter multiple names in comma-separated format.
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.
role_names	Array of strings This field has been deprecated.
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",
"role": {"name": "string"
},
"management_access_policies": [{"id": "string",
"name": "string",
"resource_type": "string"
}
],
"group": "groupOfUsers",
"group_base": "OU=PureGroups,OU=SANManagers"
}
]
}

Create a group in management access policy mappings

Creates one or more groups in management access policy mappings.

query Parameters

names

required

Array of strings

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

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 This field has been deprecated. Predecessor to management access policies. Can be set to the premade policy of the same name. Cannot be set with management_access_policies.
	Array of objects (_referenceWithType) List of management access policies to associate with the group.
group	string Group name that contains users with the abilities granted by the associated policies.
group_base	string Specifies where the configured group is located in the directory tree.

Responses

Request samples

Payload

Content type

application/json

{"role": {"name": "string"
},
"management_access_policies": [{"id": "string",
"name": "string",
"resource_type": "string"
}
],
"group": "groupOfUsers",
"group_base": "OU=PureGroups,OU=SANManagers"
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"role": {"name": "string"
},
"management_access_policies": [{"id": "string",
"name": "string",
"resource_type": "string"
}
],
"group": "groupOfUsers",
"group_base": "OU=PureGroups,OU=SANManagers"
}
]
}

Delete group to management access policy mappings

Deletes one or more group to management access policy mappings.

query Parameters

names

required

Array of strings

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

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

Modify group to management access policy mappings

Modifies properties of one or more group to management access policy mappings. Modifying management access policies is done at /directory-services/roles/policies/management-access instead.

query Parameters

role_names	Array of strings This field has been deprecated.
names required	Array of strings Performs the operation on the unique names specified. For example, `GroupRoleMappingName`. Enter multiple names in comma-separated format.

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 This field has been deprecated. Predecessor to management access policies.
group	string Group name that contains users with the abilities granted by the associated policies.
group_base	string Specifies where the configured group is located in the directory tree.

Responses

Request samples

Payload

Content type

application/json

{"role": {"name": "string"
},
"group": "groupOfUsers",
"group_base": "OU=PureGroups,OU=SANManagers"
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"role": {"name": "string"
},
"management_access_policies": [{"id": "string",
"name": "string",
"resource_type": "string"
}
],
"group": "groupOfUsers",
"group_base": "OU=PureGroups,OU=SANManagers"
}
]
}

List management access policies attached to a group to management access policy mapping

Displays a list of management access policies that are attached to group to management access policy mappings.

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.
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.
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`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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": [{"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

Create a membership between a group to management access policy mapping with one or more management access policies

Creates a membership between a group to management access policy mapping with one or more management access policies. The member_ids or member_names parameter is required, but they cannot be set together.

query Parameters

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.
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

Array of objects (PolicyAssignmentPostPolicy)

A list of policies to apply to the resource. One of id or name is required in each policy.

Responses

Request samples

Payload

Content type

application/json

{"policies": [{"policy": {"id": "string",
"name": "string"
}
}
]
}

Response samples

Content type

application/json

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

Delete a membership between a group to management access policy mapping and one or more management access policies

Deletes a membership between a group to management access policy mapping with one or more management access policies. The policy_ids or policy_names is required, but they cannot be set together. Also, member_ids or member_names is required, but they cannot be set together.

query Parameters

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.
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`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

List directory services test results

Displays the directory services test and displays the results. The test verifies that URIs can be resolved and that the array can bind and query the tree using the bind user credentials. The test also verifies that the array can find all configured groups to ensure the common names and group base are correctly configured.

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 required	Array of strings Performs the operation on the unique name specified. For example, `name01`. Enter multiple names in comma-separated format.
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": [{"component_address": "10.230.94.21",
"component_name": "CT0",
"description": "Testing phonehome connectivity",
"destination": "ra.cloud-support.purestorage.com",
"enabled": true,
"result_details": "Timeout connecting to phonehome endpoint",
"success": true,
"test_type": "phonehome",
"resource": {"name": "string"
}
}
]
}

List local groups

Displays a list of local 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.
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.
gids	Array of integers <int32> Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, `4234235,9681923`.
sids	Array of strings Performs the operation on the object SID specified. Enter multiple SIDs in comma-separated format. For example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
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.
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": [{"built_in": true,
"email": "string",
"gid": 0,
"name": "string",
"sid": "string"
}
]
}

Create local group

Creates a local group.

query Parameters

names

required

Array of strings

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

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

email	string Optional field to set the email address of the local group.
gid	integer <int32> Optional field to set the GID of the local group.

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"gid": 0
}

Response samples

Content type

application/json

{"items": [{"built_in": true,
"email": "string",
"gid": 0,
"name": "string",
"sid": "string"
}
]
}

Delete local groups

Deletes one or more local groups. The gids, names, or sids parameter is required, but 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`.
sids	Array of strings Performs the operation on the object SID specified. Enter multiple SIDs in comma-separated format. For example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.
gids	Array of integers <int32> Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, `4234235,9681923`.

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

Modify local groups

Modifies local groups.

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`.
sids	Array of strings Performs the operation on the object SID specified. Enter multiple SIDs in comma-separated format. For example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.
gids	Array of integers <int32> Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, `4234235,9681923`.

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

email	string The email address of the local group.
gid	integer <int32> The POSIX user ID of this object (group ID).
name	string The local group name.

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"gid": 0,
"name": "string"
}

Response samples

Content type

application/json

{"items": [{"built_in": true,
"email": "string",
"gid": 0,
"name": "string",
"sid": "string"
}
]
}

List local group memberships

Displays a list of local group memberships.

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.
group_names	Array of strings Performs the operation on the group names specified. Enter multiple group names in comma-separated format. For example, `group1,group2`.
group_sids	Array of strings Performs the operation on the specified group SID. Enter multiple group SIDs in comma-separated format. For example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.
group_gids	Array of integers <int32> Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, `4234235,9681923`.
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_sids	Array of strings Performs the operation on the specified member SID. Enter multiple member SIDs in comma-separated format. For example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.
member_ids	Array of integers <int32> Performs the operation on the unique local member IDs specified. Enter multiple member IDs in comma-separated format. For local group IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). The `member_ids` and `member_names` parameters cannot be provided together.
member_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
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.
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",
"resource_type": "string"
},
"group_gid": 0,
"is_primary_group": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"member_id": 0
}
]
}

Create local group membership

Creates a local group membership with a group. The group_names, group_sids, or group_ids parameter is required, but cannot be set together.

query Parameters

group_names	Array of strings Performs the operation on the group names specified. Enter multiple group names in comma-separated format. For example, `group1,group2`.
group_sids	Array of strings Performs the operation on the specified group SID. Enter multiple group SIDs in comma-separated format. For example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.
group_gids	Array of integers <int32> Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, `4234235,9681923`.

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

The member_names, member_sids, or member_gids parameter is required, but cannot be set together.

Array of objects (_localgroupmembershippostMembers)

A list of resources to be a member of the group.

Responses

Request samples

Payload

Content type

application/json

{"members": [{"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"member_id": 0
}
]
}

Response samples

Content type

application/json

{"items": [{"group": {"id": "string",
"name": "string",
"resource_type": "string"
},
"group_gid": 0,
"is_primary_group": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"member_id": 0
}
]
}

Delete local group membership

Deletes one or more local group memberships. The group_names, group_sids, or group_ids parameter is required, but cannot be set together.

query Parameters

group_names	Array of strings Performs the operation on the group names specified. Enter multiple group names in comma-separated format. For example, `group1,group2`.
group_sids	Array of strings Performs the operation on the specified group SID. Enter multiple group SIDs in comma-separated format. For example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.
group_gids	Array of integers <int32> Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, `4234235,9681923`.
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_sids	Array of strings Performs the operation on the specified member SID. Enter multiple member SIDs in comma-separated format. For example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.
member_ids	Array of integers <int32> Performs the operation on the unique local member IDs specified. Enter multiple member IDs in comma-separated format. For local group IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). The `member_ids` and `member_names` parameters cannot be provided together.
member_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.

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 local users

Displays a list of local users.

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.
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.
uids	Array of integers <int32> A comma-separated list of local user IDs (UIDs). Enter multiple local user IDs in comma-separated format. For example, `423,51234`.
sids	Array of strings Performs the operation on the object SID specified. Enter multiple SIDs in comma-separated format. For example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
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.
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": [{"built_in": true,
"enabled": true,
"email": "string",
"name": "string",
"primary_group": {"id": "string",
"name": "string",
"resource_type": "string"
},
"sid": "string",
"uid": 0
}
]
}

Create local user

Creates a local user.

query Parameters

names

required

Array of strings

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

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 If this field is `false`, the local user will be disabled on creation. Otherwise, the local user will be enabled and functional.
email	string Optional field to set the email of the local user.
uid	integer <int32> Optional field to set the UID of the local user.
password	string The password of the local user. This field is only required if the `enabled` field is `true`.
	object Local group that would be assigned as the primary group of the local user.

Responses

Request samples

Payload

Content type

application/json

{"enabled": true,
"email": "string",
"uid": 0,
"password": "string",
"primary_group": {"id": "string",
"name": "string",
"resource_type": "string"
}
}

Response samples

Content type

application/json

{"items": [{"built_in": true,
"enabled": true,
"email": "string",
"name": "string",
"primary_group": {"id": "string",
"name": "string",
"resource_type": "string"
},
"sid": "string",
"uid": 0
}
]
}

Delete local users

Deletes one or more local users. The uids, names, or sids parameter is required, but 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`.
sids	Array of strings Performs the operation on the object SID specified. Enter multiple SIDs in comma-separated format. For example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.
uids	Array of integers <int32> A comma-separated list of local user IDs (UIDs). Enter multiple local user IDs in comma-separated format. For example, `423,51234`.

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

Modify local user

Modifies a local user.

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`.
keep_open_sessions	boolean If set to `true`, the session does not expire. If set to `false`, when the user is disabled or password is changed, the session expires. If not specified, defaults to `false`.
sids	Array of strings Performs the operation on the object SID specified. Enter multiple SIDs in comma-separated format. For example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.
uids	Array of integers <int32> A comma-separated list of local user IDs (UIDs). Enter multiple local user IDs in comma-separated format. For example, `423,51234`.

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 If this field is `false`, the local user will be disabled on creation. Otherwise, the local user will be enabled and functional from the beginning.
email	string Optional field to set the email of the local user.
name	string The local user name.
password	string The password of the local user. This field is only required if the `enabled` field is true.
	object Local group that would be assigned as the primary group of the local user.
uid	integer <int32> Optional field to set the UID of the local user.

Responses

Request samples

Payload

Content type

application/json

{"enabled": true,
"email": "string",
"name": "string",
"password": "string",
"primary_group": {"id": "string",
"name": "string",
"resource_type": "string"
},
"uid": 0
}

Response samples

Content type

application/json

{"items": [{"built_in": true,
"enabled": true,
"email": "string",
"name": "string",
"primary_group": {"id": "string",
"name": "string",
"resource_type": "string"
},
"sid": "string",
"uid": 0
}
]
}

List local user memberships

Displays a list of local user memberships.

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.
group_names	Array of strings Performs the operation on the group names specified. Enter multiple group names in comma-separated format. For example, `group1,group2`.
group_sids	Array of strings Performs the operation on the specified group SID. Enter multiple group SIDs in comma-separated format. For example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.
group_gids	Array of integers <int32> Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, `4234235,9681923`.
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_sids	Array of strings Performs the operation on the specified member SID. Enter multiple member SIDs in comma-separated format. For example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.
member_ids	Array of integers <int32> Performs the operation on the unique local member IDs specified. Enter multiple member IDs in comma-separated format. For local group IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). The `member_ids` and `member_names` parameters cannot be provided together.
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.
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",
"resource_type": "string"
},
"group_gid": 0,
"is_primary_group": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"member_id": 0
}
]
}

Create local user membership

Creates a local user membership with a group. The member_names or member_sids or member_ids parameter is required, but cannot be set together.

query Parameters

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_sids	Array of strings Performs the operation on the specified member SID. Enter multiple member SIDs in comma-separated format. For example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.
member_ids	Array of integers <int32> Performs the operation on the unique local member IDs specified. Enter multiple member IDs in comma-separated format. For local group IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). The `member_ids` and `member_names` parameters cannot be provided 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.

Request Body schema: application/json

The group_names, group_sids, or group_gids parameter is required, but cannot be set together.

	Array of objects (_localusermembershippostGroups) A list of groups of which the user is a member.
is_primary	boolean Default: false Determines whether memberships are primary group memberships or not.

Responses

Request samples

Payload

Content type

application/json

{"groups": [{"group": {"id": "string",
"name": "string",
"resource_type": "string"
},
"group_gid": 0
}
],
"is_primary": false
}

Response samples

Content type

application/json

{"items": [{"group": {"id": "string",
"name": "string",
"resource_type": "string"
},
"group_gid": 0,
"is_primary_group": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"member_id": 0
}
]
}

Delete local user membership

Deletes one or more local user memberships. The member_names, member_sids, or member_ids parameter is required, but cannot be set together.

query Parameters

group_names	Array of strings Performs the operation on the group names specified. Enter multiple group names in comma-separated format. For example, `group1,group2`.
group_sids	Array of strings Performs the operation on the specified group SID. Enter multiple group SIDs in comma-separated format. For example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.
group_gids	Array of integers <int32> Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, `4234235,9681923`.
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_sids	Array of strings Performs the operation on the specified member SID. Enter multiple member SIDs in comma-separated format. For example, `S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234`.
member_ids	Array of integers <int32> Performs the operation on the unique local member IDs specified. Enter multiple member IDs in comma-separated format. For local group IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). The `member_ids` and `member_names` parameters cannot be provided together.
member_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.

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

Directory Snapshots

Directory snapshots are created manually or by adding snapshot policies to managed directories. Each snapshot policy can be re-used for multiple directories.

List directory snapshots

Displays a list of directory 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",
"client_name": "string",
"created": 0,
"destroyed": true,
"policy": {"id": "string",
"name": "string"
},
"source": {"id": "string",
"name": "string"
},
"suffix": 0,
"time_remaining": 0,
"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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0
}
}
],
"total": [{"id": "string",
"name": "string",
"client_name": "string",
"created": 0,
"destroyed": true,
"policy": {"id": "string",
"name": "string"
},
"source": {"id": "string",
"name": "string"
},
"suffix": 0,
"time_remaining": 0,
"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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0
}
}
]
}

Create directory snapshot

Creates a snapshot of the contents of a directory. The source_ids or source_names parameter is required, but they cannot be set together.

query Parameters

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

client_name	string The client name portion of the client visible snapshot name. A full snapshot name is constructed in the form of `DIR.CLIENT_NAME.SUFFIX` where `DIR` is the managed directory name, `CLIENT_NAME` is the value of this field, and `SUFFIX` is the suffix. The client visible snapshot name is `CLIENT_NAME.SUFFIX`.
keep_for	integer <int64> The time to keep the snapshots for, in milliseconds.
suffix	string The suffix portion of the client visible snapshot name. A full snapshot name is constructed in the form of `DIR.CLIENT_NAME.SUFFIX` where `DIR` is the managed directory name, `CLIENT_NAME` is the client name, and `SUFFIX` is the value of this field. The client visible snapshot name is `CLIENT_NAME.SUFFIX`. If not specified, defaults to a monotonically increasing number generated by the system.

Responses

Request samples

Payload

Content type

application/json

{"client_name": "string",
"keep_for": 0,
"suffix": "string"
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"client_name": "string",
"created": 0,
"destroyed": true,
"policy": {"id": "string",
"name": "string"
},
"source": {"id": "string",
"name": "string"
},
"suffix": 0,
"time_remaining": 0,
"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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0
}
}
]
}

Delete directory snapshot

Deletes a directory snapshot that has been destroyed and is pending eradication. Eradicated directory snapshots cannot be recovered. Directory snapshots are destroyed by using 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

Modify directory snapshot

Modifies a directory snapshot. You can destroy, recover, or update the policy or time remaining of a directory snapshot. To destroy a directory snapshot, set destroyed=true. To recover a directory snapshot that has been destroyed and is pending eradication, set destroyed=false. To rename a directory snapshot, set name to the new name. 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 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.
keep_for	integer <int64> The amount of time to keep the snapshots, in milliseconds. Can only be set on snapshots that are not managed by any snapshot policy. Set to `""` to clear the keep_for value.
	object The snapshot policy that manages this snapshot. Set to `name` or `id` to `""` to clear the policy.
name	string The new name of a directory snapshot. The name of a directory snapshot managed by a snapshot policy is not changeable.
client_name	string The client name portion of the client-visible snapshot name. A full snapshot name is constructed in the form of `DIR.CLIENT_NAME.SUFFIX` where `DIR` is the managed directory name, `CLIENT_NAME` is the value of this field, and `SUFFIX` is the suffix. The client-visible snapshot name is `CLIENT_NAME.SUFFIX`. The client name of a directory snapshot managed by a snapshot policy is not changeable. If the `name` and `client_name` parameters are both specified, `client_name` must match the client name portion of `name`.
suffix	string The suffix portion of the client-visible snapshot name. A full snapshot name is constructed in the form of `DIR.CLIENT_NAME.SUFFIX` where `DIR` is the managed directory name, `CLIENT_NAME` is the client name, and `SUFFIX` is the value of this field. The client-visible snapshot name is `CLIENT_NAME.SUFFIX`. The suffix of a directory snapshot managed by a snapshot policy is not changeable. If the `name` and `suffix` parameters are both specified, `suffix` must match the suffix portion of `name`.

Responses

Request samples

Payload

Content type

application/json

{"destroyed": true,
"keep_for": 0,
"policy": {"id": "string",
"name": "string"
},
"name": "string",
"client_name": "string",
"suffix": "string"
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"client_name": "string",
"created": 0,
"destroyed": true,
"policy": {"id": "string",
"name": "string"
},
"source": {"id": "string",
"name": "string"
},
"suffix": 0,
"time_remaining": 0,
"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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0
}
}
]
}

DNS

DNS attributes include the domain suffix, static name servers, mode (static or DHCP), and search domain. The configured attributes can be listed.

List DNS parameters

Displays the current DNS configurations and their parameters including domain suffix, the list of DNS name server IP addresses, and the list of services that DNS parameters apply to.

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",
"domain": "example.com",
"nameservers": ["192.168.0.125"
],
"services": ["string"
],
"source": {"name": "string"
}
}
]
}

Create DNS configuration

Creates new DNS configuration with parameters including the domain suffix, the list of DNS name server IP addresses, and the list of services that DNS parameters apply to.

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

domain	string The domain suffix to be appended by the appliance when performing DNS lookups.
nameservers	Array of strings The list of DNS server IP addresses.
services	Array of strings The list of services utilizing the DNS configuration.
	object The network interface used for communication with the DNS server.

Responses

Request samples

Payload

Content type

application/json

{"domain": "example.com",
"nameservers": ["192.168.0.125"
],
"services": ["string"
],
"source": {"name": "string"
}
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"domain": "example.com",
"nameservers": ["192.168.0.125"
],
"services": ["string"
],
"source": {"name": "string"
}
}
]
}

Delete DNS configuration

Deletes DNS configuration identified by configuration name.

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

Modify DNS parameters

Modifies the DNS parameters of an array, including the domain suffix, the list of DNS name server IP addresses, and the list of services that DNS parameters apply to. If there is no DNS configuration beforehand new DNS configuration with 'default' name is created. If more than one DNS configuration exists name has to be specified to identify the DNS configuration to be modified.

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.
domain	string The domain suffix to be appended by the appliance when performing DNS lookups.
nameservers	Array of strings The list of DNS server IP addresses.
services	Array of strings The list of services utilizing the DNS configuration.
	object The network interface used for communication with the DNS server.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"domain": "example.com",
"nameservers": ["192.168.0.125"
],
"services": ["string"
],
"source": {"name": "string"
}
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"domain": "example.com",
"nameservers": ["192.168.0.125"
],
"services": ["string"
],
"source": {"name": "string"
}
}
]
}

Drives

Drive data includes the name, type, status, capacity, protocol and other information for all flash, NVRAM, and cache modules in an array.

List flash, NVRAM, and cache modules

Displays a list of flash, NVRAM, and cache modules that are installed in the array along with their attributes and status.

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",
"capacity": 1099511627776,
"details": "Cache module in wrong bay.",
"protocol": "SAS",
"status": "healthy",
"type": "SSD"
}
]
}

Modify flash and NVRAM modules

Modifies flash and NVRAM modules that have been added or connected but not yet admitted to the array.

query Parameters

admit

boolean

If true, admits any unadmitted drives into the system.

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",
"capacity": 1099511627776,
"details": "Cache module in wrong bay.",
"protocol": "SAS",
"status": "healthy",
"type": "SSD"
}
]
}

File Systems

A FlashArray can contain up to 24 separate file systems, each with a number of directories that can be exported via supported protocols. Clients, using Active Directory or LDAP, can connect and access these exports using SMB or NFS.

List file systems

Displays a list of file systems, 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`.

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,
"time_remaining": 0,
"pod": {"id": "string",
"name": "string"
}
}
]
}

Create file system

Creates one or more file systems.

query Parameters

names

required

Array of strings

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

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": [{"id": "string",
"name": "string",
"created": 0,
"destroyed": true,
"time_remaining": 0,
"pod": {"id": "string",
"name": "string"
}
}
]
}

Delete file system

Deletes a file system that has been destroyed and is pending eradication. Eradicated file systems cannot be recovered. File systems are destroyed using the PATCH method.

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

Modify a file system

Modifies a file system. You can rename, destroy, move, or recover a file system. To rename a file system, set name to the new name. To destroy a file system, set destroyed=true. To move a file system, set 'pod' to the destination pod reference. To recover a file system that has been destroyed and is pending eradication, set destroyed=false.

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 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 The pod to move existing file systems into.

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"created": 0,
"destroyed": true,
"time_remaining": 0,
"pod": {"id": "string",
"name": "string"
}
}
]
}

Fleets

A fleet is a collection of Arrays.

List fleets

Displays information about the fleets known to the 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.
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 resource names specified. Only one value is supported.
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": "string",
"name": "string",
"is_local": true
}
]
}

Create a fleet

Creates a fleet and adds the current array as its first member. Additional arrays can be added to the fleet with POST /fleets/members

query Parameters

names

Array of strings

Performs the operation on the unique resource names specified. Only one value is supported.

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": [{"id": "string",
"name": "string",
"is_local": true
}
]
}

Get fleet key information

Displays the time remaining on the fleet key. Note, fleet key itself is not displayed, since that is only available at time of fleet key creation.

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.
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": [{"fleet_key": "CAUSJDljMGM3MGY3LWFhZDEtNDRkZC05ZDQ2LTZlOTA3YzY3Yzg1YxokOWMwYzcwZjctYWFkMS00NGRkLTlkND",
"created": 1706850977,
"expires": 1706854577
}
]
}

Create a fleet key

Creates a fleet key allowing an array to be added to a fleet. This is the only time the fleet key is displayed, it cannot be retrieved subsequently. Note, creation of a subsequent key invalidates all keys created earlier.

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": [{"fleet_key": "CAUSJDljMGM3MGY3LWFhZDEtNDRkZC05ZDQ2LTZlOTA3YzY3Yzg1YxokOWMwYzcwZjctYWFkMS00NGRkLTlkND",
"created": 1706850977,
"expires": 1706854577
}
]
}

List fleet members

Displays the members in the current fleet.

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.
fleet_ids	Array of strings Performs the operation on the unique Fleet IDs specified. This query currently accepts only 1 ID.
fleet_names	Array of strings Performs the operation on the unique Fleet names specified. Enter multiple names in comma-separated format. For example, `name01,name02`. This query currently accepts only 1 name.
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.
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": [{"member": {"id": "string",
"name": "string",
"is_local": true,
"resource_type": "string"
},
"status": "string",
"status_details": "cannot reach array",
"fleet": {"id": "string",
"name": "string",
"is_local": true,
"resource_type": "string"
}
}
]
}

Add members to a fleet

Adds arrays to an existing fleet. This API needs to be run from the array that's joining the fleet.

To add the current array to the fleet, specify its own array id or name, as well as the fleet key generated on any array already in the fleet. resource_type is remote-arrays. The array's ID and name can be retrieved with a call to GET /arrays on the array.

query Parameters

fleet_ids	Array of strings Performs the operation on the unique Fleet IDs specified. This query currently accepts only 1 ID.
fleet_names	Array of strings Performs the operation on the unique Fleet names specified. Enter multiple names in comma-separated format. For example, `name01,name02`. This query currently accepts only 1 name.

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

Info about the members being added to fleet.

Array of objects (_fleetmemberpostMembers)

Details about the members being added to fleet.

Responses

Request samples

Payload

Content type

application/json

{"members": [{"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"key": "string"
}
]
}

Response samples

Content type

application/json

{"items": [{"member": {"id": "string",
"name": "string",
"is_local": true,
"resource_type": "string"
},
"status": "string",
"status_details": "cannot reach array",
"fleet": {"id": "string",
"name": "string",
"is_local": true,
"resource_type": "string"
}
}
]
}

Delete fleet members

Deletes the specified array(s) from the fleet. Note that this will only succeed if the array(s) to be removed are not making use of any fleet resources.

query Parameters

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.
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`.
unreachable	boolean If set to `true`, allows a one-sided disconnect when the connection status is `connecting` instead of `connected` or `partially connected`. If set to `false`, it works just like normal coordinated disconnect. 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

Hardware

Operational status is reported by most of the hardware components in an array, including the chassis, controller, and storage shelf.

List hardware component information

Displays a list of hardware slots and bays and status of installed components.

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",
"details": "Temperature too high",
"identify_enabled": true,
"index": 1,
"model": "DFSC1",
"serial": "PSMFL1717009B",
"slot": 16,
"speed": 24000000000,
"status": "critical",
"temperature": 25,
"type": "ct",
"voltage": 206
}
]
}

Modify visual identification

Modifies the visual identification of a specified hardware component, and causing the ID LED to turn on or off.

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

identify_enabled	boolean State of an LED used to visually identify the component.
index	integer <int32> Number that identifies the relative position of a hardware component within the array.

Responses

Request samples

Payload

Content type

application/json

{"identify_enabled": true,
"index": 1
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"details": "Temperature too high",
"identify_enabled": true,
"index": 1,
"model": "DFSC1",
"serial": "PSMFL1717009B",
"slot": 16,
"speed": 24000000000,
"status": "critical",
"temperature": 25,
"type": "ct",
"voltage": 206
}
]
}

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

Displays 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.
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",
"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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0
},
"destroyed": true,
"time_remaining": 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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0
},
"destroyed": true,
"time_remaining": 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

Modify a host group

Modifies 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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0
},
"destroyed": true,
"time_remaining": 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

Displays real-time and historical performance data, real-time latency data, and average I/O sizes of all host groups, displayed both by host group and by total size across all host groups. This data represents volumes that are connected to the host groups on the local array and stretched volumes connected to the host groups on arrays that are connected by synchronous replication.

query Parameters

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.
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": [{"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,
"service_usec_per_read_op_cache_reduction": 0,
"name": "string"
}
],
"total": [{"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,
"service_usec_per_read_op_cache_reduction": 0,
"name": "string"
}
]
}

List host group performance data by array

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

query Parameters

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.
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": [{"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,
"service_usec_per_read_op_cache_reduction": 0,
"name": "string",
"array": {"id": "string",
"name": "string"
}
}
],
"total": [{"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,
"service_usec_per_read_op_cache_reduction": 0,
"name": "string",
"array": {"id": "string",
"name": "string"
}
}
]
}

List host groups that are members of protection groups

Displays 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_ids	Array of strings A comma-separated list of group IDs.
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": {"id": "string",
"name": "string"
},
"member": {"name": "string"
}
}
]
}

Create a host group

Creates a host group member and assigns 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_ids	Array of strings A comma-separated list of group IDs.
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": {"id": "string",
"name": "string"
},
"member": {"name": "string"
}
}
]
}

Delete a host group from a protection group

Deletes 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 are not 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_ids	Array of strings A comma-separated list of group IDs.
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

Displays 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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0
},
"time": 0
}
]
}

List tags

Displays the list of tags on host group objects.

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.
namespaces	Array of strings A comma-separated list of namespaces.
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.
resource_ids	Array of strings A comma-separated list of resource IDs. The `resource_ids` or `resource_names` parameter is required, but they cannot be set together.
resource_names	Array of strings A comma-separated list of resource names. The `resource_ids` or `resource_names` parameter is required, but they cannot be set together.
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": [{"copyable": true,
"key": "environment",
"namespace": "default",
"resource": {"id": "string",
"name": "string"
},
"value": "staging"
}
]
}

Delete tags

Deletes specified tags on host group objects.

query Parameters

keys	Array of strings A comma-separated list of tag keys.
namespaces	Array of strings A comma-separated list of namespaces.
resource_ids	Array of strings A comma-separated list of resource IDs. The `resource_ids` or `resource_names` parameter is required, but they cannot be set together.
resource_names	Array of strings A comma-separated list of resource names. The `resource_ids` or `resource_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

Update tags

Updates tags.

query Parameters

resource_ids	Array of strings A comma-separated list of resource IDs. The `resource_ids` or `resource_names` parameter is required, but they cannot be set together.
resource_names	Array of strings A comma-separated list of resource names. The `resource_ids` or `resource_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.

Request Body schema: application/json

A list of tags to be created or, if already existing, updated.

Array ()

key	string Key of the tag. Supports up to 64 Unicode characters.
namespace	string Optional namespace of the tag. Namespace identifies the category of the tag. Omitting the namespace defaults to the namespace `default`. The `pure*` namespaces are reserved for plugins and integration partners. It is recommended that customers avoid using reserved namespaces.
	object (_fixedReference)
value	string Value of the tag. Supports up to 256 Unicode characters.

Responses

Request samples

Payload

Content type

application/json

[{"key": "environment",
"namespace": "default",
"resource": { },
"value": "staging"
}
]

Response samples

Content type

application/json

{"items": [{"copyable": true,
"key": "environment",
"namespace": "default",
"resource": {"id": "string",
"name": "string"
},
"value": "staging"
}
]
}

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

Displays 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.
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",
"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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0
},
"preferred_arrays": [{"id": "string",
"name": "string"
}
],
"wwns": ["52:4A:93:70:4E:E5:68:00"
],
"is_local": true,
"vlan": "1",
"destroyed": true,
"time_remaining": 0
}
]
}

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.
vlan	string The VLAN ID that the host is associated with. If not set or set to `any`, the host can access any VLAN. If set to `untagged`, the host can only access untagged VLANs. If set to a number between `1` and `4094`, the host can only access the specified VLAN with that number.

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

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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0
},
"preferred_arrays": [{"id": "string",
"name": "string"
}
],
"wwns": ["52:4A:93:70:4E:E5:68:00"
],
"is_local": true,
"vlan": "1",
"destroyed": true,
"time_remaining": 0
}
]
}

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

Modify a host

Modifies 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.
vlan	string The VLAN ID that the host is associated with. If not set, there is no change in VLAN. If set to `any`, the host can access any VLAN. If set to `untagged`, the host can only access untagged VLANs. If set to a number between `1` and `4094`, the host can only access the specified VLAN with that number.

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

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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0
},
"preferred_arrays": [{"id": "string",
"name": "string"
}
],
"wwns": ["52:4A:93:70:4E:E5:68:00"
],
"is_local": true,
"vlan": "1",
"destroyed": true,
"time_remaining": 0
}
]
}

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

Displays real-time and historical performance data, real-time latency data, and average I/O sizes across all hosts, displayed by host and by total size across all hosts. This data represents volumes that are connected to the hosts on the local array and stretched volumes connected to the hosts on any arrays that are connected by synchronous replication.

query Parameters

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.
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": [{"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,
"service_usec_per_read_op_cache_reduction": 0,
"name": "string"
}
],
"total": [{"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,
"service_usec_per_read_op_cache_reduction": 0,
"name": "string"
}
]
}

List host performance balance

Displays the I/O balance statistics for host paths.

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",
"op_count": 0,
"fraction_relative_to_max": 0.14,
"initiator": {"iqn": "iqn.2010-06.com.purestorage:flasharray.393d930077be2977",
"nqn": "nqn.2010-06.com.purestorage:flasharray.512f7bb185978505",
"portal": "10.16.200.27:3260",
"wwn": "52:4A:93:70:4E:E5:68:00"
},
"target": {"name": "string",
"iqn": "iqn.2010-06.com.purestorage:flasharray.393d930077be2977",
"nqn": "nqn.2010-06.com.purestorage:flasharray.512f7bb185978505",
"portal": "10.16.200.27:3260",
"wwn": "52:4A:93:70:4E:E5:68:00",
"failover": "CT0.ETH2"
},
"time": 0
}
]
}

List host performance data by array

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

query Parameters

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.
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": [{"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,
"service_usec_per_read_op_cache_reduction": 0,
"name": "string",
"array": {"id": "string",
"name": "string"
}
}
],
"total": [{"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,
"service_usec_per_read_op_cache_reduction": 0,
"name": "string",
"array": {"id": "string",
"name": "string"
}
}
]
}

List hosts that are members of protection groups

Displays 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_ids	Array of strings A comma-separated list of group IDs.
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": {"id": "string",
"name": "string"
},
"member": {"name": "string"
}
}
]
}

Create a host

Creates a host member and adds it 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_ids	Array of strings A comma-separated list of group IDs.
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": {"id": "string",
"name": "string"
},
"member": {"name": "string"
}
}
]
}

Delete a host from a protection group

Deletes 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 are not 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_ids	Array of strings A comma-separated list of group IDs.
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

Displays 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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0
},
"time": 0
}
]
}

List tags

Displays the list of tags on host objects.

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.
namespaces	Array of strings A comma-separated list of namespaces.
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.
resource_ids	Array of strings A comma-separated list of resource IDs. The `resource_ids` or `resource_names` parameter is required, but they cannot be set together.
resource_names	Array of strings A comma-separated list of resource names. The `resource_ids` or `resource_names` parameter is required, but they cannot be set together.
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": [{"copyable": true,
"key": "environment",
"namespace": "default",
"resource": {"id": "string",
"name": "string"
},
"value": "staging"
}
]
}

Delete tags

Deletes specified tags on host objects.

query Parameters

keys	Array of strings A comma-separated list of tag keys.
namespaces	Array of strings A comma-separated list of namespaces.
resource_ids	Array of strings A comma-separated list of resource IDs. The `resource_ids` or `resource_names` parameter is required, but they cannot be set together.
resource_names	Array of strings A comma-separated list of resource names. The `resource_ids` or `resource_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

Update tags

Updates tags.

query Parameters

resource_ids	Array of strings A comma-separated list of resource IDs. The `resource_ids` or `resource_names` parameter is required, but they cannot be set together.
resource_names	Array of strings A comma-separated list of resource names. The `resource_ids` or `resource_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.

Request Body schema: application/json

A list of tags to be created or, if already existing, updated.

Array ()

key	string Key of the tag. Supports up to 64 Unicode characters.
namespace	string Optional namespace of the tag. Namespace identifies the category of the tag. Omitting the namespace defaults to the namespace `default`. The `pure*` namespaces are reserved for plugins and integration partners. It is recommended that customers avoid using reserved namespaces.
	object (_fixedReference)
value	string Value of the tag. Supports up to 256 Unicode characters.

Responses

Request samples

Payload

Content type

application/json

[{"key": "environment",
"namespace": "default",
"resource": { },
"value": "staging"
}
]

Response samples

Content type

application/json

{"items": [{"copyable": true,
"key": "environment",
"namespace": "default",
"resource": {"id": "string",
"name": "string"
},
"value": "staging"
}
]
}

KMIP

The Key Management Interoperability Protocol (KMIP) server is used in combination with the Pure Storage Rapid Data Locking (RDL) feature and EncryptReduce feature to further secure the encrypted data on a FlashArray.

List KMIP server objects

Displays the list of KMIP server objects.

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",
"uris": ["1.1.1.1:8888",
"2.2.2.2:9999"
],
"certificate": {"name": "string"
},
"ca_certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
"kmip_objects": [{"name": "string",
"uid": "string"
}
]
}
]
}

Create KMIP server object

Creates KMIP server objects.

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

uris	Array of strings List of URIs for the configured KMIP servers.
	object The certificate used to verify FlashArray authenticity to the KMIP servers.
ca_certificate	string <= 3000 characters The text of the CA certificate for the KMIP server.

Responses

Request samples

Payload

Content type

application/json

{"uris": ["1.1.1.1:8888",
"2.2.2.2:9999"
],
"certificate": {"name": "string"
},
"ca_certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----"
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"uris": ["1.1.1.1:8888",
"2.2.2.2:9999"
],
"certificate": {"name": "string"
},
"ca_certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
"kmip_objects": [{"name": "string",
"uid": "string"
}
]
}
]
}

Delete KMIP server object

Deletes KMIP server objects.

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

Modify KMIP attributes

Modifies one or more attributes of KMIP server objects.

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

uris	Array of strings List of URIs for the configured KMIP servers.
	object The certificate used to verify FlashArray authenticity to the KMIP servers.
ca_certificate	string <= 3000 characters The text of the CA certificate for the KMIP server.

Responses

Request samples

Payload

Content type

application/json

{"uris": ["1.1.1.1:8888",
"2.2.2.2:9999"
],
"certificate": {"name": "string"
},
"ca_certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----"
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"uris": ["1.1.1.1:8888",
"2.2.2.2:9999"
],
"certificate": {"name": "string"
},
"ca_certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
"kmip_objects": [{"name": "string",
"uid": "string"
}
]
}
]
}

Lists KMIP connection tests

Displays communication data between a FlashArray and KMIP server.

query Parameters

names

required

Array of strings

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

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": [{"component_address": "10.230.94.21",
"component_name": "kmip-test1",
"description": "Testing kmip connectivity.",
"destination": "kmip-test-server.dev.purestorage.com",
"enabled": true,
"result_details": "KMIP test failed",
"success": true,
"test_type": "kmip"
}
]
}

Log Targets

Log Targets to be used to send management or data audit logs.

List log targets

Displays a list of configured log 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.
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",
"target_type": "syslog"
}
]
}

List file log targets

Displays a list of configured file log 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.
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",
"target_type": "syslog",
"directory": {"id": "string",
"name": "string",
"resource_type": "string"
},
"keep_for": 86400000,
"keep_size": 1000000
}
]
}

Create a file log target

Creates a new file log 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.

Request Body schema: application/json

	object Directory name to be used as log target.
keep_for	integer <int64> >= 86400000 Specifies the period that audit logs are retained before they are deleted, in milliseconds. If not specified, defaults to `null` which means size based retention does not apply. Use 0 to reset the value to `null`. At least one of the `keep_for` or `keep_size` parameters are required, and they can be set together.
keep_size	integer <int64> >= 1000000 Specifies the maximum size of audit logs to be retained. Measured in bytes. When exceeded, older logs will be deleted. If not specified, defaults to `null` which means size based retention does not apply. Use 0 to reset the value to `null`.

Responses

Request samples

Payload

Content type

application/json

{"directory": {"id": "string",
"name": "string",
"resource_type": "string"
},
"keep_for": 86400000,
"keep_size": 1000000
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"target_type": "syslog",
"directory": {"id": "string",
"name": "string",
"resource_type": "string"
},
"keep_for": 86400000,
"keep_size": 1000000
}
]
}

Delete a file log target

Deletes a configured file log 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

Modify a file log target

Modifies the managed directory and retention of a configured file log 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.

Request Body schema: application/json

	object Directory name to be used as log target.
keep_for	integer <int64> >= 86400000 Specifies the period that audit logs are retained before they are deleted, in milliseconds. If not specified, defaults to `null` which means size based retention does not apply. Use 0 to reset the value to `null`. At least one of the `keep_for` or `keep_size` parameters are required, and they can be set together.
keep_size	integer <int64> >= 1000000 Specifies the maximum size of audit logs to be retained. Measured in bytes. When exceeded, older logs will be deleted. If not specified, defaults to `null` which means size based retention does not apply. Use 0 to reset the value to `null`.

Responses

Request samples

Payload

Content type

application/json

{"directory": {"id": "string",
"name": "string",
"resource_type": "string"
},
"keep_for": 86400000,
"keep_size": 1000000
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"target_type": "syslog",
"directory": {"id": "string",
"name": "string",
"resource_type": "string"
},
"keep_for": 86400000,
"keep_size": 1000000
}
]
}

List syslog servers

Displays a list of configured syslog servers.

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",
"target_type": "syslog",
"uri": "tcp://my.syslogserver.com",
"services": ["string"
]
}
]
}

Create syslog server

Creates a new syslog server.

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

uri	string The URI of the syslog server in the format `PROTOCOL://HOSTNAME:PORT`.
services	Array of strings Valid values are `data-audit` and `management`. If not specified, defaults to `management`.

Responses

Request samples

Payload

Content type

application/json

{"uri": "tcp://my.syslogserver.com",
"services": ["string"
]
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"target_type": "syslog",
"uri": "tcp://my.syslogserver.com",
"services": ["string"
]
}
]
}

Delete syslog server

Deletes a configured syslog server and stop forwarding syslog messages.

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

Modify syslog server

Modifies the URI and services of a configured syslog server.

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

uri	string The URI of the syslog server in the format `PROTOCOL://HOSTNAME:PORT`.
services	Array of strings Valid values are `data-audit` and `management`. If not specified, defaults to `management`.

Responses

Request samples

Payload

Content type

application/json

{"uri": "tcp://my.syslogserver.com",
"services": ["string"
]
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"target_type": "syslog",
"uri": "tcp://my.syslogserver.com",
"services": ["string"
]
}
]
}

List syslog settings

Displays syslog settings. Values include continuation_token, items, more_items_remaining, and total_item_count.

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.
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": [{"ca_certificate": "string",
"tls_audit_enabled": true,
"logging_severity": "string"
}
]
}

Modify syslog settings

Modifies syslog settings. Values include continuation_token, items, more_items_remaining, and total_item_count.

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

ca_certificate	string The certificate of the certificate authority (CA) that signed the directory servers' certificate(s), which is used to validate the authenticity of the configured servers.
tls_audit_enabled	boolean Returns a value of `true` if messages that are necessary in order to audit TLS negotiations performed by the array are forwarded to the configured syslog servers.
logging_severity	string Returns the configured logging severity threshold for which events will be forwarded to the configured syslog servers. Default configuration is info level severity. Valid values are `debug`, `info`, and `notice`.

Responses

Request samples

Payload

Content type

application/json

{"ca_certificate": "string",
"tls_audit_enabled": true,
"logging_severity": "string"
}

Response samples

Content type

application/json

{"items": [{"ca_certificate": "string",
"tls_audit_enabled": true,
"logging_severity": "string"
}
]
}

List syslog server test results

Displays syslog server test results, which indicate whether the syslog is working and configured correctly.

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.
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

{"total_item_count": 0,
"items": [{"component_address": "10.230.94.21",
"component_name": "CT0",
"description": "Testing phonehome connectivity",
"destination": "ra.cloud-support.purestorage.com",
"enabled": true,
"result_details": "Timeout connecting to phonehome endpoint",
"success": true,
"test_type": "phonehome",
"resource": {"name": "string"
}
}
]
}

Maintenance Windows

During a maintenance window, alerts are suppressed that are related to connections, paths, ports, and other resources that are down during maintenance.

List maintenance window details

Displays maintenance window details, including start time, end time, and maintenance type.

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",
"created": 0,
"expires": 0
}
]
}

Create a maintenance window

Creates a maintenance window that suppresses alerts for a specified period of time. A maintenance window can be manually closed at any time. The names and timeout parameters are required. Set the names parameter to environment.

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

timeout

integer <int32>

The specified length of time that alerts are suppressed during a maintenance window, measured in milliseconds. The maintenance window timeout value must be between 60000 (1 minute) and 86400000 (24 hours). The value entered is rounded down to the nearest minute. The names and timeout parameters must be set together, and the names parameter must be set to environment.

Responses

Request samples

Payload

Content type

application/json

{"timeout": 3600000
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"created": 0,
"expires": 0
}
]
}

Delete maintenance window

Deletes an open maintenance window before its scheduled end (expire) time. The names parameter is required and must be set to environment.

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

Network Interfaces

Manages the interfaces and the network connection attributes of the array.

List network interfaces

Displays all network interfaces for all controllers on the 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.
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",
"enabled": true,
"interface_type": "string",
"services": ["string"
],
"speed": 0,
"eth": {"address": "string",
"gateway": "string",
"mac_address": "string",
"mtu": 0,
"netmask": "string",
"subtype": "string",
"subinterfaces": [{"name": "string"
}
],
"subnet": {"name": "string"
},
"vlan": 0
},
"fc": {"wwn": "string"
}
}
]
}

Create network interface

Creates a network interface on a controller on the 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

services	Array of strings The services provided by the specified network interface or Fibre Channel port.
	object (_networkinterfacepostEth) Ethernet network interface properties.

Responses

Request samples

Payload

Content type

application/json

{"services": ["string"
],
"eth": {"address": "string",
"subinterfaces": [{"name": "string"
}
],
"subnet": {"name": "string"
},
"subtype": "string"
}
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"enabled": true,
"interface_type": "string",
"services": ["string"
],
"speed": 0,
"eth": {"address": "string",
"gateway": "string",
"mac_address": "string",
"mtu": 0,
"netmask": "string",
"subtype": "string",
"subinterfaces": [{"name": "string"
}
],
"subnet": {"name": "string"
},
"vlan": 0
},
"fc": {"wwn": "string"
}
}
]
}

Delete network interface

Deletes a network interface on a controller.

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

Modify network interface

Modifies a network interface on a controller.

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

enabled	boolean Returns a value of `true` if the specified network interface or Fibre Channel port is enabled. Returns a value of `false` if the specified network interface or Fibre Channel port is disabled.
override_npiv_check	boolean N-Port ID Virtualization (NPIV) requires a balanced configuration of Fibre Channel ports configured for SCSI on both controllers. Enabling or Disabling a Fibre Channel port configured for SCSI might cause the NPIV status to change from enabled to disabled or vice versa. Set this option to proceed with enabling or disabling the port.
services	Array of strings The services provided by the specified network interface or Fibre Channel port.
	object (_networkinterfacepatchEth) Ethernet network interface properties.

Responses

Request samples

Payload

Content type

application/json

{"enabled": true,
"override_npiv_check": true,
"services": ["string"
],
"eth": {"address": "string",
"gateway": "string",
"mtu": 0,
"netmask": "string",
"add_subinterfaces": [{"name": "string"
}
],
"remove_subinterfaces": [{"name": "string"
}
],
"subinterfaces": [{"name": "string"
}
],
"subnet": {"name": "string"
}
}
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"enabled": true,
"interface_type": "string",
"services": ["string"
],
"speed": 0,
"eth": {"address": "string",
"gateway": "string",
"mac_address": "string",
"mtu": 0,
"netmask": "string",
"subtype": "string",
"subinterfaces": [{"name": "string"
}
],
"subnet": {"name": "string"
},
"vlan": 0
},
"fc": {"wwn": "string"
}
}
]
}

List network interface neighbors

Displays all neighbors for all network interfaces on 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.
local_port_names	Array of strings Performs the operation on the unique local port name specified. Enter multiple names in comma-separated format. For example, `ct0.eth0,ct1.eth0`.
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": [{"local_port": {"name": "string"
},
"neighbor_chassis": {"id": {"type": "mac",
"value": "00:12:ab:cd:ab:cd"
},
"name": "iscsi-sw-100-b.example.com",
"addresses": ["10.202.101.70"
],
"description": "Example Switch iscsi-sw-100-b version 1.0",
"repeater": {"supported": false,
"enabled": false
},
"bridge": {"supported": false,
"enabled": false
},
"wlan_access_point": {"supported": false,
"enabled": false
},
"router": {"supported": false,
"enabled": false
},
"telephone": {"supported": false,
"enabled": false
},
"docsis_cable_device": {"supported": false,
"enabled": false
},
"station_only": {"supported": false,
"enabled": false
}
},
"neighbor_port": {"description": "eth7",
"id": {"type": "ifname",
"value": "Ethernet7"
}
},
"initial_ttl_in_sec": 120
}
]
}

List network performance statistics

Displays network statistics, historical bandwidth, and error reporting for all specified network interfaces.

query Parameters

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.
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",
"interface_type": "string",
"time": 0,
"eth": {"other_errors_per_sec": 0,
"received_bytes_per_sec": 0,
"received_crc_errors_per_sec": 0,
"received_frame_errors_per_sec": 0,
"received_packets_per_sec": 0,
"total_errors_per_sec": 0,
"transmitted_bytes_per_sec": 0,
"transmitted_carrier_errors_per_sec": 0,
"transmitted_dropped_errors_per_sec": 0,
"transmitted_packets_per_sec": 0,
"flow_control_received_congestion_packets_per_sec": 0,
"flow_control_received_discarded_packets_per_sec": 0,
"flow_control_received_lossless_bytes_per_sec": 0,
"flow_control_received_pause_frames_per_sec": 0,
"flow_control_transmitted_congestion_packets_per_sec": 0,
"flow_control_transmitted_discarded_packets_per_sec": 0,
"flow_control_transmitted_lossless_bytes_per_sec": 0,
"flow_control_transmitted_pause_frames_per_sec": 0,
"rdma_received_req_cqe_errors_per_sec": 0,
"rdma_received_sequence_errors_per_sec": 0,
"rdma_transmitted_local_ack_timeout_errors_per_sec": 0
},
"fc": {"received_bytes_per_sec": 0,
"received_crc_errors_per_sec": 0,
"received_frames_per_sec": 0,
"received_link_failures_per_sec": 0,
"received_loss_of_signal_per_sec": 0,
"received_loss_of_sync_per_sec": 0,
"total_errors_per_sec": 0,
"transmitted_bytes_per_sec": 0,
"transmitted_frames_per_sec": 0,
"transmitted_invalid_words_per_sec": 0
}
}
],
"total": [{"name": "string",
"interface_type": "string",
"time": 0,
"eth": {"other_errors_per_sec": 0,
"received_bytes_per_sec": 0,
"received_crc_errors_per_sec": 0,
"received_frame_errors_per_sec": 0,
"received_packets_per_sec": 0,
"total_errors_per_sec": 0,
"transmitted_bytes_per_sec": 0,
"transmitted_carrier_errors_per_sec": 0,
"transmitted_dropped_errors_per_sec": 0,
"transmitted_packets_per_sec": 0,
"flow_control_received_congestion_packets_per_sec": 0,
"flow_control_received_discarded_packets_per_sec": 0,
"flow_control_received_lossless_bytes_per_sec": 0,
"flow_control_received_pause_frames_per_sec": 0,
"flow_control_transmitted_congestion_packets_per_sec": 0,
"flow_control_transmitted_discarded_packets_per_sec": 0,
"flow_control_transmitted_lossless_bytes_per_sec": 0,
"flow_control_transmitted_pause_frames_per_sec": 0,
"rdma_received_req_cqe_errors_per_sec": 0,
"rdma_received_sequence_errors_per_sec": 0,
"rdma_transmitted_local_ack_timeout_errors_per_sec": 0
},
"fc": {"received_bytes_per_sec": 0,
"received_crc_errors_per_sec": 0,
"received_frames_per_sec": 0,
"received_link_failures_per_sec": 0,
"received_loss_of_signal_per_sec": 0,
"received_loss_of_sync_per_sec": 0,
"total_errors_per_sec": 0,
"transmitted_bytes_per_sec": 0,
"transmitted_frames_per_sec": 0,
"transmitted_invalid_words_per_sec": 0
}
}
]
}

List SFP port details

Displays Ethernet and Fibre Channel SFP details.

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",
"interface_type": "string",
"temperature": [{"channel": 0,
"measurement": 0,
"status": "ok"
}
],
"voltage": [{"channel": 0,
"measurement": 0,
"status": "ok"
}
],
"tx_bias": [{"channel": 0,
"measurement": 0,
"status": "ok"
}
],
"tx_power": [{"channel": 0,
"measurement": 0,
"status": "ok"
}
],
"rx_power": [{"channel": 0,
"measurement": 0,
"status": "ok"
}
],
"tx_fault": [{"channel": 0,
"flag": true
}
],
"rx_los": [{"channel": 0,
"flag": true
}
],
"static": {"identifier": "SFP or SFP+",
"extended_identifier": "GBIC/SFP function is defined by 2-wire interface ID only",
"connector_type": "LC",
"encoding": "64B/66B",
"rate_identifier": "FC-PI-5 (16/8/4G Independent Rx, Tx Rate_select)",
"specifications": ["1000BASE-T"
],
"fc_link_lengths": ["short distance (S)"
],
"fc_technology": ["Electrical intra-enclosure (EL)"
],
"cable_technology": ["Active Cable"
],
"fc_transmission_media": ["Multimode, 62.5um (M6)"
],
"fc_speeds": "16|32|64 Gb/s",
"signaling_rate": "14000 MBd",
"signaling_rate_max": "1%",
"signaling_rate_min": "1%",
"wavelength": "850 nm",
"link_length": "OM2: 40 m, OM1: 20 m, OM3: 100 m",
"vendor_name": "EMULEX",
"vendor_oui": "00-17-6A",
"vendor_part_number": "ABCD-12E3FG-ELX",
"vendor_revision": "stri",
"vendor_serial_number": "AB1234C56DE",
"vendor_date_code": "190221",
"temperature_thresholds": {"alarm_low": 0,
"warn_low": 0,
"warn_high": 0,
"alarm_high": 0
},
"voltage_thresholds": {"alarm_low": 0,
"warn_low": 0,
"warn_high": 0,
"alarm_high": 0
},
"tx_bias_thresholds": {"alarm_low": 0,
"warn_low": 0,
"warn_high": 0,
"alarm_high": 0
},
"tx_power_thresholds": {"alarm_low": 0,
"warn_low": 0,
"warn_high": 0,
"alarm_high": 0
},
"rx_power_thresholds": {"alarm_low": 0,
"warn_low": 0,
"warn_high": 0,
"alarm_high": 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

Displays 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 `azure`, `google-cloud`, `nfs`, and `s3`.
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",
"profile": "string"
},
"s3": {"access_key_id": "string",
"bucket": "string",
"placement_strategy": "string",
"secret_access_key": "string",
"uri": "string",
"auth_region": "string",
"profile": "string"
},
"azure": {"container_name": "string",
"account_name": "string",
"secret_access_key": "string",
"profile": "string"
},
"google-cloud": {"access_key_id": "string",
"bucket": "string",
"secret_access_key": "string",
"profile": "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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0
},
"status": "string"
}
],
"total": [{"nfs": {"address": "string",
"mount_options": "string",
"mount_point": "string",
"profile": "string"
},
"s3": {"access_key_id": "string",
"bucket": "string",
"placement_strategy": "string",
"secret_access_key": "string",
"uri": "string",
"auth_region": "string",
"profile": "string"
},
"azure": {"container_name": "string",
"account_name": "string",
"secret_access_key": "string",
"profile": "string"
},
"google-cloud": {"access_key_id": "string",
"bucket": "string",
"secret_access_key": "string",
"profile": "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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0
},
"status": "string"
}
]
}

Create offload target

Creates an offload target, connecting it to an array. Before you can connect to, manage, and replicate to an offload target, the Purity Run app must be installed.

query Parameters

initialize	boolean If set to `true`, initializes the Amazon S3/Azure Blob container/Google Cloud Storage 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 NFS settings. Deprecated from version 6.6.0 onwards - Contact support for additional information.
	object S3 settings.
	object Microsoft Azure Blob storage settings.
	object Google Cloud Storage settings.

Responses

Request samples

Payload

Content type

application/json

{"nfs": {"address": "string",
"mount_options": "string",
"mount_point": "string",
"profile": "string"
},
"s3": {"access_key_id": "string",
"bucket": "string",
"placement_strategy": "string",
"secret_access_key": "string",
"uri": "string",
"auth_region": "string",
"profile": "string"
},
"azure": {"container_name": "string",
"account_name": "string",
"secret_access_key": "string",
"profile": "string"
},
"google-cloud": {"access_key_id": "string",
"bucket": "string",
"secret_access_key": "string",
"profile": "string"
}
}

Response samples

Content type

application/json

{"items": [{"nfs": {"address": "string",
"mount_options": "string",
"mount_point": "string",
"profile": "string"
},
"s3": {"access_key_id": "string",
"bucket": "string",
"placement_strategy": "string",
"secret_access_key": "string",
"uri": "string",
"auth_region": "string",
"profile": "string"
},
"azure": {"container_name": "string",
"account_name": "string",
"secret_access_key": "string",
"profile": "string"
},
"google-cloud": {"access_key_id": "string",
"bucket": "string",
"secret_access_key": "string",
"profile": "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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0
},
"status": "string"
}
]
}

Delete offload target

Deletes 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

Displays 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",
"member": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
],
"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"
},
"time_remaining": 0,
"requested_promotion_state": "string",
"promotion_status": "string",
"link_source_count": 1,
"link_target_count": 1,
"array_count": 1,
"eradication_config": {"manual_eradication": "all-enabled"
},
"quota_limit": 0,
"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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0,
"replication": 0,
"shared_effective": 0,
"replication_effective": 0
},
"members": [{"id": "string",
"name": "string",
"resource_type": "string"
}
]
}
],
"total": [{"id": "string",
"name": "string",
"arrays": [{"id": "string",
"name": "string",
"frozen_at": 1492662000,
"mediator_status": "string",
"pre_elected": true,
"progress": 0.66,
"status": "resyncing",
"member": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
],
"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"
},
"time_remaining": 0,
"requested_promotion_state": "string",
"promotion_status": "string",
"link_source_count": 1,
"link_target_count": 1,
"array_count": 1,
"eradication_config": {"manual_eradication": "all-enabled"
},
"quota_limit": 0,
"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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0,
"replication": 0,
"shared_effective": 0,
"replication_effective": 0
},
"members": [{"id": "string",
"name": "string",
"resource_type": "string"
}
]
}
]
}

Create a pod

Creates a pod on the local array. Each pod must be given a unique name across the arrays to which they are stretched. 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, and then stretch the pod to another connected array.

query Parameters

allow_throttle	boolean If set to `true`, allows operation to fail if array health is not optimal.
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 `[]`.
quota_limit	integer <int64> [ 1048576 .. 4503599627370496 ] The logical quota limit of the pod, measured in bytes. Must be a multiple of 512.

Responses

Request samples

Payload

Content type

application/json

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

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",
"member": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
],
"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"
},
"time_remaining": 0,
"requested_promotion_state": "string",
"promotion_status": "string",
"link_source_count": 1,
"link_target_count": 1,
"array_count": 1,
"eradication_config": {"manual_eradication": "all-enabled"
},
"quota_limit": 0,
"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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0,
"replication": 0,
"shared_effective": 0,
"replication_effective": 0
},
"members": [{"id": "string",
"name": "string",
"resource_type": "string"
}
]
}
]
}

Delete a pod

Deletes a pod that has been destroyed and is pending eradication. Eradicated pods cannot be recovered. Pods are destroyed using 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`.
eradicate_contents	boolean Set to `true` to eradicate contents (e.g., volumes, protection groups, snapshots) and containers (e.g., realms, pods, volume groups). This enables you to eradicate containers with contents.

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

Modify a pod

Modifies pod details.

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`.
abort_quiesce	boolean Set to `true` to promote the pod when the `pod-replica-link` is in the `quiescing` state and abort when waiting for the `pod-replica-link` to complete the quiescing operation.
quiesce	boolean Set to `true` to demote the pod after the `pod-replica-link` goes into `quiesced` state and allow the pod to become a target of the remote pod. This ensures that all local data has been replicated to the remote pod before the pod is demoted.
skip_quiesce	boolean Set to `true` to demote the pod without quiescing the `pod-replica-link` and allow the pod to become a target of the remote pod. This stops all pending replication to the remote pod.
promote_from	string The `undo-demote` pod that should be used to promote the pod. After the pod has been promoted, it will have the same data as the `undo-demote` pod and the `undo-demote` pod will be eradicated.
destroy_contents	boolean Set to `true` to destroy contents (e.g., volumes, protection groups, snapshots) and containers (e.g., realms, pods, volume groups), including eradicating containers with content.
from_member_ids	Array of strings Move the resource from the specified local member realm or array. This should be a union of all local realms and arrays from which the resource should be removed. Enter multiple IDs in a comma-separated format.
from_member_names	Array of strings Move the resource from the specified local member realm or array. This should be a union of all local realms and arrays to be removed from the specified resource. Enter multiple names in a comma-separated format.
to_member_ids	Array of strings The resource will be moved to the specified local member realm or array. Enter multiple IDs in a comma-separated format.
to_member_names	Array of strings The resource will be moved to the specified local member realm or array. Enter multiple names in a comma-separated format.
move_with_host_names	Array of strings The hosts to be moved together with the pods to the specified local member realm or array. Enter multiple names in a comma-separated format.
move_with_host_group_names	Array of strings The host groups to be moved together with the pods to the specified local member realm or array. All the hosts in the host groups will also be moved. Enter multiple names in a comma-separated format.

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.
requested_promotion_state	string Patch `requested_promotion_state` to `demoted` to demote the pod so that it can be used as a link target for continuous replication between pods. Demoted pods do not accept write requests, and a destroyed version of the pod with `undo-demote` appended to the pod name is created on the array with the state of the pod when it was in the promoted state. Patch `requested_promotion_state` to `promoted` to start the process of promoting the pod. The `promotion_status` indicates when the pod has been successfully promoted. Promoted pods stop incorporating replicated data from the source pod and start accepting write requests. The replication process does not stop when the source pod continues replicating data to the pod. The space consumed by the unique replicated data is tracked by the `space.journal` field of the pod.
quota_limit	integer <int64> [ 1048576 .. 4503599627370496 ] The logical quota limit of the pod, measured in bytes. Must be a multiple of 512.
ignore_usage	boolean Set to `true` to set a `quota_limit` that is lower than the existing usage. This ensures that no new volumes can be created until the existing usage drops below the `quota_limit`. If not specified, defaults to `false`.

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",
"requested_promotion_state": "string",
"quota_limit": 1048576,
"ignore_usage": true
}

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",
"member": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
],
"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"
},
"time_remaining": 0,
"requested_promotion_state": "string",
"promotion_status": "string",
"link_source_count": 1,
"link_target_count": 1,
"array_count": 1,
"eradication_config": {"manual_eradication": "all-enabled"
},
"quota_limit": 0,
"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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0,
"replication": 0,
"shared_effective": 0,
"replication_effective": 0
},
"members": [{"id": "string",
"name": "string",
"resource_type": "string"
}
]
}
]
}

List pods and their the array members

This field has been deprecated. Use pods/members instead. Returns a list of pods and the local and remote arrays over which the pods are stretched. Pods with realm members will not be returned. 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

This field has been deprecated. Use pods/members instead. 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

This field has been deprecated. Use pods/members instead. 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 pods and their members

Displays a list of pods and the local and remote members over which the pods are stretched. Currently either array or realm is supported as member.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
pod_names	Array of strings Performs the operation on the unique pod name specified. Enter multiple names in comma-separated format. For example, `pod01,pod02`.
pod_ids	Array of strings A comma-separated list of pod 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": [{"pod": {"id": "string",
"name": "string",
"resource_type": "string"
},
"member": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

Creatse a member to add to a pod

Creates a stretched pod on 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 member_names or member_ids parameter represents the array over which the pod is to be stretched. Both pod and member must be specified by name or ID.

query Parameters

pod_names	Array of strings Performs the operation on the unique pod name specified. Enter multiple names in comma-separated format. For example, `pod01,pod02`.
pod_ids	Array of strings A comma-separated list of pod 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": [{"pod": {"id": "string",
"name": "string",
"resource_type": "string"
},
"member": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

Delete a member from a pod

Unstretches a pod from an array, collapsing the pod to a member array. Unstretch a pod from an array when the volumes within the stretched pod no longer need to be synchronously replicated between the two members. 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 member 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 member_names parameter represents the name of the array from which the pod is to be unstretched. Both pod and member must be specified by name or ID.

query Parameters

pod_names	Array of strings Performs the operation on the unique pod name specified. Enter multiple names in comma-separated format. For example, `pod01,pod02`.
pod_ids	Array of strings A comma-separated list of pod 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

Displays 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.
protocol	string Protocol type. Valid values are `nfs`, `smb`, and `all`.
protocol_group	string Protocol group type. Valid values are `block`, `file`, and `all`.
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": [{"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,
"service_usec_per_read_op_cache_reduction": 0,
"id": "string",
"name": "string",
"others_per_sec": 0,
"usec_per_other_op": 0
}
],
"total": [{"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,
"service_usec_per_read_op_cache_reduction": 0,
"id": "string",
"name": "string",
"others_per_sec": 0,
"usec_per_other_op": 0
}
]
}

List pod performance data by array

Displays 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.
protocol	string Protocol type. Valid values are `nfs`, `smb`, and `all`.
protocol_group	string Protocol group type. Valid values are `block`, `file`, and `all`.
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": [{"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,
"service_usec_per_read_op_cache_reduction": 0,
"id": "string",
"name": "string",
"others_per_sec": 0,
"usec_per_other_op": 0,
"array": {"id": "string",
"name": "string"
}
}
],
"total": [{"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,
"service_usec_per_read_op_cache_reduction": 0,
"id": "string",
"name": "string",
"others_per_sec": 0,
"usec_per_other_op": 0,
"array": {"id": "string",
"name": "string"
}
}
]
}

List pod replication performance data

Displays pod replication performance data. The data returned is the real-time and historical performance data for each replication type at the pod level. Values include continuous, periodic, resync, and sync.

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`, only return the aggregate value of all items after filtering. For real-time performance, the values are aggregated for the latest timestamp. For historical performance, the values are aggregated for each timestamp from `start_time` to `end_time`. 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": [{"continuous_bytes_per_sec": {"from_remote_bytes_per_sec": 0,
"to_remote_bytes_per_sec": 0,
"total_bytes_per_sec": 0
},
"resync_bytes_per_sec": {"from_remote_bytes_per_sec": 0,
"to_remote_bytes_per_sec": 0,
"total_bytes_per_sec": 0
},
"sync_bytes_per_sec": {"from_remote_bytes_per_sec": 0,
"to_remote_bytes_per_sec": 0,
"total_bytes_per_sec": 0
},
"periodic_bytes_per_sec": {"from_remote_bytes_per_sec": 0,
"to_remote_bytes_per_sec": 0,
"total_bytes_per_sec": 0
},
"total_bytes_per_sec": 0,
"pod": {"id": "string",
"name": "string"
},
"time": 0
}
],
"total": [{"continuous_bytes_per_sec": {"from_remote_bytes_per_sec": 0,
"to_remote_bytes_per_sec": 0,
"total_bytes_per_sec": 0
},
"resync_bytes_per_sec": {"from_remote_bytes_per_sec": 0,
"to_remote_bytes_per_sec": 0,
"total_bytes_per_sec": 0
},
"sync_bytes_per_sec": {"from_remote_bytes_per_sec": 0,
"to_remote_bytes_per_sec": 0,
"total_bytes_per_sec": 0
},
"periodic_bytes_per_sec": {"from_remote_bytes_per_sec": 0,
"to_remote_bytes_per_sec": 0,
"total_bytes_per_sec": 0
},
"total_bytes_per_sec": 0,
"pod": {"id": "string",
"name": "string"
},
"time": 0
}
]
}

List pod replication performance data by array

Displays pod replication performance data, organized by array. The data returned is the real-time and historical performance data for each replication type at the pod level. Values include continuous, periodic, resync, and sync.

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": [{"continuous_bytes_per_sec": {"from_remote_bytes_per_sec": 0,
"to_remote_bytes_per_sec": 0,
"total_bytes_per_sec": 0
},
"resync_bytes_per_sec": {"from_remote_bytes_per_sec": 0,
"to_remote_bytes_per_sec": 0,
"total_bytes_per_sec": 0
},
"sync_bytes_per_sec": {"from_remote_bytes_per_sec": 0,
"to_remote_bytes_per_sec": 0,
"total_bytes_per_sec": 0
},
"periodic_bytes_per_sec": {"from_remote_bytes_per_sec": 0,
"to_remote_bytes_per_sec": 0,
"total_bytes_per_sec": 0
},
"total_bytes_per_sec": 0,
"pod": {"id": "string",
"name": "string"
},
"time": 0,
"array": {"id": "string",
"name": "string"
}
}
],
"total": [{"continuous_bytes_per_sec": {"from_remote_bytes_per_sec": 0,
"to_remote_bytes_per_sec": 0,
"total_bytes_per_sec": 0
},
"resync_bytes_per_sec": {"from_remote_bytes_per_sec": 0,
"to_remote_bytes_per_sec": 0,
"total_bytes_per_sec": 0
},
"sync_bytes_per_sec": {"from_remote_bytes_per_sec": 0,
"to_remote_bytes_per_sec": 0,
"total_bytes_per_sec": 0
},
"periodic_bytes_per_sec": {"from_remote_bytes_per_sec": 0,
"to_remote_bytes_per_sec": 0,
"total_bytes_per_sec": 0
},
"total_bytes_per_sec": 0,
"pod": {"id": "string",
"name": "string"
},
"time": 0,
"array": {"id": "string",
"name": "string"
}
}
]
}

List pod space information

Displays 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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0,
"replication": 0,
"shared_effective": 0,
"replication_effective": 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,
"used_provisioned": 19937690345472,
"total_used": 0,
"footprint": 0,
"replication": 0,
"shared_effective": 0,
"replication_effective": 0
},
"time": 0
}
]
}

Create an attempt to clone a pod

Creates an attempt to clone a pod on the local array without actually cloning it, to test if the pod can be successfully cloned. It does not suppport pod creation.

query Parameters

allow_throttle	boolean If set to `true`, allows operation to fail if array health is not optimal.
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 `[]`.
quota_limit	integer <int64> [ 1048576 .. 4503599627370496 ] The logical quota limit of the pod, measured in bytes. Must be a multiple of 512.

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"items": [{"component_address": "10.230.94.21",
"component_name": "CT0",
"description": "Testing phonehome connectivity",
"destination": "ra.cloud-support.purestorage.com",
"enabled": true,
"result_details": "Timeout connecting to phonehome endpoint",
"success": true,
"test_type": "phonehome",
"resource": {"id": "string",
"name": "string"
}
}
]
}

Pod Replica Links

Pod replica links are created by associating a source pod with a demoted pod, making the demoted pod the target pod of the source pod. The direction of the replica link is from the promoted source pod to the demoted target pod. Replica links can be created in either direction between the same two FlashArrays. The target pod of a replica link cannot be on the same FlashArray as the source pod.

List pod replica links

Displays the list of pod replica links that are configured between arrays.

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.
local_pod_ids	Array of strings A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_names` query parameter.
local_pod_names	Array of strings A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_ids` query parameter.
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.
remote_ids	Array of strings A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_names` query parameter.
remote_names	Array of strings A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_ids` query parameter.
remote_pod_ids	Array of strings A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_names` query parameter.
remote_pod_names	Array of strings A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_ids` query parameter.
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",
"direction": "string",
"lag": 0,
"local_pod": {"id": "string",
"name": "string"
},
"paused": true,
"recovery_point": 1565034592494,
"remotes": [{"id": "string",
"name": "string"
}
],
"remote_pod": {"id": "string",
"name": "string"
},
"status": "string"
}
]
}

Create pod replica links

Creates pod replica links between two arrays. The local_pod_names and remote_pod_names are required. Valid values are replicating, baselining, paused, unhealthy, quiescing, and quiesced. A status of replicating indicates that the source array is replicating to the target array. A status of baselining indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger the baselining status to recur. A status of paused indicates that data transfer between objects has stopped. A status of unhealthy indicates that the link is currently unhealthy and customers must perform some health checks to determine the cause. A status of quiescing indicates that the source pod is not accepting new write requests but the most recent changes to the source have not arrived on the target. A status of quiesced indicates that the source pod has been demoted and all changes have been replicated to the target pod.

query Parameters

local_pod_ids	Array of strings A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_names` query parameter.
local_pod_names	Array of strings A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_ids` query parameter.
remote_ids	Array of strings A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_names` query parameter.
remote_names	Array of strings A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_ids` query parameter.
remote_pod_ids	Array of strings A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_names` query parameter.
remote_pod_names	Array of strings A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_ids` query parameter.

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": [{"id": "string",
"direction": "string",
"lag": 0,
"local_pod": {"id": "string",
"name": "string"
},
"paused": true,
"recovery_point": 1565034592494,
"remotes": [{"id": "string",
"name": "string"
}
],
"remote_pod": {"id": "string",
"name": "string"
},
"status": "string"
}
]
}

Delete pod replica links

Deletes pod replica links. The local_pod_names and remote_pod_names are required. Valid values are replicating, baselining, paused, unhealthy, quiescing, and quiesced. A status of replicating indicates that the source array is replicating to the target array. A status of baselining indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger the baselining status to recur. A status of paused indicates that data transfer between objects has stopped. A status of unhealthy indicates that the link is currently unhealthy and customers must perform some health checks to determine the cause. A status of quiescing indicates that the source pod is not accepting new write requests but the most recent changes to the source have not arrived on the target. A status of quiesced indicates that the source pod has been demoted and all changes have been replicated to the target 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.
local_pod_ids	Array of strings A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_names` query parameter.
local_pod_names	Array of strings A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_ids` query parameter.
remote_pod_ids	Array of strings A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_names` query parameter.
remote_pod_names	Array of strings A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_ids` query parameter.

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

Modify pod replica links

Modifies pod replica links. The local_pod_names and remote_pod_names are required. Valid values are replicating, baselining, paused, unhealthy, quiescing, and quiesced. A status of replicating indicates that the source array is replicating to the target array. A status of baselining indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger the baselining status to recur. A status of paused indicates that data transfer between objects has stopped. A status of unhealthy indicates that the link is currently unhealthy and customers must perform some health checks to determine the cause. A status of quiescing indicates that the source pod is not accepting new write requests but the most recent changes to the source have not arrived on the target. A status of quiesced indicates that the source pod has been demoted and all changes have been replicated to the target 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.
local_pod_ids	Array of strings A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_names` query parameter.
local_pod_names	Array of strings A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_ids` query parameter.
remote_ids	Array of strings A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_names` query parameter.
remote_names	Array of strings A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_ids` query parameter.
remote_pod_ids	Array of strings A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_names` query parameter.
remote_pod_names	Array of strings A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_ids` query parameter.

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

paused

boolean

Returns a value of true if the replica link is to be created in a paused state. Returns a value of false if the replica link is to be created not in a paused state. If not specified, defaults to false.

Responses

Request samples

Payload

Content type

application/json

{"paused": true
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"direction": "string",
"lag": 0,
"local_pod": {"id": "string",
"name": "string"
},
"paused": true,
"recovery_point": 1565034592494,
"remotes": [{"id": "string",
"name": "string"
}
],
"remote_pod": {"id": "string",
"name": "string"
},
"status": "string"
}
]
}

List pod replica link lag

Displays the lag in milliseconds that the replication target is behind the source. This is the time difference between the current time and the recovery point.

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.
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.
local_pod_ids	Array of strings A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_names` query parameter.
local_pod_names	Array of strings A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_ids` query parameter.
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.
remote_ids	Array of strings A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_names` query parameter.
remote_names	Array of strings A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_ids` query parameter.
remote_pod_ids	Array of strings A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_names` query parameter.
remote_pod_names	Array of strings A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_ids` query parameter.
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",
"direction": "string",
"lag": {"avg": 0,
"max": 0
},
"local_pod": {"id": "string",
"name": "string"
},
"recovery_point": 1565034592494,
"remotes": [{"id": "string",
"name": "string"
}
],
"remote_pod": {"id": "string",
"name": "string"
},
"status": "string",
"time": 0
}
]
}

<no summary>

query Parameters

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.
local_pod_ids	Array of strings A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_names` query parameter.
local_pod_names	Array of strings A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_ids` query parameter.
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.
remote_ids	Array of strings A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_names` query parameter.
remote_names	Array of strings A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_ids` query parameter.
remote_pod_ids	Array of strings A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_names` query parameter.
remote_pod_names	Array of strings A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_ids` query parameter.
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`, only return the aggregate value of all items after filtering. For real-time performance, the values are aggregated for the latest timestamp. For historical performance, the values are aggregated for each timestamp from `start_time` to `end_time`. 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",
"bytes_per_sec_from_remote": 0,
"bytes_per_sec_to_remote": 0,
"bytes_per_sec_total": 0,
"direction": "string",
"local_pod": {"id": "string",
"name": "string"
},
"remotes": [{"id": "string",
"name": "string"
}
],
"remote_pod": {"id": "string",
"name": "string"
},
"time": 0
}
],
"total": [{"id": "string",
"bytes_per_sec_from_remote": 0,
"bytes_per_sec_to_remote": 0,
"bytes_per_sec_total": 0,
"direction": "string",
"local_pod": {"id": "string",
"name": "string"
},
"remotes": [{"id": "string",
"name": "string"
}
],
"remote_pod": {"id": "string",
"name": "string"
},
"time": 0
}
]
}

List policy mappings

Displays a list of policy mappings.

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.
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.
local_pod_ids	Array of strings A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_names` query parameter.
local_pod_names	Array of strings A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_ids` query parameter.
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.
pod_replica_link_ids	Array of strings A comma-separated list of pod replica link IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned.
remote_ids	Array of strings A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_names` query parameter.
remote_names	Array of strings A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_ids` query parameter.
remote_pod_ids	Array of strings A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_names` query parameter.
remote_pod_names	Array of strings A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_ids` query parameter.
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",
"local_policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"remote_policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"mapping": "string",
"policy_type": "string",
"pod_replica_link": {"id": "string",
"local_pod": {"id": "string",
"name": "string"
},
"remotes": [{"id": "string",
"name": "string"
}
],
"remote_pod": {"id": "string",
"name": "string"
}
},
"direction": "string"
}
]
}

Modify policy mappings

Modifies policy mappings of a replica link. Valid mapping values are connected and disconnected. connected indicates that the source policy and its attachments will be mirrored on the target pod. disconnected indicates that the associated policy and its attachments are independent from any policy on the remote. This operation can only be performed on the target side of a pod replica link.

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.
local_pod_ids	Array of strings A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_names` query parameter.
local_pod_names	Array of strings A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_ids` query parameter.
pod_replica_link_ids	Array of strings A comma-separated list of pod replica link IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned.
remote_ids	Array of strings A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_names` query parameter.
remote_names	Array of strings A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_ids` query parameter.
remote_pod_ids	Array of strings A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_names` query parameter.
remote_pod_names	Array of strings A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_ids` query parameter.
remote_policy_ids	Array of strings A comma-separated list of remote policy IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_policy_names` query parameter.
remote_policy_names	Array of strings A comma-separated list of remote policy names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_policy_ids` query parameter.

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

mapping

string

The mapping to set on this policy mapping. Valid values are connected and disconnected.

Responses

Request samples

Payload

Content type

application/json

{"mapping": "string"
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"local_policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"remote_policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"mapping": "string",
"policy_type": "string",
"pod_replica_link": {"id": "string",
"local_pod": {"id": "string",
"name": "string"
},
"remotes": [{"id": "string",
"name": "string"
}
],
"remote_pod": {"id": "string",
"name": "string"
}
},
"direction": "string"
}
]
}

Policies

Policies are used to create exports (i.e., shares) and schedule snapshots. NFS and SMB policies can be created and have one or more rules applied to them. Each policy can be reused, creating exports for a number of managed directories.

List policies

Displays a list of policies.

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`.

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,
"enabled": true,
"pod": {"id": "string",
"name": "string"
},
"policy_type": "string",
"time_remaining": 0
}
]
}

List management access policies

Displays a list of management access policies.

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.
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": "string",
"name": "string",
"aggregation_strategy": "string",
"enabled": true,
"policy_type": "string",
"rules": [{"role": {"name": "string"
},
"scope": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}
]
}

Create management access policies

Creates one or more management access policies. To copy a policy, thesource_names or source_ids is required, but they cannot be set together. To create a policy from scratch, policy body is required.

query Parameters

names required	Array of strings Performs the operation on the unique name specified. For example, `name01`. Enter multiple names in comma-separated format.
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

enabled	boolean If set to `true`, enables the policy. If set to `false`, disables the policy.
aggregation_strategy	string When set to `least-common-permissions`, any users to whom this policy applies can receive no access rights exceeding those defined in this policy's capability and resource. When this is set to `all-permissions`, any users to whom this policy applies are capable of receiving additional access rights from other policies that apply to them. If not specified, defaults to `all-permissions`.
	Array of objects (_policyrulemanagementaccessRules) List the rules that defines the scoped roles.

Responses

Request samples

Payload

Content type

application/json

{"enabled": true,
"aggregation_strategy": "string",
"rules": [{"role": {"name": "string"
},
"scope": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"aggregation_strategy": "string",
"enabled": true,
"policy_type": "string",
"rules": [{"role": {"name": "string"
},
"scope": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}
]
}

Delete management access policies

Deletes one or more management access policies. The ids or names 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

Modify management access policies

Modifies one or more management access policies. The ids or names is required, but they cannot be set together. For renames, can only specify one old policy in ids or names.

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 The new name for the resource.
aggregation_strategy	string When this is set to `least-common-permissions`, any users to whom this policy applies can receive no access rights exceeding those defined in this policy's capability and resource. When this is set to `all-permissions`, any users to whom this policy applies are capable of receiving additional access rights from other policies that apply to them.
enabled	boolean Sets whether the policy is enabled and grants the permissions specified.
	Array of objects (_policyrulemanagementaccessRules) List the rules that defines the scoped roles.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"aggregation_strategy": "string",
"enabled": true,
"rules": [{"role": {"name": "string"
},
"scope": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"aggregation_strategy": "string",
"enabled": true,
"policy_type": "string",
"rules": [{"role": {"name": "string"
},
"scope": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}
]
}

List management access policy members

Displays a list of management access policy 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.
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 a comma-separated format.
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_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in a comma-separated format.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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": [{"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

Create a membership between an object and a management access policy

Creates a membership between one or more objects and a management access policy.

query Parameters

policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in a comma-separated format.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

Array of objects (_policymemberpostMembers)

A list of resources to which the policy may be applied.

Responses

Request samples

Payload

Content type

application/json

{"members": [{"member": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

Response samples

Content type

application/json

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

Delete membership between management access policies and attached object

Deletes a membership between one or more management access policies and attached object. Thepolicy_ids or policy_names is required, but they cannot be set together. The member_ids or member_names. member_types is also required, but they cannot be set together.

query Parameters

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.
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_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in a comma-separated format.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

List alert-watcher policies

Displays a list of alert-watcher policies.

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`.

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,
"enabled": true,
"pod": {"id": "string",
"name": "string"
},
"policy_type": "string",
"time_remaining": 0
}
]
}

Create alert-watcher policies

Creates one or more alert-watcher policies. To copy a policy, the source_names or source_ids parameter is required, but they cannot be set together. To create a policy from scratch, policy body 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`.
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

enabled

boolean

If set to true, enables the policy. If set to false, disables the policy.

Responses

Request samples

Payload

Content type

application/json

{"enabled": true
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"destroyed": true,
"enabled": true,
"pod": {"id": "string",
"name": "string"
},
"policy_type": "string",
"time_remaining": 0
}
]
}

Delete alert-watcher policies

Deletes one or more alert-watcher policies. 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

Modify alert-watcher policies

Modifies one or more alert-watcher policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false. To rename a policy, set name to the new name. 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 The new name for the resource.
enabled	boolean If set to `true`, enables the policy. If set to `false`, disables the policy.

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"destroyed": true,
"enabled": true,
"pod": {"id": "string",
"name": "string"
},
"policy_type": "string",
"time_remaining": 0
}
]
}

List alert-watcher policy members

Displays a list of alert-watcher policy 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.
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.
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.
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_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0
}
]
}

Create a membership between an object and an alert-watcher policy

Creates a membership between one or more objects and an alert-watcher policy. The policy_ids or policy_names parameter is required, but cannot be set together.

query Parameters

policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

Array of objects (_policymemberpostMembers)

A list of resources to which the policy may be applied.

Responses

Request samples

Payload

Content type

application/json

{"members": [{"member": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

Response samples

Content type

application/json

{"items": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0
}
]
}

Delete membership between alert-watcher policies and attached object

Deletes a membership between one or more alert-watcher policies and attached object. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

query Parameters

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.
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_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

List alert-watcher policy rules

Displays a list of alert-watcher policy rules.

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.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.
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",
"email": "string",
"included_codes": [101
],
"excluded_codes": [101
],
"minimum_notification_severity": "string",
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

Create alert-watcher policy rules

Creates one or more alert-watcher policy rules. Either the 'policy_ids' or 'policy_names' parameter is required, but both parameters cannot be set together.

query Parameters

policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

Array of objects (_policyrulealertwatcherpostRules)

A list of alert-watcher policy rules to create.

Responses

Request samples

Payload

Content type

application/json

{"rules": [{"email": "string",
"included_codes": [101
],
"excluded_codes": [101
],
"minimum_notification_severity": "string"
}
]
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"email": "string",
"included_codes": [101
],
"excluded_codes": [101
],
"minimum_notification_severity": "string",
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

Delete alert-watcher policy rules

Deletes one or more alert-watcher policy rules. Either the 'policy_ids' or 'policy_names' parameter is required, but both parameters 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`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

Modify alert-watcher policy rules

Modifies alert-watcher policy rules.

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`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

Array of objects (_policyrulealertwatcherpatchRules) <= 1 items

Updates an alert-watcher rule in a policy. Only one update object will be accepted.

Responses

Request samples

Payload

Content type

application/json

{"rules": [{"email": "string",
"included_codes": [101
],
"excluded_codes": [101
],
"minimum_notification_severity": "string"
}
]
}

Response samples

Content type

application/json

{"items": [{"name": "string",
"email": "string",
"included_codes": [101
],
"excluded_codes": [101
],
"minimum_notification_severity": "string",
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

List rules of alert-watcher policy rule test

Displays alert-watcher policy rule email test results.

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

{"total_item_count": 0,
"items": [{"component_address": "10.230.94.21",
"component_name": "CT0",
"description": "Testing phonehome connectivity",
"destination": "ra.cloud-support.purestorage.com",
"enabled": true,
"result_details": "Timeout connecting to phonehome endpoint",
"success": true,
"test_type": "phonehome",
"resource": {"name": "string"
}
}
]
}

List audit policies

Displays a list of audit policies.

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`.

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,
"enabled": true,
"pod": {"id": "string",
"name": "string"
},
"policy_type": "string",
"time_remaining": 0,
"log_targets": [{"name": "string",
"resource_type": "string"
}
]
}
]
}

Create audit policies

Creates one or more audit policies. To copy a policy, either the source_names or source_ids parameter is required, but they cannot be set together. To create a policy from scratch, the policy body 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`.
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

enabled	boolean If set to `true`, enables the policy. If set to `false`, disables the policy.
	Array of objects (_referenceNoIdWithType) A list of targets to which audit logs will be sent.

Responses

Request samples

Payload

Content type

application/json

{"enabled": true,
"log_targets": [{"name": "string",
"resource_type": "string"
}
]
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"destroyed": true,
"enabled": true,
"pod": {"id": "string",
"name": "string"
},
"policy_type": "string",
"time_remaining": 0,
"log_targets": [{"name": "string",
"resource_type": "string"
}
]
}
]
}

Delete audit policies

Deletes one or more audit policies. Either 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

Modify audit policies

Modifies one or more audit policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false. To rename a policy, set name to the new name. Either 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 The new name for the resource.
enabled	boolean If set to `true`, enables the policy. If set to `false`, disables the policy.
	Array of objects (_referenceNoIdWithType) A list of targets to which audit logs will be sent. This list, if sent, overrides existing target list.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"enabled": true,
"log_targets": [{"name": "string",
"resource_type": "string"
}
]
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"destroyed": true,
"enabled": true,
"pod": {"id": "string",
"name": "string"
},
"policy_type": "string",
"time_remaining": 0,
"log_targets": [{"name": "string",
"resource_type": "string"
}
]
}
]
}

List audit policy members

Displays a list of audit policy 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.
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.
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.
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_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0
}
]
}

Create a membership between a managed directory and a audit policy

Creates a membership between one or more managed directories and an audit policy. Either the policy_ids or policy_names parameter is required, but they cannot be set together.

query Parameters

policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

Array of objects (_policymemberpostMembers)

A list of resources to which the policy may be applied.

Responses

Request samples

Payload

Content type

application/json

{"members": [{"member": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

Response samples

Content type

application/json

{"items": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0
}
]
}

Delete membership between audit policies and managed directories

Deletes a membership between one or more audit policies and managed directories. Either the policy_ids or policy_names parameter is required, but they cannot be set together. Either the member_ids or member_names parameter is required, but they cannot be set together.

query Parameters

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.
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_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

List auto managed directory policies

Displays a list of auto managed directory policies.

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`.

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,
"enabled": true,
"pod": {"id": "string",
"name": "string"
},
"policy_type": "string",
"time_remaining": 0
}
]
}

Create auto managed directory policies

Creates one or more auto managed directory policies. To copy a policy, set one of either source_names or source_ids. Each policy can only have one entry. To create a policy from scratch, policy body 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`.
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

enabled

boolean

If set to true, enables the policy. If set to false, disables the policy.

Responses

Request samples

Payload

Content type

application/json

{"enabled": true
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"destroyed": true,
"enabled": true,
"pod": {"id": "string",
"name": "string"
},
"policy_type": "string",
"time_remaining": 0
}
]
}

Delete auto managed directory policies

Deletes one or more auto managed directory policies. 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

Modify auto managed directory policies

Modifies one or more auto managed directory policies. To enable a policy, set enabled=true. To disable a policy, set enabled=true. To rename a policy, set name to the new name. 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 The new name for the resource.
enabled	boolean If set to `true`, enables the policy. If set to `false`, disables the policy.

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"destroyed": true,
"enabled": true,
"pod": {"id": "string",
"name": "string"
},
"policy_type": "string",
"time_remaining": 0
}
]
}

List auto managed directories policy members

Displays a list of auto managed directory policy 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.
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.
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.
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_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0
}
]
}

Create auto managed directory policies

Creates a membership between one or more resources with an auto managed directory policy. Applicable resources are directories. The policy_ids or policy_names parameter is required, but they cannot be set together.

query Parameters

policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

Array of objects (_policymemberpostMembers)

A list of resources to which the policy may be applied.

Responses

Request samples

Payload

Content type

application/json

{"members": [{"member": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

Response samples

Content type

application/json

{"items": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0
}
]
}

Delete auto managed directory policies

Deletes one or more auto managed directory policies from resources. The policy_ids or policy_names parameter is required, but they cannot be set together. The member_ids or member_names parameter is required, but they cannot be set together.

query Parameters

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.
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_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

List policy members

Displays a list of policy 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.
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.
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.
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_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0
}
]
}

List NFS policies

Displays a list of NFS policies.

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`.

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,
"enabled": true,
"pod": {"id": "string",
"name": "string"
},
"policy_type": "string",
"time_remaining": 0,
"user_mapping_enabled": true,
"nfs_version": ["nfsv3-partial"
],
"security": ["auth_sys-partial"
],
"policy_mapping": {"mapping": "string",
"remote_policy": "string"
}
}
]
}

Create NFS policies

Creates one or more NFS policies or copies an existing policy. To copy a policy, the source_names or source_ids parameter is required, but they cannot be set together. To create a policy, policy body 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`.
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

enabled	boolean If set to `true`, enables the policy. If set to `false`, disables the policy.
user_mapping_enabled	boolean If set to `true`, FlashArray queries the joined AD/OpenLDAP server to find the user corresponding to the incoming UID. If set to `false`, users are defined by UID/GID pair. If not specified, defaults to `true`.
	object (_policynfspostPolicyMapping) If set specifies the initial mapping of the policy upon its creation across a pod replica link. Policy being created must be in a source pod of a replica-link.

Responses

Request samples

Payload

Content type

application/json

{"enabled": true,
"user_mapping_enabled": true,
"policy_mapping": {"mapping": "string"
}
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"destroyed": true,
"enabled": true,
"pod": {"id": "string",
"name": "string"
},
"policy_type": "string",
"time_remaining": 0,
"user_mapping_enabled": true,
"nfs_version": ["nfsv3-partial"
],
"security": ["auth_sys-partial"
],
"policy_mapping": {"mapping": "string",
"remote_policy": "string"
}
}
]
}

Delete NFS policies

Deletes one or more NFS policies. 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

Modify NFS policies

Modifies one or more NFS policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false. To rename a policy, set name to the new name. 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 The new name for the resource.
enabled	boolean If set to `true`, enables the policy. If set to `false`, disables the policy.
user_mapping_enabled	boolean If set to `true`, FlashArray queries the joined AD/OpenLDAP server to find the user corresponding to the incoming UID. If set to `false`, users are defined by UID/GID pair.
nfs_version	Array of strings NFS protocol version allowed for the export to set for the policy. This operation updates all rules of the specified policy. Valid values are `nfsv3` and `nfsv4`.
security	Array of strings The security flavors to use for accessing files on this mount point. Values include `auth_sys`, `krb5`, `krb5i`, and `krb5p`. If the server does not support the requested flavor, the mount operation fails. This operation updates all rules of the specified policy. If `auth_sys`, the client is trusted to specify the identity of the user. If `krb5`, cryptographic proof of the identity of the user is provided in each RPC request. This provides strong verification of the identity of users accessing data on the server. Note that additional configuration besides adding this mount option is required to enable Kerberos security. If `krb5i`, integrity checking is added to krb5. This ensures the data has not been tampered with. If `krb5p`, integrity checking and encryption is added to `krb5`. This is the most secure setting, but it also involves the most performance overhead.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"enabled": true,
"user_mapping_enabled": true,
"nfs_version": ["nfsv3"
],
"security": ["auth_sys"
]
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"destroyed": true,
"enabled": true,
"pod": {"id": "string",
"name": "string"
},
"policy_type": "string",
"time_remaining": 0,
"user_mapping_enabled": true,
"nfs_version": ["nfsv3-partial"
],
"security": ["auth_sys-partial"
],
"policy_mapping": {"mapping": "string",
"remote_policy": "string"
}
}
]
}

List NFS client policy rules

Displays a list of NFS client policy rules.

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.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.
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": [{"access": "string",
"client": "string",
"name": "string",
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"permission": "string",
"anongid": "65530",
"anonuid": "65530",
"destroyed": true,
"time_remaining": 0,
"nfs_version": ["nfsv3"
],
"security": ["auth_sys"
]
}
]
}

Create NFS client policy rules

Creates one or more NFS client policy rules. The policy_ids or policy_names parameter is required, but cannot be set together.

query Parameters

policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

Array of objects (_policyrulenfsclientpostRules)

A list of NFS policy rules to create.

Responses

Request samples

Payload

Content type

application/json

{"rules": [{"access": "string",
"anongid": "65530",
"anonuid": "65530",
"client": "string",
"nfs_version": ["nfsv3"
],
"permission": "string",
"security": ["auth_sys"
]
}
]
}

Response samples

Content type

application/json

{"items": [{"access": "string",
"client": "string",
"name": "string",
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"permission": "string",
"anongid": "65530",
"anonuid": "65530",
"destroyed": true,
"time_remaining": 0,
"nfs_version": ["nfsv3"
],
"security": ["auth_sys"
]
}
]
}

Delete NFS client policy rules.

Deletes one or more NFS client policy rules. The policy_ids or policy_names parameter is required, but 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`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

List NFS policy members

Displays a list of NFS policy 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.
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.
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.
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_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0,
"export_name": "string",
"status": "string"
}
]
}

Create NFS policies

Creates a membership between one or more resources and an NFS policy. Applicable resources are directories. The policy_ids or policy_names parameter is required, but cannot be set together.

query Parameters

policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

Array of objects (_policymemberexportpostMembers)

A list of directories to which the export policy may be applied.

Responses

Request samples

Payload

Content type

application/json

{"members": [{"export_enabled": false,
"export_name": "string",
"member": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

Response samples

Content type

application/json

{"items": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0,
"export_name": "string",
"status": "string"
}
]
}

Delete NFS policies

Deletes one or more NFS policies from resources. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

query Parameters

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.
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_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

List password policies

Displays a list of password policies.

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.
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": "string",
"name": "string",
"policy_type": "string",
"enabled": true,
"lockout_duration": 3600000,
"max_login_attempts": 10,
"min_password_length": 1,
"password_history": 5,
"min_password_age": 86400000,
"min_character_groups": 3,
"min_characters_per_group": 1,
"enforce_username_check": true,
"enforce_dictionary_check": true
}
]
}

Modify password policies

Modifies one or more password policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false.

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.
enabled	boolean Returns a value of `true` if the policy is enabled.
lockout_duration	integer <int64> [ 1000 .. 7776000000 ] The lockout duration, in milliseconds, if a user is locked out after reaching the maximum number of login attempts. Ranges from 1 second to 90 days.
max_login_attempts	integer <int32> [ 1 .. 100 ] Maximum number of failed login attempts allowed before the user is locked out.
min_password_length	integer <int32> [ 1 .. 100 ] Minimum password length. If not specified, defaults to 1.
password_history	integer <int32> [ 0 .. 64 ] The number of passwords tracked to prevent reuse of passwords.
min_password_age	integer <int64> [ 0 .. 604800000 ] The minimum age, in milliseconds, of password before password change is allowed. Ranges from 0 ms to 7 days
min_character_groups	integer <int32> [ 0 .. 4 ] The minimum number of character groups ([a-z], [A-Z], [0-9], other) required to be present in a password.
min_characters_per_group	integer <int32> >= 1 The minimum number of characters per group to count the group as present. Maximum is limited by the minimum password length divided by the number of character groups (e.g. min_password_length = 9, min_character_groups = 4, then maximum is 2).
enforce_username_check	boolean If `true`, the username cannot be a substring of the password. It only applies to usernames of 3 characters and longer.
enforce_dictionary_check	boolean If `true`, test password against dictionary of known leaked passwords. Only applies to passwords longer than 6 characters.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"enabled": true,
"lockout_duration": 3600000,
"max_login_attempts": 10,
"min_password_length": 1,
"password_history": 5,
"min_password_age": 86400000,
"min_character_groups": 3,
"min_characters_per_group": 1,
"enforce_username_check": true,
"enforce_dictionary_check": true
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"policy_type": "string",
"enabled": true,
"lockout_duration": 3600000,
"max_login_attempts": 10,
"min_password_length": 1,
"password_history": 5,
"min_password_age": 86400000,
"min_character_groups": 3,
"min_characters_per_group": 1,
"enforce_username_check": true,
"enforce_dictionary_check": true
}
]
}

List quota policies

Displays a list of quota policies.

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`.

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,
"enabled": true,
"pod": {"id": "string",
"name": "string"
},
"policy_type": "string",
"time_remaining": 0
}
]
}

Create quota policies

Creates one or more quota policies. To copy a policy, the source_names or source_ids parameter is required, but they cannot be set together. To create a policy from scratch, policy body 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`.
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

enabled

boolean

If set to true, enables the policy. If set to false, disables the policy.

Responses

Request samples

Payload

Content type

application/json

{"enabled": true
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"destroyed": true,
"enabled": true,
"pod": {"id": "string",
"name": "string"
},
"policy_type": "string",
"time_remaining": 0
}
]
}

Delete quota policies

Deletes one or more quota policies. 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

Modify quota policies

Modifies one or more quota policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false. To rename a policy, set name to the new name. 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`.
ignore_usage	boolean Flag used to override checks for quota management operations. If set to `true`, directory usage is not checked against the `quota_limits` that are set. If set to `false`, the actual logical bytes in use are prevented from exceeding the limits set on the directory. Client operations might be impacted. If the limit exceeds the quota, the client operation is not allowed. 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.

Request Body schema: application/json

name	string The new name for the resource.
enabled	boolean If set to `true`, enables the policy. If set to `false`, disables the policy.

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"destroyed": true,
"enabled": true,
"pod": {"id": "string",
"name": "string"
},
"policy_type": "string",
"time_remaining": 0
}
]
}

List quota policy members

Displays a list of quota policy 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.
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.
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.
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_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0
}
]
}

Create a membership between a managed directory and a quota policy

Creates a membership between one or more managed directories and a quota policy. The policy_ids or policy_names parameter is required, but cannot be set together.

query Parameters

policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.
ignore_usage	boolean Flag used to override checks for quota management operations. If set to `true`, directory usage is not checked against the `quota_limits` that are set. If set to `false`, the actual logical bytes in use are prevented from exceeding the limits set on the directory. Client operations might be impacted. If the limit exceeds the quota, the client operation is not allowed. 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.

Request Body schema: application/json

Array of objects (_policymemberpostMembers)

A list of resources to which the policy may be applied.

Responses

Request samples

Payload

Content type

application/json

{"members": [{"member": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

Response samples

Content type

application/json

{"items": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0
}
]
}

Delete membership between quota policies and managed directories

Deletes a membership between one or more quota policies and managed directories. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

query Parameters

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.
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_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

List quota policy rules

Displays a list of quota policy rules.

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.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.
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": [{"enforced": true,
"quota_limit": 0,
"name": "string",
"notifications": "string",
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"destroyed": true,
"time_remaining": 0
}
]
}

Create quota policy rules

Creates one or more quota policy rules. The policy_ids or policy_names parameter is required, but cannot be set together.

query Parameters

policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.
ignore_usage	boolean Flag used to override checks for quota management operations. If set to `true`, directory usage is not checked against the `quota_limits` that are set. If set to `false`, the actual logical bytes in use are prevented from exceeding the limits set on the directory. Client operations might be impacted. If the limit exceeds the quota, the client operation is not allowed. 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.

Request Body schema: application/json

Array of objects (_policyrulequotapostRules)

A list of quota policy rules to create.

Responses

Request samples

Payload

Content type

application/json

{"rules": [{"enforced": true,
"quota_limit": 0,
"notifications": "string"
}
]
}

Response samples

Content type

application/json

{"items": [{"enforced": true,
"quota_limit": 0,
"name": "string",
"notifications": "string",
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"destroyed": true,
"time_remaining": 0
}
]
}

Delete quota policy rules

Deletes one or more quota policy rules. The policy_ids or policy_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`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

Modify quota policy rules

Modifies quota policy rules.

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`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.
ignore_usage	boolean Flag used to override checks for quota management operations. If set to `true`, directory usage is not checked against the `quota_limits` that are set. If set to `false`, the actual logical bytes in use are prevented from exceeding the limits set on the directory. Client operations might be impacted. If the limit exceeds the quota, the client operation is not allowed. 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.

Request Body schema: application/json

Array of objects (_policyrulequotapatchRules) <= 1 items

Updates rules in a policy and accepts a single-rule update object. The list can contain only one item that will update all the specified rules.

Responses

Request samples

Payload

Content type

application/json

{"rules": [{"enforced": true,
"quota_limit": 0,
"notifications": "string"
}
]
}

Response samples

Content type

application/json

{"items": [{"enforced": true,
"quota_limit": 0,
"name": "string",
"notifications": "string",
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"destroyed": true,
"time_remaining": 0
}
]
}

List SMB policies

Displays a list of SMB policies.

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`.

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,
"enabled": true,
"pod": {"id": "string",
"name": "string"
},
"policy_type": "string",
"time_remaining": 0,
"access_based_enumeration_enabled": true,
"policy_mapping": {"mapping": "string",
"remote_policy": "string"
}
}
]
}

Create SMB policies

Creates one or more SMB policies. To copy a policy, set one of either source_names or source_ids. Each policy can only have one entry. To create a policy from scratch, policy body is required. To create an SMB policy with access based enumeration enabled, set access_based_enumeration_enabled=true.

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_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

enabled	boolean If set to `true`, enables the policy. If set to `false`, disables the policy.
access_based_enumeration_enabled	boolean If set to `true`, enables access based enumeration on the policy. When access based enumeration is enabled on a policy, files and folders within exports that are attached to the policy will be hidden from users who do not have permission to view them. If not specified, defaults to `false`.
	object (_policynfspostPolicyMapping) If set specifies the initial mapping of the policy upon its creation across a pod replica link. Policy being created must be in a source pod of a replica-link.

Responses

Request samples

Payload

Content type

application/json

{"enabled": true,
"access_based_enumeration_enabled": true,
"policy_mapping": {"mapping": "string"
}
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"destroyed": true,
"enabled": true,
"pod": {"id": "string",
"name": "string"
},
"policy_type": "string",
"time_remaining": 0,
"access_based_enumeration_enabled": true,
"policy_mapping": {"mapping": "string",
"remote_policy": "string"
}
}
]
}

Delete SMB policies

Deletes one or more SMB policies. 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

Modify SMB policies

Modifies one or more SMB policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false. To enable access based enumeration, set access_based_enumeration_enabled=true. To disable access based enumeration, set access_based_enumeration_enabled=false. To rename a policy, set name to the new name. 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 The new name for the resource.
enabled	boolean If set to `true`, enables the policy. If set to `false`, disables the policy.
access_based_enumeration_enabled	boolean If set to `true`, enables access based enumeration on the policy. When access based enumeration is enabled on a policy, files and folders within exports that are attached to the policy will be hidden from users who do not have permission to view them.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"enabled": true,
"access_based_enumeration_enabled": true
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"destroyed": true,
"enabled": true,
"pod": {"id": "string",
"name": "string"
},
"policy_type": "string",
"time_remaining": 0,
"access_based_enumeration_enabled": true,
"policy_mapping": {"mapping": "string",
"remote_policy": "string"
}
}
]
}

List SMB client policy rules

Displays a list of SMB client policy rules.

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.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.
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": [{"anonymous_access_allowed": true,
"client": "string",
"name": "string",
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"smb_encryption_required": true,
"destroyed": true,
"time_remaining": 0
}
]
}

Create SMB client policy rules

Creates one or more SMB client policy rules. The policy_ids or policy_names parameter is required, but cannot be set together.

query Parameters

policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

Array of objects (_policyrulesmbclientpostRules)

A list of SMB policy rules to create.

Responses

Request samples

Payload

Content type

application/json

{"rules": [{"anonymous_access_allowed": true,
"client": "string",
"smb_encryption_required": true
}
]
}

Response samples

Content type

application/json

{"items": [{"anonymous_access_allowed": true,
"client": "string",
"name": "string",
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"smb_encryption_required": true,
"destroyed": true,
"time_remaining": 0
}
]
}

Delete SMB client policy rules.

Deletes one or more SMB client policy rules. The policy_ids or policy_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`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

List SMB policy members

Displays a list of SMB policy 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.
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.
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.
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_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0,
"export_name": "string",
"status": "string"
}
]
}

Create SMB policies

Creates a membership between one or more resources and an SMB policy. Applicable resources are directories. The policy_ids or policy_names parameter is required, but cannot be set together.

query Parameters

policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

Array of objects (_policymemberexportpostMembers)

A list of directories to which the export policy may be applied.

Responses

Request samples

Payload

Content type

application/json

{"members": [{"export_enabled": false,
"export_name": "string",
"member": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

Response samples

Content type

application/json

{"items": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0,
"export_name": "string",
"status": "string"
}
]
}

Delete SMB policies

Deletes one or more SMB policies from resources. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

query Parameters

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.
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_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

List snapshot policies

Displays a list of snapshot policies.

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`.

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,
"enabled": true,
"pod": {"id": "string",
"name": "string"
},
"policy_type": "string",
"time_remaining": 0
}
]
}

Create snapshot policies

Creates one or more snapshot policies. To copy a policy, set one of either source_names or source_ids. Each policy can only have one entry. To create a policy from scratch, policy body 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`.
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

enabled

boolean

If set to true, enables the policy. If set to false, disables the policy.

Responses

Request samples

Payload

Content type

application/json

{"enabled": true
}

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"destroyed": true,
"enabled": true,
"pod": {"id": "string",
"name": "string"
},
"policy_type": "string",
"time_remaining": 0
}
]
}

Delete snapshot policies

Deletes one or more snapshot policies. 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

Modify snapshot policies

Modifies one or more snapshot policies. To enable a policy, set enabled=true. To disable a policy, set enabled=true. To rename a policy, set name to the new name. 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 The new name for the resource.
enabled	boolean If set to `true`, enables the policy. If set to `false`, disables the policy.

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"destroyed": true,
"enabled": true,
"pod": {"id": "string",
"name": "string"
},
"policy_type": "string",
"time_remaining": 0
}
]
}

List snapshot policy members

Displays a list of snapshot policy 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.
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.
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.
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_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0
}
]
}

Create snapshot policies

Creates a membership between one or more resources and a snapshot policy. Applicable resources are directories. The policy_ids or policy_names parameter is required, but cannot be set together.

query Parameters

policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

Array of objects (_policymemberpostMembers)

A list of resources to which the policy may be applied.

Responses

Request samples

Payload

Content type

application/json

{"members": [{"member": {"id": "string",
"name": "string",
"resource_type": "string"
}
}
]
}

Response samples

Content type

application/json

{"items": [{"destroyed": true,
"enabled": true,
"member": {"id": "string",
"name": "string",
"resource_type": "string"
},
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"time_remaining": 0
}
]
}

Delete snapshot policies

Deletes one or more snapshot policies from resources. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

query Parameters

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.
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_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

List snapshot policy rules

Displays a list of snapshot policy rules.

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.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.
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": [{"at": 0,
"client_name": "string",
"every": 0,
"name": "string",
"keep_for": 0,
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"suffix": "string",
"destroyed": true,
"time_remaining": 0
}
]
}

Create snapshot policy rules

Creates one or more snapshot policy rules. The policy_ids or policy_names parameter is required, but cannot be set together.

query Parameters

policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

Array of objects (_policyrulesnapshotpostRules)

A list of snapshot policy rules to create.

Responses

Request samples

Payload

Content type

application/json

{"rules": [{"at": 0,
"client_name": "string",
"every": 0,
"keep_for": 0,
"suffix": "string"
}
]
}

Response samples

Content type

application/json

{"items": [{"at": 0,
"client_name": "string",
"every": 0,
"name": "string",
"keep_for": 0,
"policy": {"id": "string",
"name": "string",
"resource_type": "string"
},
"suffix": "string",
"destroyed": true,
"time_remaining": 0
}
]
}

Delete snapshot policy rules

Deletes one or more snapshot policy rules. The policy_ids or policy_names parameter is required, but 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`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` or `policy_names` parameter is required, but they cannot be set together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy 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

Ports

The ports on a FlashArray are assigned iSCSI Qualified Names (IQNs), NVMe Qualified Names (NQNs), and Fibre Channel World Wide Names (WWNs).

List ports

Displays host name, iSCSI Qualified Names (IQNs), NVMe Qualified Names (NQNs), IPv4 address of the portal, Fibre Channel World Wide Names (WWNs), and failover ports, including those that were discovered by Purity//FA and those that have been manually assigned by system administrators.

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",
"iqn": "iqn.2010-06.com.purestorage:flasharray.393d930077be2977",
"nqn": "nqn.2010-06.com.purestorage:flasharray.512f7bb185978505",
"portal": "10.16.200.27:3260",
"wwn": "52:4A:93:70:4E:E5:68:00",
"failover": "CT0.ETH2"
}
]
}

List port initiators

Displays host iSCSI Qualified Names (IQNs), NVMe Qualified Names (NQNs), and Fibre Channel World Wide Names (WWNs), including those that were discovered by Purity//FA and those that have been manually assigned by system administrators, along with the array ports (targets) on which they are eligible to communicate.

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