Download OpenAPI specification:Download
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.
Exchanges an ID Token for an OAuth 2.0 access token.
| X-Request-ID | string Supplied by client during request or generated by server. |
| grant_type required | string (OauthGrantType) Default: "urn:ietf:params:oauth:grant-type:token-exchange" The method by which the access token will be obtained.
The Pure Storage REST API supports the OAuth 2.0 "token exchange" grant type,
which indicates that a token exchange is being performed.
Set |
| subject_token required | string (OauthSubjectToken) An encoded security ID Token representing the identity of the party on behalf of whom the request is being made. The token must be issued by a trusted identity provider which must be either a registered application in Pure1 or an enabled API client on the array. The token must be a JSON Web Token and must contain the following claims:
Each token must also be signed with the private key that is paired with the API client's public key. |
| subject_token_type required | string (OauthSubjectTokenType) Default: "urn:ietf:params:oauth:token-type:jwt" An identifier that indicates the type of security token specifed in the |
{- "access_token": "eyJraWQiOiJqTlBzL1Ria2c4U2Vua3F3ZmkvbnI4bWxxQ3NPIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhdWQiOiI5NDcyMTkwOC1mNzkyLTcxMmUtYTYzOS0wODM5ZmE4MzA5MjIiLCJzdWIiOiJqb2UiLCJyb2xlIjoic3RvcmFnZV9hZG1pbiIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6OTAwMCIsImlhdCI6MTU0NDAzNjA1MiwiZXhwIjoxNTQ0MDcyMDUyLCJqdGkiOiJjOTg0MjgyNS1mNGM3LTRiNGUtODdkNy03OWFiZmIxYTUzNDgifQ.pnuYAx0CkmkIG0LDrMAQGRr5Ci4-t5yMto3A7BkmyKnAVHBXG5ZIWwvNkWDLhqbA4YjmG7LZmWHrCVehLy2zy2vRLahFURsd3GTnOaWSyWFIyrwpoO81jQRtOQATtseweuMT_-C8o3oa4MgBNBsuKrhwKQS3oDDpeRPaCRTGev1_xRDxh_K6CWJBTAeOP2pcR4LW6zIJkCLzzkMuyL4aTJWWUjSbl04mcFbyw8r8W1GURrmaDVOvvpT634Hk9-GGh9OMIRlS6OOq7cJKc-RRWn18IK2Gs53V_KYshXTBbnRr990Y_qOX8MaTWOJTqgzsojY02MSVuJ9XDJWoIU3TQytr4K1vM2EvwDZDgl7LuUYUn7vWhbKktFzpeZyyhOjq3eX-ViugYKpIjBcG2f_-fcTPceEWGV82rd6TyVNB5A-v9u2kxCdW198t_kesgVQfuupDeS02cZe0ABLCzEHPiVF17JfiVr6sjkciioxN7Wj_j18ga4U0mdSukauT8yhbgCW1ijTVTFu1VwWebW0s8z3BWMtXdTtZ3BhcZVAdKRF8bOq7nfEbUQGhTn9g7dK-yF050winjtp-VTL2oUtkF5j1v_N8vPNiN9ZdkGJZr7VVZ-qeOJZcjdaRbxL6YB__yT1wkTcKPh8RHz6GUq7Jbyw8VIlcBE2nvJ63d0tH9C4",
- "expires_in": 35999,
- "issued_token_type": "urn:ietf:params:oauth:token-type:access_token",
- "token_type": "Bearer"
}Returns a list of available API versions. No authentication is required to access this endpoint.
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "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"
]
}Creates a user session and returns a session token, using either the user's API token or
their username and password. api-token is passed in a header, with the request
body empty. Otherwise username and password are passed in the request body,
without an api-token header.
Storing user passwords client-side is not recommended. The username-password authentication option should only be used as necessary for initial retrieval of an API token, which should be securely stored and used for all subsequent logins.
| api-token | string Example: 0f2e2884-9486-c6c2-438c-f50418f2aac3 API token for a user. |
| X-Request-ID | string Supplied by client during request or generated by server. |
| password | string The user password that is used as an alternative to an api-token. |
| username | string The username used to log in as an alternative to an api-token. |
{- "password": "string",
- "username": "string"
}{- "items": [
- {
- "username": "pureuser"
}
]
}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.
Displays configured Active Directory accounts.
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "server": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "computer_name": "FLASHARRAY01",
- "directory_servers": [
- "ldap.my-corporation.com"
], - "domain": "my-corporation.com",
- "kerberos_servers": [
- "kdc.my-corporation.com"
], - "sources": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "tls": "required"
}
]
}Creates one or more Active Directory accounts.
The user and password provided are used
to join the array to the specified domain.
| join_existing_account | boolean If specified as |
| names required | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| 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. |
| join_ou | string The distinguished name of the organizational unit in which the
computer account should be created when joining the domain.
The |
| 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. |
Array of objects (_reference) List of network interfaces used for egress. For directory services at the array level, this list can be empty. If the list is empty, the system will use VIFs with the "ds" service (or if none, the "management" service) for egress. | |
| tls | string TLS mode for communication with domain controllers.
Valid values are |
| 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. |
{- "computer_name": "FLASHARRAY01",
- "directory_servers": [
- "ldap.my-corporation.com"
], - "domain": "my-corporation.com",
- "join_ou": "OU=Dev,OU=Sweden,DC=purestorage,DC=com",
- "kerberos_servers": [
- "kdc.my-corporation.com"
], - "password": "password",
- "sources": [
- {
- "id": "string",
- "name": "string"
}
], - "tls": "required",
- "user": "Administrator"
}{- "items": [
- {
- "name": "string",
- "server": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "computer_name": "FLASHARRAY01",
- "directory_servers": [
- "ldap.my-corporation.com"
], - "domain": "my-corporation.com",
- "kerberos_servers": [
- "kdc.my-corporation.com"
], - "sources": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "tls": "required"
}
]
}Deletes one or more specified Active Directory accounts.
| local_only | boolean If specified as |
| names required | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Modifies specified Active Directory account.
| names required | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Array of objects (_reference) List of network interfaces used for egress. For directory services at the array level, the list can be empty. If the list is empty, the system will use VIFs with the "ds" service (or if none, the "management" service) for egress. | |
| tls | string TLS mode for communication with domain controllers.
Valid values are |
{- "sources": [
- {
- "id": "string",
- "name": "string"
}
], - "tls": "required"
}{- "items": [
- {
- "name": "string",
- "server": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "computer_name": "FLASHARRAY01",
- "directory_servers": [
- "ldap.my-corporation.com"
], - "domain": "my-corporation.com",
- "kerberos_servers": [
- "kdc.my-corporation.com"
], - "sources": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "tls": "required"
}
]
}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.
Displays a list of administrators.
| 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 |
| expose_api_token | boolean If |
| expose_public_key | boolean If |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "api_token": {
- "created_at": 0,
- "expires_at": 0,
- "token": "string"
}, - "is_local": true,
- "locked": false,
- "lockout_remaining": 0,
- "management_access_policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "password": "string",
- "public_key": "string",
- "role": {
- "name": "string"
}
}
]
}Creates an administrator.
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Array of objects (_referenceWithType) List of management access policies to associate with the administrator.
Policies can be specified by the | |
| password | string Password associated with the account. |
object (_adminRole) This field has been deprecated. Predecessor to management access policies. |
{- "management_access_policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "password": "string",
- "role": {
- "name": "string"
}
}{- "items": [
- {
- "name": "string",
- "api_token": {
- "created_at": 0,
- "expires_at": 0,
- "token": "string"
}, - "is_local": true,
- "locked": false,
- "lockout_remaining": 0,
- "management_access_policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "password": "string",
- "public_key": "string",
- "role": {
- "name": "string"
}
}
]
}Deletes the specified administrator.
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Modifies properties for the specified administrator.
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
object (_apiToken) API token | |
| locked | boolean Returns a value of |
| 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. |
{- "api_token": { },
- "locked": false,
- "password": "string",
- "public_key": "string",
- "role": {
- "name": "string"
}, - "old_password": "string"
}{- "items": [
- {
- "name": "string",
- "api_token": {
- "created_at": 0,
- "expires_at": 0,
- "token": "string"
}, - "is_local": true,
- "locked": false,
- "lockout_remaining": 0,
- "management_access_policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "password": "string",
- "public_key": "string",
- "role": {
- "name": "string"
}
}
]
}Displays a list of management access policies that are attached to administrators.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| 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_names | Array of strings Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
For example, |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Creates a membership between an administrator with one or more management access policies.
One of member_ids or member_names parameter is required.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Array of objects (PolicyAssignmentPostPolicy) A list of policies to apply to the resource.
One of |
{- "policies": [
- {
- "policy": {
- "id": "string",
- "name": "string"
}
}
]
}{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}Deletes a membership between an administrator with one or more management access policies.
One of policy_ids or policy_names is required, and one of member_ids or member_names
is required.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| policy_ids | Array of strings Performs the operation on the unique policy IDs specified.
Enter multiple policy IDs in comma-separated format.
The |
| policy_names | Array of strings Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Displays API tokens for the specified administrators.
| 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 |
| expose_api_token | boolean If |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "api_token": {
- "created_at": 0,
- "expires_at": 0,
- "token": "string"
}
}
]
}Creates API tokens for the specified administrators.
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| timeout | integer <int64> The duration of API token validity, in milliseconds. |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "items": [
- {
- "name": "string",
- "api_token": {
- "created_at": 0,
- "expires_at": 0,
- "token": "string"
}
}
]
}Deletes the API tokens of the specified administrators.
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Displays entries in the administrator cache.
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "cached_at": 0,
- "management_access_policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "role": {
- "name": "string"
}
}
]
}Updates entries in the cache for administrators who currently do not have a cache entry, otherwise refreshes the existing entry.
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "items": [
- {
- "name": "string",
- "cached_at": 0,
- "management_access_policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "role": {
- "name": "string"
}
}
]
}Deletes all entries from the administrator cache.
| remove_all_entries required | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Displays the global administrator settings for the array.
| 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 |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "items": [
- {
- "lockout_duration": 3600000,
- "max_login_attempts": 10,
- "min_password_length": 1,
- "required_authentication_methods": {
- "ssh": [
- "password",
- "key"
], - "web_ui": [
- "password",
- "webauthn"
]
}, - "single_sign_on_enabled": true
}
], - "more_items_remaining": false,
- "total_item_count": 0
}Modifies the global administrator settings for the array.
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| 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. |
object (_adminSettingsRequiredAuthenticationMethods) Authentication methods that are required for the array on specific user interfaces. | |
| single_sign_on_enabled | boolean If |
{- "lockout_duration": 3600000,
- "max_login_attempts": 10,
- "min_password_length": 1,
- "required_authentication_methods": {
- "ssh": [
- "password",
- "key"
], - "web_ui": [
- "password",
- "webauthn"
]
}, - "single_sign_on_enabled": true
}{- "items": [
- {
- "lockout_duration": 3600000,
- "max_login_attempts": 10,
- "min_password_length": 1,
- "required_authentication_methods": {
- "ssh": [
- "password",
- "key"
], - "web_ui": [
- "password",
- "webauthn"
]
}, - "single_sign_on_enabled": true
}
]
}Alerts indicate significant events that occur on an array, including whenever a component degrades or the capacity threshold of the component is reached.
Displays a list of alerts.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| flagged | boolean If set to |
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "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",
- "notified": 1578440491109,
- "severity": "critical",
- "state": "open",
- "summary": "boot drive overutilization",
- "updated": 1578440491109
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Modifies one or more alerts and display updated information about these alerts.
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
object (FixedReferenceWithType) The context in which the operation was performed.
Valid values include a reference to any array which is a member of the same fleet.
If the array is not a member of a fleet, Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided | |
| flagged | boolean If set to |
{- "context": { },
- "flagged": true
}{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "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",
- "notified": 1578440491109,
- "severity": "critical",
- "state": "open",
- "summary": "boot drive overutilization",
- "updated": 1578440491109
}
]
}Displays a list of alert events.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| flagged | boolean If set to |
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "actual": "95%",
- "alert": {
- "id": "string",
- "name": "string"
}, - "code": 7,
- "component_name": "vm-tom",
- "component_type": "storage",
- "created": 1576275532434,
- "expected": "90%",
- "issue": "boot drive overutilization",
- "severity": "critical",
- "state": "open",
- "summary": "boot drive overutilization",
- "time": 1578440491109
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Displays a list of custom alert rules.
| allow_errors | boolean Default: false If set to |
| code | integer <int32> The alert code to display. |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "code": 25,
- "parameter": "info",
- "value": "85"
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Creates an alert rule with a custom value.
| 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 |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
object (FixedReferenceWithType) The context in which the operation was performed.
Valid values include a reference to any array which is a member of the same fleet.
If the array is not a member of a fleet, Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided | |
| 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. |
{- "context": { },
- "value": "85"
}{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "code": 25,
- "parameter": "info",
- "value": "85"
}
]
}Deletes a custom alert rule.
| 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 |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Modifies a custom alert rule to a new value.
| 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 |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
object (FixedReferenceWithType) The context in which the operation was performed.
Valid values include a reference to any array which is a member of the same fleet.
If the array is not a member of a fleet, Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided | |
| 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. |
{- "context": { },
- "value": "85"
}{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "code": 25,
- "parameter": "info",
- "value": "85"
}
]
}Displays a list of available customizable alert codes.
| allow_errors | boolean Default: false If set to |
| code | integer <int32> The alert code to display. |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "allowed_values": "Range 0-100 (must be equal to or lower than Warning Threshold)",
- "code": 25,
- "default_value": "80%",
- "parameter": "info",
- "subject": "Storage consumption has reached {percent_usage}% of usable capacity"
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Displays alert watcher email addressess and indicates whether they are enabled.
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "enabled": true
}
]
}Creates one or more alert watcher email addresses, adding them to the list of alert watchers.
| names required | Array of strings Performs the operation on the unique name specified.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| enabled | boolean If set to |
{- "enabled": true
}{- "items": [
- {
- "name": "string",
- "enabled": true
}
]
}Delete alert watcher email address from the list of alert watchers.
| names required | Array of strings Performs the operation on the unique name specified.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Modify alert watcher email address by enabling or disabling it.
| names required | Array of strings Performs the operation on the unique name specified.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| enabled | boolean If set to |
{- "enabled": true
}{- "items": [
- {
- "name": "string",
- "enabled": true
}
]
}Displays alert watcher email test results.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "total_item_count": 0,
- "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
], - "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",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "resource": {
- "name": "string"
}
}
]
}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.
Displays a list of API clients.
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "access_policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "access_token_ttl_in_ms": 15000,
- "enabled": true,
- "id": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
- "key_id": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
- "max_role": "storage_admin",
- "name": "NightlyStatsAggregationScript",
- "public_key": "-----BEGIN PUBLIC KEY-----\nMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArSe6chh1JzME9svOKjU0\neKTm8S23Ok3Vr2bWuPri/YHfLrlnRwWoCt+st0/BebKSJ+fQUWOaLlqpZQKpI8oR\ngJ9sWmwGibVG8cTuz7XMkskx9bsm/bjIenuB4W+s3g0BCsi9930mfdKgJgFzY69O\nnLh7d7hAFcmhSJa945PryQZpvJ/U4Ue5F4d+WXgEJ0SoSRaZ6bbeMPhcbMHTzTum\n2ZrPBkK5cqPYitaso6BXeAlqNQPw4Kbu4Ugm0CTogrtImkwoonWDDP34XMOq+u7q\nsNTbJSvDKMTM1RPPrTWCaLiuZkdLVEVesZ9/8+XUMIgBTElwQJDCAQer03MJzqRr\n1eCZGgLfDuYqwMG2MFaAX7kgqBwwyqRTd6MxaQxt2nkdfwiXSY71llzEQ23g3T+1\n64zjwAL5f+dtu8PkGF7IdU2T8P2Qk9bG9pckwZHWYkBK77BAk5jbmSzsKGZgRb2R\n1E+TWDKIaveFhQp251j/C5wkZwMXgjOzN+BOPo+OiLBGUl+jRybWA9f7Vq1MEdf6\nSEdLiqYrXcZERkYBMieLXAfdtaztAIb96cUu+OKMSLDk+D0GHkUfm7lEbDK3ew1+\nD6z+BnxDyH6oqZzz4lS2kPLBLsc+6pdTGuKLf0S9YuLiqJe659AdwU8+X/3KtwNd\nFVJSaxdFbWx0nj3hJqFkIO8CAwEAAQ==\n-----END PUBLIC KEY-----\n"
}
]
}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.
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
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 | |
| 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 |
| issuer | string The name of the identity provider that will be issuing ID Tokens for this API client.
The |
| 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 |
| public_key | string The API client's PEM formatted (Base64 encoded) RSA public key.
Include the |
{- "access_policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "access_token_ttl_in_ms": 15000,
- "max_role": "storage_admin",
- "public_key": "-----BEGIN PUBLIC KEY-----\nMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArSe6chh1JzME9svOKjU0\neKTm8S23Ok3Vr2bWuPri/YHfLrlnRwWoCt+st0/BebKSJ+fQUWOaLlqpZQKpI8oR\ngJ9sWmwGibVG8cTuz7XMkskx9bsm/bjIenuB4W+s3g0BCsi9930mfdKgJgFzY69O\nnLh7d7hAFcmhSJa945PryQZpvJ/U4Ue5F4d+WXgEJ0SoSRaZ6bbeMPhcbMHTzTum\n2ZrPBkK5cqPYitaso6BXeAlqNQPw4Kbu4Ugm0CTogrtImkwoonWDDP34XMOq+u7q\nsNTbJSvDKMTM1RPPrTWCaLiuZkdLVEVesZ9/8+XUMIgBTElwQJDCAQer03MJzqRr\n1eCZGgLfDuYqwMG2MFaAX7kgqBwwyqRTd6MxaQxt2nkdfwiXSY71llzEQ23g3T+1\n64zjwAL5f+dtu8PkGF7IdU2T8P2Qk9bG9pckwZHWYkBK77BAk5jbmSzsKGZgRb2R\n1E+TWDKIaveFhQp251j/C5wkZwMXgjOzN+BOPo+OiLBGUl+jRybWA9f7Vq1MEdf6\nSEdLiqYrXcZERkYBMieLXAfdtaztAIb96cUu+OKMSLDk+D0GHkUfm7lEbDK3ew1+\nD6z+BnxDyH6oqZzz4lS2kPLBLsc+6pdTGuKLf0S9YuLiqJe659AdwU8+X/3KtwNd\nFVJSaxdFbWx0nj3hJqFkIO8CAwEAAQ==\n-----END PUBLIC KEY-----\n"
}{- "items": [
- {
- "access_policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "access_token_ttl_in_ms": 15000,
- "enabled": true,
- "id": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
- "key_id": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
- "max_role": "storage_admin",
- "name": "NightlyStatsAggregationScript",
- "public_key": "-----BEGIN PUBLIC KEY-----\nMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArSe6chh1JzME9svOKjU0\neKTm8S23Ok3Vr2bWuPri/YHfLrlnRwWoCt+st0/BebKSJ+fQUWOaLlqpZQKpI8oR\ngJ9sWmwGibVG8cTuz7XMkskx9bsm/bjIenuB4W+s3g0BCsi9930mfdKgJgFzY69O\nnLh7d7hAFcmhSJa945PryQZpvJ/U4Ue5F4d+WXgEJ0SoSRaZ6bbeMPhcbMHTzTum\n2ZrPBkK5cqPYitaso6BXeAlqNQPw4Kbu4Ugm0CTogrtImkwoonWDDP34XMOq+u7q\nsNTbJSvDKMTM1RPPrTWCaLiuZkdLVEVesZ9/8+XUMIgBTElwQJDCAQer03MJzqRr\n1eCZGgLfDuYqwMG2MFaAX7kgqBwwyqRTd6MxaQxt2nkdfwiXSY71llzEQ23g3T+1\n64zjwAL5f+dtu8PkGF7IdU2T8P2Qk9bG9pckwZHWYkBK77BAk5jbmSzsKGZgRb2R\n1E+TWDKIaveFhQp251j/C5wkZwMXgjOzN+BOPo+OiLBGUl+jRybWA9f7Vq1MEdf6\nSEdLiqYrXcZERkYBMieLXAfdtaztAIb96cUu+OKMSLDk+D0GHkUfm7lEbDK3ew1+\nD6z+BnxDyH6oqZzz4lS2kPLBLsc+6pdTGuKLf0S9YuLiqJe659AdwU8+X/3KtwNd\nFVJSaxdFbWx0nj3hJqFkIO8CAwEAAQ==\n-----END PUBLIC KEY-----\n"
}
]
}Deletes an API client.
The ids or names parameter is required, but they cannot be set together.
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Enables or disables an API client.
The ids or names parameter is required, but they cannot be set together.
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| enabled | boolean Returns a value of |
{- "enabled": true
}{- "items": [
- {
- "access_policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "access_token_ttl_in_ms": 15000,
- "enabled": true,
- "id": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
- "key_id": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
- "max_role": "storage_admin",
- "name": "NightlyStatsAggregationScript",
- "public_key": "-----BEGIN PUBLIC KEY-----\nMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArSe6chh1JzME9svOKjU0\neKTm8S23Ok3Vr2bWuPri/YHfLrlnRwWoCt+st0/BebKSJ+fQUWOaLlqpZQKpI8oR\ngJ9sWmwGibVG8cTuz7XMkskx9bsm/bjIenuB4W+s3g0BCsi9930mfdKgJgFzY69O\nnLh7d7hAFcmhSJa945PryQZpvJ/U4Ue5F4d+WXgEJ0SoSRaZ6bbeMPhcbMHTzTum\n2ZrPBkK5cqPYitaso6BXeAlqNQPw4Kbu4Ugm0CTogrtImkwoonWDDP34XMOq+u7q\nsNTbJSvDKMTM1RPPrTWCaLiuZkdLVEVesZ9/8+XUMIgBTElwQJDCAQer03MJzqRr\n1eCZGgLfDuYqwMG2MFaAX7kgqBwwyqRTd6MxaQxt2nkdfwiXSY71llzEQ23g3T+1\n64zjwAL5f+dtu8PkGF7IdU2T8P2Qk9bG9pckwZHWYkBK77BAk5jbmSzsKGZgRb2R\n1E+TWDKIaveFhQp251j/C5wkZwMXgjOzN+BOPo+OiLBGUl+jRybWA9f7Vq1MEdf6\nSEdLiqYrXcZERkYBMieLXAfdtaztAIb96cUu+OKMSLDk+D0GHkUfm7lEbDK3ew1+\nD6z+BnxDyH6oqZzz4lS2kPLBLsc+6pdTGuKLf0S9YuLiqJe659AdwU8+X/3KtwNd\nFVJSaxdFbWx0nj3hJqFkIO8CAwEAAQ==\n-----END PUBLIC KEY-----\n"
}
]
}Displays a list of installed apps.
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "description": "Snapshot offload to NFS or Amazon S3",
- "details": "Insufficient resources to operate",
- "enabled": true,
- "status": "healthy",
- "version": "1.0.0",
- "vnc_enabled": true
}
]
}Modifies an installed app or modifies Virtual Network Computing (VNC) access for apps that are being patched.
| names required | Array of strings Performs the operation on the unique name specified.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| enabled | boolean If set to |
| vnc_enabled | boolean If set to |
{- "enabled": true,
- "vnc_enabled": true
}{- "items": [
- {
- "name": "string",
- "description": "Snapshot offload to NFS or Amazon S3",
- "details": "Insufficient resources to operate",
- "enabled": true,
- "status": "healthy",
- "version": "1.0.0",
- "vnc_enabled": true
}
]
}Displays a list of installed apps and their nodes.
| app_names | Array of strings The name of the installed app. Enter multiple names in comma-separated format. |
| 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 |
| 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 |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "app": {
- "id": "string",
- "name": "string"
}, - "index": 0,
- "status": "healthy",
- "version": "1.0.0",
- "vnc": [
- "10.1.1.10:5900"
]
}
]
}Array features provide the ability to configure settings that affect the operation of the array as a whole and monitor array I/O performance.
Displays general array properties including the array name, login banner, idle timeout for management sessions, and NTP servers.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "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,
- "enabled_delay": 86400000,
- "eradication_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,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0,
- "replication": 0,
- "shared_effective": 0,
- "snapshots_effective": 0,
- "total_effective": 0,
- "unique_effective": 0
}, - "time_zone": "America/Los_Angeles",
- "version": "5.0.0"
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}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.
| eradicate_all_data | boolean Set to |
| factory_reset_token | integer <int64> A token required to perform a factory reset. |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Modifies general array properties such as the array name, login banner, idle timeout for management sessions, and NTP servers.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| name | string A user-specified name. The name must be locally unique and can be changed. |
object (FixedReferenceWithType) The context in which the operation was performed.
Valid values include a reference to any array which is a member of the same fleet.
If the array is not a member of a fleet, Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided | |
| banner | string |
| console_lock_enabled | boolean If |
object (ArrayEncryption) If the user does not have sufficient access, all fields will return | |
object (Eradication_config) The configuration of eradication feature. | |
| idle_timeout | integer <int32> The idle timeout in milliseconds. Valid values include |
| ntp_servers | Array of strings NTP Servers.
If the user does not have sufficient access, this field will return |
| 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 |
| scsi_timeout | integer <int32> The SCSI timeout. If not specified, defaults to |
object (Space) If the user does not have sufficient access, all fields will return |
{- "name": "string",
- "context": { },
- "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,
- "enabled_delay": 86400000,
- "eradication_delay": 86400000
}, - "idle_timeout": 300000,
- "ntp_servers": [
- "time.acme.com"
], - "ntp_symmetric_key": "string",
- "scsi_timeout": 60000,
- "space": { }
}{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "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,
- "enabled_delay": 86400000,
- "eradication_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,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0,
- "replication": 0,
- "shared_effective": 0,
- "snapshots_effective": 0,
- "total_effective": 0,
- "unique_effective": 0
}, - "time_zone": "America/Los_Angeles",
- "version": "5.0.0"
}
]
}Displays the configuration status of the CBS array, including the progress of the configuration upgrade. Requests for non-CBS arrays will receive an error response.
| 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 |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "automatic_capacity_upgrade": {
- "details": "Automatic capacity upgrade will be triggered once the array is full",
- "enabled": true,
- "max_capacity": 30786325577728
}, - "id": "0f58952a-35e4-7457-b1dd-23454257a1f1",
- "model": {
- "current": "CBS-V10MP2R2",
- "details": "",
- "override_checks": [
- "HostIOCheck",
- "HostPathsCheck"
], - "requested": "CBS-V20MP2R2",
- "status": "upgrading",
- "step": "mid-upgrade-check"
}, - "name": "string"
}
]
}Modifies the configuration of the CBS array. This should trigger a backend process that will upgrade the CBS array configuration. The array can be upgraded only to models defined by the supported configurations endpoint. When an existing array upgrade request is in progress, any new request to upgrade the array will receive an error response. For non-CBS arrays, this feature is not supported and requests will receive an error response.
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
The requested configuration of the CBS array hardware.
object (CloudConfigAutomaticCapacityUpgradePatch) The requested configuration of the automatic capacity upgrade. | |
object (CloudConfigModelPatch) The requested model configuration of the CBS array. |
{- "automatic_capacity_upgrade": {
- "enabled": true,
- "max_capacity": 30786325577728
}, - "model": {
- "add_override_checks": [
- "HostIOCheck",
- "HostPathsCheck"
], - "requested": "CBS-V20MP2R2"
}
}{- "items": [
- {
- "automatic_capacity_upgrade": {
- "details": "Automatic capacity upgrade will be triggered once the array is full",
- "enabled": true,
- "max_capacity": 30786325577728
}, - "id": "0f58952a-35e4-7457-b1dd-23454257a1f1",
- "model": {
- "current": "CBS-V10MP2R2",
- "details": "",
- "override_checks": [
- "HostIOCheck",
- "HostPathsCheck"
], - "requested": "CBS-V20MP2R2",
- "status": "upgrading",
- "step": "mid-upgrade-check"
}, - "name": "string"
}
]
}Displays the list of supported configurations to which the CBS array can be upgraded. Requests for non-CBS arrays will receive an error response.
| 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 |
| 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 |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "supported_models": [
- "CBS-V20MP2R2"
]
}
]
}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.
| 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 |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "current_capacity": 10995116277760,
- "details": "string",
- "requested_capacity": 10995116277760,
- "status": "idle"
}
]
}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.
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
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 |
{- "requested_capacity": 10995116277760
}{- "items": [
- {
- "id": "string",
- "name": "string",
- "current_capacity": 10995116277760,
- "details": "string",
- "requested_capacity": 10995116277760,
- "status": "idle"
}
]
}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.
| 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 |
| 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 |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "supported_capacity": 10995116277760
}
]
}Displays a list of factory reset processes.
| 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 |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "details": "string",
- "image_download_progress": 0.32,
- "image_source": "auto",
- "image_version": "6.6.6",
- "sanitization_certificate": "string",
- "status": "resetting"
}
]
}Creates the initiation of the factory reset process
| eradicate_all_data required | boolean Set to |
| preserve_configuration_data required | Array of strings A comma-separated list of configuration data types to preserve.
A value of |
| skip_phonehome_check | boolean A flag to skip phonehome connectivity check. If |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "items": [
- {
- "id": "string",
- "name": "string",
- "details": "string",
- "image_download_progress": 0.32,
- "image_source": "auto",
- "image_version": "6.6.6",
- "sanitization_certificate": "string",
- "status": "resetting"
}
]
}Modifies the factory reset process to finalize.
| delete_sanitization_certificate required | boolean Set to |
| eradicate_all_data required | boolean Set to |
| finalize required | boolean Must be |
| reinstall_image required | boolean Set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| image_source | string Source of the ISO image to download. Valid values include |
| image_version | string Version of the image to download. |
{- "image_source": "auto",
- "image_version": "6.6.6"
}{- "items": [
- {
- "id": "string",
- "name": "string",
- "details": "string",
- "image_download_progress": 0.32,
- "image_source": "auto",
- "image_version": "6.6.6",
- "sanitization_certificate": "string",
- "status": "resetting"
}
]
}Displays the End User Agreement and signature.
| 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 |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "agreement": "string",
- "signature": {
- "accepted": 1577880000000,
- "company": "Example Inc.",
- "name": "John Doe",
- "title": "Admin"
}
}
]
}Modifies the signature on the End User Agreement.
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
object (_eula_signature) |
{- "signature": {
- "company": "Example Inc.",
- "name": "John Doe",
- "title": "Admin"
}
}{- "items": [
- {
- "agreement": "string",
- "signature": {
- "accepted": 1577880000000,
- "company": "Example Inc.",
- "name": "John Doe",
- "title": "Admin"
}
}
]
}Displays a list of tokens used to perform a factory reset on the array.
| 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 |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "token": 4671919
}
]
}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.
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "items": [
- {
- "id": "string",
- "name": "string",
- "token": 4671919
}
]
}Deletes an existing token that could be used to perform a factory reset on the array.
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Displays test results for configured NTP servers.
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "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"
}
]
}Displays real-time and historical front-end performance data at the array level including latency, bandwidth, IOPS, average I/O size, and queue depth.
| end_time | integer <int64> Displays historical performance data for the specified time window,
where |
| 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 |
| 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 |
| protocol_group | string Protocol group type. Valid values are |
| resolution | integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data.
For array-wide performance metrics ( |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| start_time | integer <int64> Displays historical performance data for the specified time window,
where |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "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_read_op_cache_reduction": 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,
- "id": "string",
- "name": "string",
- "local_queue_usec_per_op": 0,
- "others_per_sec": 0,
- "queue_depth": 0,
- "usec_per_other_op": 0
}
]
}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.
| end_time | integer <int64> Displays historical performance data for the specified time window,
where |
| 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 |
| 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. |
| resolution | integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data.
For array-wide performance metrics ( |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| start_time | integer <int64> Displays historical performance data for the specified time window,
where |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "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_read_op_cache_reduction": 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,
- "id": "string",
- "name": "string",
- "local_queue_usec_per_op": 0,
- "others_per_sec": 0,
- "queue_depth": 0,
- "usec_per_other_op": 0,
- "link": [
- {
- "id": "string",
- "name": "string"
}
]
}
]
}Displays real-time and historical array space information including unique volume and snapshot space, shared space, data reduction, provisioned capacity, usable capacity, and parity.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| end_time | integer <int64> Displays historical performance data for the specified time window,
where |
| 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 |
| 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. |
| resolution | integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data.
For array-wide performance metrics ( |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| start_time | integer <int64> Displays historical performance data for the specified time window,
where |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
], - "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "capacity": 10995116277760,
- "capacity_installed": 46179488366592,
- "parity": 0.99,
- "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0,
- "replication": 0,
- "shared_effective": 0,
- "snapshots_effective": 0,
- "total_effective": 0,
- "unique_effective": 0
}, - "time": 0
}
]
}Displays a list of connected arrays.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 | 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 |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "encryption": "encrypted",
- "encryption_mode": "TLS-PSK-AES-256",
- "management_address": "10.202.101.78",
- "os": "string",
- "remote": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "replication_addresses": [
- "10.202.101.70"
], - "replication_transport": "ip",
- "status": "string",
- "throttle": {
- "default_limit": 1073741824,
- "window": {
- "end": 46800000,
- "start": 3600000
}, - "window_limit": 2097152
}, - "type": "string",
- "version": "5.0.0"
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Creates a connection between this array and the specified array.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| connection_key | string The connection key of the target array. |
| encryption | string If |
| 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 | string The protocol used to transport data between the local array and
the remote array.
Valid values are |
| type | string The type of replication.
Valid values are |
{- "connection_key": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
- "encryption": "encrypted",
- "management_address": "10.202.101.78",
- "replication_addresses": [
- "10.202.101.70"
], - "replication_transport": "ip",
- "type": "async-replication"
}{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "encryption": "encrypted",
- "encryption_mode": "TLS-PSK-AES-256",
- "management_address": "10.202.101.78",
- "os": "string",
- "remote": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "replication_addresses": [
- "10.202.101.70"
], - "replication_transport": "ip",
- "status": "string",
- "throttle": {
- "default_limit": 1073741824,
- "window": {
- "end": 46800000,
- "start": 3600000
}, - "window_limit": 2097152
}, - "type": "string",
- "version": "5.0.0"
}
]
}Deletes the connection between this array and the specified array.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Modifies attributes for an array connection.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| refresh | boolean If set to |
| renew_encryption_key | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| default_limit | integer <int64> Deprecated. Default maximum bandwidth threshold for outbound traffic in bytes. Once exceeded, bandwidth throttling occurs. |
object (Time_window) Deprecated. The time during which the | |
| window_limit | integer <int64> Deprecated. Maximum bandwidth threshold for outbound traffic during the specified
|
| connection_key | string The connection key of the target array.
It is required when |
| encryption | string If |
| 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
|
object (_throttle) The bandwidth throttling for an array connection. Configurable on PATCH only. | |
| type | string The type of replication.
Valid values are |
{- "default_limit": 1073741824,
- "window": {
- "end": 46800000,
- "start": 3600000
}, - "window_limit": 2097152,
- "connection_key": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
- "encryption": "encrypted",
- "management_address": "10.202.101.78",
- "replication_addresses": [
- "10.202.101.70"
], - "throttle": {
- "default_limit": 1073741824,
- "window": {
- "end": 46800000,
- "start": 3600000
}, - "window_limit": 2097152
}, - "type": "string"
}{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "encryption": "encrypted",
- "encryption_mode": "TLS-PSK-AES-256",
- "management_address": "10.202.101.78",
- "os": "string",
- "remote": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "replication_addresses": [
- "10.202.101.70"
], - "replication_transport": "ip",
- "status": "string",
- "throttle": {
- "default_limit": 1073741824,
- "window": {
- "end": 46800000,
- "start": 3600000
}, - "window_limit": 2097152
}, - "type": "string",
- "version": "5.0.0"
}
]
}Displays the connection key for the array.
| encrypted | boolean If |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "connection_key": "6207d123-d123-0b5c-5fa1-95fabc5c7123"
}
]
}Displays the connection path from the array to which the connection was made.
| 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 |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 | 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 |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "encryption": "encrypted",
- "encryption_mode": "TLS-PSK-AES-256",
- "id": "string",
- "local_address": "10.202.101.70",
- "local_port": "ct0.eth0",
- "remote": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "remote_address": "10.202.101.78",
- "remote_port": "ct1.eth0",
- "replication_transport": "string",
- "status": "string",
- "status_details": "string",
- "type": "string"
}
]
}Audit trail records describe administrative actions performed by a user to modify the configuration of an array.
Displays a list of audits.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "arguments": "--size 1G vol2",
- "command": "purevol",
- "origin": {
- "id": "string",
- "name": "string"
}, - "subcommand": "create",
- "time": 1577402821354,
- "user": "pureuser",
- "user_interface": "CLI"
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}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.
Displays certificate attributes.
| 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 |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "certificate": "string",
- "certificate_type": "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_algorithm": "rsa",
- "key_size": 2048,
- "locality": "Toronto",
- "organization": "Veridian Dynamics",
- "organizational_unit": "Research & Development",
- "state": "Ontario",
- "status": "string",
- "subject_alternative_names": [
- "otherdnsname.mydomain.com"
], - "valid_from": 1491070899,
- "valid_to": 1524248499
}
]
}Creates a certificate object and specifies the valid time period and organization details of the certificate. A certificate can be imported or manually configured.
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| 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. |
string The email field listed in the certificate. | |
| intermediate_certificate | string The text of the intermediate certificate chains. |
| key_algorithm | string The key algorithm used to generate the certificate.
This field can only be specified when creating a new self-signed certificate.
Defaults to rsa if not specified. Valid values when creating a new self-signed
certificate only include |
| key_size | integer <int32> The size (in bits) of the private key for the certificate. Default is 2048 bits
for |
| 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. |
| subject_alternative_names | Array of strings The alternative names that are secured by this certificate. Alternative names may be IP addresses, DNS names, or URIs. |
| days | integer <int32> The number of days that the self-signed certificate is valid. Defaults to 3650. This field can only be specified when creating a new self-signed certificate. |
| key | string The text of the private key. This field can only be specified when importing a certificate and key pair. |
| passphrase | string The passphrase used to encrypt |
{- "certificate": "string",
- "common_name": "Pure Storage Inc.",
- "country": "CA",
- "email": "tcrisp@veridiandynamics.com",
- "intermediate_certificate": "string",
- "key_algorithm": "rsa",
- "key_size": 2048,
- "locality": "Toronto",
- "organization": "Veridian Dynamics",
- "organizational_unit": "Research & Development",
- "state": "Ontario",
- "subject_alternative_names": [
- "otherdnsname.mydomain.com"
], - "days": 3650,
- "key": "string",
- "passphrase": "string"
}{- "items": [
- {
- "id": "string",
- "name": "string",
- "certificate": "string",
- "certificate_type": "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_algorithm": "rsa",
- "key_size": 2048,
- "locality": "Toronto",
- "organization": "Veridian Dynamics",
- "organizational_unit": "Research & Development",
- "state": "Ontario",
- "status": "string",
- "subject_alternative_names": [
- "otherdnsname.mydomain.com"
], - "valid_from": 1491070899,
- "valid_to": 1524248499
}
]
}Deletes a specific certificate object.
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Modifies certificate attributes. Modifying self-signed certificate attributes replaces the existing certificate with a new one, generated by Purity//FA, using the specified attributes.
| generate_new_key | boolean If set to |
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| 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. |
string The email field listed in the certificate. | |
| intermediate_certificate | string The text of the intermediate certificate chains. |
| key_algorithm | string The key algorithm used to generate the certificate.
This field can only be specified when creating a new self-signed certificate.
Defaults to rsa if not specified. Valid values when creating a new self-signed
certificate only include |
| key_size | integer <int32> The size (in bits) of the private key for the certificate. Default is 2048 bits
for |
| 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. |
| subject_alternative_names | Array of strings The alternative names that are secured by this certificate. Alternative names may be IP addresses, DNS names, or URIs. |
| days | integer <int32> The number of days that the self-signed certificate is valid. Defaults to 3650. This field can only be specified when creating a new self-signed certificate. |
| key | string The text of the private key. This field can only be specified when importing a certificate and key pair. |
| passphrase | string The passphrase used to encrypt |
{- "certificate": "string",
- "common_name": "Pure Storage Inc.",
- "country": "CA",
- "email": "tcrisp@veridiandynamics.com",
- "intermediate_certificate": "string",
- "key_algorithm": "rsa",
- "key_size": 2048,
- "locality": "Toronto",
- "organization": "Veridian Dynamics",
- "organizational_unit": "Research & Development",
- "state": "Ontario",
- "subject_alternative_names": [
- "otherdnsname.mydomain.com"
], - "days": 3650,
- "key": "string",
- "passphrase": "string"
}{- "items": [
- {
- "id": "string",
- "name": "string",
- "certificate": "string",
- "certificate_type": "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_algorithm": "rsa",
- "key_size": 2048,
- "locality": "Toronto",
- "organization": "Veridian Dynamics",
- "organizational_unit": "Research & Development",
- "state": "Ontario",
- "status": "string",
- "subject_alternative_names": [
- "otherdnsname.mydomain.com"
], - "valid_from": 1491070899,
- "valid_to": 1524248499
}
]
}Lists membership associations between groups and certificates.
| 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_names | Array of strings A comma-separated list of certificate group names.
If no resource matches each of the elements of |
| certificate_ids | Array of strings A comma-separated list of certificate ids.
If there is not at least one resource that matches each of the
elements of |
| certificate_names | Array of strings The names of one or more certificates.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}Creates one or more certificates to one or more certificate groups.
| 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_names | Array of strings A comma-separated list of certificate group names.
If no resource matches each of the elements of |
| certificate_ids | Array of strings A comma-separated list of certificate ids.
If there is not at least one resource that matches each of the
elements of |
| certificate_names | Array of strings The names of one or more certificates.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "items": [
- {
- "group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}Deletes one or more certificates from one or more certificate groups.
| 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_names | Array of strings A comma-separated list of certificate group names.
If no resource matches each of the elements of |
| certificate_ids | Array of strings A comma-separated list of certificate ids.
If there is not at least one resource that matches each of the
elements of |
| certificate_names | Array of strings The names of one or more certificates.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Displays the usage and associations of certificates.
| 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 |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "use": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}Creates a certificate signing request using a specified certificate and parameters.
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
object (_referenceNoId) | |
| common_name | string The common name field listed in the certificate. |
| country | string Two-letter country (ISO) code listed in the certificate. |
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. |
| subject_alternative_names | Array of strings The alternative names that are secured by this certificate. Alternative names include IP addresses, DNS names, or URIs. |
{- "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",
- "subject_alternative_names": [
- "otherdnsname.mydomain.com"
]
}{- "items": [
- {
- "certificate_signing_request": "string"
}
]
}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.
Display all array certificate groups.
| 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 |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string"
}
]
}Creates one or more certificate groups on the array.
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "items": [
- {
- "id": "string",
- "name": "string"
}
]
}Deletes one or more certificate groups from the array.
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Lists membership associations between groups and certificates on the array.
| 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_names | Array of strings A comma-separated list of certificate group names.
If no resource matches each of the elements of |
| certificate_ids | Array of strings A comma-separated list of certificate ids.
If there is not at least one resource that matches each of the
elements of |
| certificate_names | Array of strings The names of one or more certificates.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}Creates one or more certificates to one or more certificate groups on the array.
| 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_names | Array of strings A comma-separated list of certificate group names.
If no resource matches each of the elements of |
| certificate_ids | Array of strings A comma-separated list of certificate ids.
If there is not at least one resource that matches each of the
elements of |
| certificate_names | Array of strings The names of one or more certificates.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "items": [
- {
- "group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}Deletes one or more certificate groups.
| 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_names | Array of strings A comma-separated list of certificate group names.
If no resource matches each of the elements of |
| certificate_ids | Array of strings A comma-separated list of certificate ids.
If there is not at least one resource that matches each of the
elements of |
| certificate_names | Array of strings The names of one or more certificates.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Lists how certificate groups are being used and by what.
| 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 |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "use": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}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.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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_names | Array of strings Performs the operation on the hosts specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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, |
| protocol_endpoint_names | Array of strings Performs the operation on the protocol endpoints specified.
Enter multiple names in comma-separated format.
For example, |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| total_item_count | boolean If set to |
| volume_ids | Array of strings Performs the operation on the specified volume.
Enter multiple ids in comma-separated format.
For example, |
| volume_names | Array of strings Performs the operation on the volume specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "host": {
- "name": "string"
}, - "host_group": {
- "name": "string"
}, - "lun": 7,
- "nsid": 3856,
- "protocol_endpoint": {
- "id": "string",
- "name": "string"
}, - "volume": {
- "id": "string",
- "name": "string"
}
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| 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_names | Array of strings Performs the operation on the hosts specified.
Enter multiple names in comma-separated format.
For example, |
| volume_ids | Array of strings Performs the operation on the specified volume.
Enter multiple ids in comma-separated format.
For example, |
| volume_names | Array of strings Performs the operation on the volume specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| 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 |
object (Reference) 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. |
{- "lun": 7,
- "protocol_endpoint": {
- "id": "string",
- "name": "string"
}
}{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "host": {
- "name": "string"
}, - "host_group": {
- "name": "string"
}, - "lun": 7,
- "nsid": 3856,
- "protocol_endpoint": {
- "id": "string",
- "name": "string"
}, - "volume": {
- "id": "string",
- "name": "string"
}
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| 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_names | Array of strings Performs the operation on the hosts specified.
Enter multiple names in comma-separated format.
For example, |
| volume_ids | Array of strings Performs the operation on the specified volume.
Enter multiple ids in comma-separated format.
For example, |
| volume_names | Array of strings Performs the operation on the volume specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
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.
Displays a list of containers with its default protections.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| destroyed | boolean If set to If object name(s) or id(s) are specified, then each object referenced must exist.
If |
| 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 container ID specified.
Enter multiple source IDs in comma-separated format.
The |
| 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 |
| names | Array of strings Performs the operation on the unique container name specified.
Enter multiple names in comma-separated format.
The |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "default_protections": [
- {
- "id": "string",
- "name": "string",
- "type": "protection_group"
}
], - "id": "string",
- "name": "string",
- "type": "string"
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Modifies a container's default protections.
To modify, set default_protections to the new list.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| ids | Array of strings Performs the operation on the container ID specified.
Enter multiple source IDs in comma-separated format.
The |
| names | Array of strings Performs the operation on the unique container name specified.
Enter multiple names in comma-separated format.
The |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
object (FixedReferenceWithType) The context in which the operation was performed.
Valid values include a reference to any array which is a member of the same fleet.
If the array is not a member of a fleet, Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided | |
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 |
{- "context": { },
- "default_protections": [
- {
- "id": "string",
- "name": "string",
- "type": "protection_group"
}
]
}{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "default_protections": [
- {
- "id": "string",
- "name": "string",
- "type": "protection_group"
}
], - "id": "string",
- "name": "string",
- "type": "string"
}
]
}Controller data includes the name, mode, FlashArray model, Purity//FA software version, and status of each controller in the array.
Displays the name, mode, FlashArray model, Purity//FA software version, and status of each controller in the 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "mode": "primary",
- "mode_since": 1687086901996,
- "model": "FA-m50",
- "status": "ready",
- "type": "string",
- "version": "5.0.0"
}
]
}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.
Displays a list of directories, including those pending eradication.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| destroyed | boolean If set to If object name(s) or id(s) are specified, then each object referenced must exist.
If |
| 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_names | Array of strings Performs the operation on the file system name specified.
Enter multiple file system names in comma-separated format.
For example, |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| total_only | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "created": 0,
- "destroyed": true,
- "directory_name": "string",
- "file_system": {
- "id": "string",
- "name": "string"
}, - "limited_by": {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "path": "string",
- "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0
}, - "time_remaining": 0
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
], - "total": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "created": 0,
- "destroyed": true,
- "directory_name": "string",
- "file_system": {
- "id": "string",
- "name": "string"
}, - "limited_by": {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "path": "string",
- "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0
}, - "time_remaining": 0
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| 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_names | Array of strings Performs the operation on the file system name specified.
Enter multiple file system names in comma-separated format.
For example, |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| directory_name | string The managed directory name without the file system name prefix.
A full managed directory name is constructed in the form of |
| path | string Path of the managed directory in the file system. |
{- "directory_name": "string",
- "path": "string"
}{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "created": 0,
- "destroyed": true,
- "directory_name": "string",
- "file_system": {
- "id": "string",
- "name": "string"
}, - "limited_by": {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "path": "string",
- "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0
}, - "time_remaining": 0
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| 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 |
{- "name": "string",
- "directory_name": "string"
}{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "created": 0,
- "destroyed": true,
- "directory_name": "string",
- "file_system": {
- "id": "string",
- "name": "string"
}, - "limited_by": {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "path": "string",
- "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0
}, - "time_remaining": 0
}
]
}Displays a list of groups, that have content in specific directories.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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_names | Array of strings Performs the operation on the file system name specified.
Enter multiple file system names in comma-separated format.
For example, |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| group_ids | Array of integers <int64> Performs the operation on the groups that match the given list of gids.
Enter names in a comma-separated format, e.g., |
| 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, |
| group_sids | Array of strings Performs the operation on the specified group SID.
Enter multiple group SIDs in comma-separated format.
For example, |
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "directory_name": "string",
- "file_system": {
- "id": "string",
- "name": "string"
}, - "group": {
- "id": 0,
- "name": "string",
- "sid": "string"
}, - "limited_by": {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "path": "string",
- "space": {
- "dynamic_limit": 10737418240,
- "total_used": 10737418240
}
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Creates an NLM reclamation, which is a system-wide operation that affects all clients, 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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "end": 0,
- "start": 0
}
]
}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.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| destroyed | boolean If set to If object name(s) or id(s) are specified, then each object referenced must exist.
If |
| end_time | integer <int64> Displays historical performance data for the specified time window,
where |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| protocol_group | string Protocol group type. Valid values are |
| resolution | integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data.
For array-wide performance metrics ( |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| start_time | integer <int64> Displays historical performance data for the specified time window,
where |
| total_item_count | boolean If set to |
| total_only | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
], - "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "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",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "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
}
]
}Displays a list of policies that are attached to directories.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| destroyed | boolean If set to If object name(s) or id(s) are specified, then each object referenced must exist.
If |
| 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 |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| 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_names | Array of strings Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
For example, |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "destroyed": true,
- "enabled": true,
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "time_remaining": 0
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Displays a list of audit policies that are attached to directories.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| destroyed | boolean If set to If object name(s) or id(s) are specified, then each object referenced must exist.
If |
| 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 |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| 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_names | Array of strings Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
For example, |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "destroyed": true,
- "enabled": true,
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "time_remaining": 0
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Array of objects (_directorypolicypostPolicies) A list of policies to apply to the resource.
The |
{- "policies": [
- {
- "policy": {
- "id": "string",
- "name": "string"
}
}
]
}{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "destroyed": true,
- "enabled": true,
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "time_remaining": 0
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| policy_ids | Array of strings Performs the operation on the unique policy IDs specified.
Enter multiple policy IDs in comma-separated format.
The |
| policy_names | Array of strings Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Displays a list of auto managed directory policies that are attached to directories.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| destroyed | boolean If set to If object name(s) or id(s) are specified, then each object referenced must exist.
If |
| 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 |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| 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_names | Array of strings Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
For example, |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "destroyed": true,
- "enabled": true,
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "time_remaining": 0
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Array of objects (_directorypolicypostPolicies) A list of policies to apply to the resource.
The |
{- "policies": [
- {
- "policy": {
- "id": "string",
- "name": "string"
}
}
]
}{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "destroyed": true,
- "enabled": true,
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "time_remaining": 0
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| policy_ids | Array of strings Performs the operation on the unique policy IDs specified.
Enter multiple policy IDs in comma-separated format.
The |
| policy_names | Array of strings Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Displays a list of NFS policies that are attached to directories.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| destroyed | boolean If set to If object name(s) or id(s) are specified, then each object referenced must exist.
If |
| 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 |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| 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_names | Array of strings Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "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",
- "server": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Array of objects (_directorypolicyexportpostPolicies) A list of export policies to apply to the directory.
The |
{- "policies": [
- {
- "export_enabled": false,
- "export_name": "string",
- "policy": {
- "id": "string",
- "name": "string"
}, - "server": {
- "id": "string",
- "name": "string"
}
}
]
}{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "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",
- "server": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| policy_ids | Array of strings Performs the operation on the unique policy IDs specified.
Enter multiple policy IDs in comma-separated format.
The |
| policy_names | Array of strings Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| server_ids | Array of strings A comma-separated list of server IDs. |
| server_names | Array of strings Server names for which the export object is going to be evaluated.
Names are expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Displays a list of quota policies that are attached to directories.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| destroyed | boolean If set to If object name(s) or id(s) are specified, then each object referenced must exist.
If |
| 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 |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| 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_names | Array of strings Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
For example, |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "destroyed": true,
- "enabled": true,
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "time_remaining": 0
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| ignore_usage | boolean Flag used to override checks for quota management operations.
If set to |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Array of objects (_directorypolicypostPolicies) A list of policies to apply to the resource.
The |
{- "policies": [
- {
- "policy": {
- "id": "string",
- "name": "string"
}
}
]
}{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "destroyed": true,
- "enabled": true,
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "time_remaining": 0
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| policy_ids | Array of strings Performs the operation on the unique policy IDs specified.
Enter multiple policy IDs in comma-separated format.
The |
| policy_names | Array of strings Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Displays a list of SMB policies that are attached to directories.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| destroyed | boolean If set to If object name(s) or id(s) are specified, then each object referenced must exist.
If |
| 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 |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| 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_names | Array of strings Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "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",
- "server": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Array of objects (_directorypolicyexportpostPolicies) A list of export policies to apply to the directory.
The |
{- "policies": [
- {
- "export_enabled": false,
- "export_name": "string",
- "policy": {
- "id": "string",
- "name": "string"
}, - "server": {
- "id": "string",
- "name": "string"
}
}
]
}{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "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",
- "server": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| policy_ids | Array of strings Performs the operation on the unique policy IDs specified.
Enter multiple policy IDs in comma-separated format.
The |
| policy_names | Array of strings Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| server_ids | Array of strings A comma-separated list of server IDs. |
| server_names | Array of strings Server names for which the export object is going to be evaluated.
Names are expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Displays a list of snapshot policies that are attached to directories.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| destroyed | boolean If set to If object name(s) or id(s) are specified, then each object referenced must exist.
If |
| 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 |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| 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_names | Array of strings Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
For example, |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "destroyed": true,
- "enabled": true,
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "time_remaining": 0
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Array of objects (_directorypolicypostPolicies) A list of policies to apply to the resource.
The |
{- "policies": [
- {
- "policy": {
- "id": "string",
- "name": "string"
}
}
]
}{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "destroyed": true,
- "enabled": true,
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "time_remaining": 0
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| policy_ids | Array of strings Performs the operation on the unique policy IDs specified.
Enter multiple policy IDs in comma-separated format.
The |
| policy_names | Array of strings Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Displays a list of user-group-quota policies that are attached to directories.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| destroyed | boolean If set to If object name(s) or id(s) are specified, then each object referenced must exist.
If |
| 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 |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| 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_names | Array of strings Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
For example, |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "destroyed": true,
- "enabled": true,
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "time_remaining": 0
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Creates a membership between a directory and one or more user-group-quota policies.
The member_ids or member_names parameter is required, but cannot be set together.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| ignore_usage | boolean Flag used to override checks for user-group-quota management operations.
If set to |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Array of objects (_directorypolicypostPolicies) A list of policies to apply to the resource.
The |
{- "policies": [
- {
- "policy": {
- "id": "string",
- "name": "string"
}
}
]
}{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "destroyed": true,
- "enabled": true,
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "time_remaining": 0
}
]
}Deletes a membership between a directory and one or more user-group-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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| ignore_usage | boolean Flag used to override checks for user-group-quota management operations.
If set to |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| policy_ids | Array of strings Performs the operation on the unique policy IDs specified.
Enter multiple policy IDs in comma-separated format.
The |
| policy_names | Array of strings Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Displays physical storage consumption data for each directory.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| destroyed | boolean If set to If object name(s) or id(s) are specified, then each object referenced must exist.
If |
| end_time | integer <int64> Displays historical performance data for the specified time window,
where |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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. |
| resolution | integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data.
For array-wide performance metrics ( |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| start_time | integer <int64> Displays historical performance data for the specified time window,
where |
| total_item_count | boolean If set to |
| total_only | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
], - "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0
}, - "time": 0
}
], - "total": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0
}, - "time": 0
}
]
}Displays a list of users that have content in specific directories.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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_names | Array of strings Performs the operation on the file system name specified.
Enter multiple file system names in comma-separated format.
For example, |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| user_ids | Array of integers <int64> Performs the operation on the users that match the given list of uids.
Enter names in a comma-separated format, for example, |
| user_names | Array of strings Performs the operation on the users that match the given list of user names.
Enter names in a comma-separated format, for example, |
| user_sids | Array of strings Performs the operation on the users that match the given list of user SIDs.
Enter SIDs in a comma-separated format, for example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "directory_name": "string",
- "file_system": {
- "id": "string",
- "name": "string"
}, - "limited_by": {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "path": "string",
- "space": {
- "dynamic_limit": 10737418240,
- "total_used": 10737418240
}, - "user": {
- "id": 0,
- "name": "string",
- "sid": "string"
}
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Managed directory exports are created by adding NFS or SMB export policies to managed directories.
Displays a list of directory exports.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| destroyed | boolean If set to If object name(s) or id(s) are specified, then each object referenced must exist.
If |
| 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_names | Array of strings Performs the operation on the managed directory names specified.
Enter multiple full managed directory names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| export_names | Array of strings Performs the operation on the export names specified. Enter multiple names in comma-separated
format. For example, |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
Combines the export containment hierarchy (server), the protocol (smb or nfs)
and the export_name.
For example, |
| 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_names | Array of strings Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "enabled": true,
- "export_name": "string",
- "status": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "server": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "destroyed": true,
- "directory": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "name": "server01::nfs::export01",
- "path": "string",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}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.
When server reference is not provided, the _array_server is set as effective default.
The API provides two options for identifying an export object. One option is to reference
it by its fully qualified export name, or alternatively, by a combination of
parameters—specifically, the server and export_name. All identifying parameters must
always be provided, either explicitly or as part of the fully qualified name.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| 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_names | Array of strings Performs the operation on the managed directory names specified.
Enter multiple full managed directory names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
Combines the export containment hierarchy (server), the protocol (smb or nfs)
and the export_name.
For example, |
| policy_ids | Array of strings Performs the operation on the unique policy IDs specified.
Enter multiple policy IDs in comma-separated format.
The |
| policy_names | Array of strings Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| export_enabled | boolean Indicates whether the export is enabled.
If set to |
| export_name | string The name of the export to create. Export names must be unique within the same protocol and server. |
object (Reference) Server to which the directory export is attached to. |
{- "export_enabled": false,
- "export_name": "string",
- "server": {
- "id": "string",
- "name": "string"
}
}{- "items": [
- {
- "enabled": true,
- "export_name": "string",
- "status": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "server": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "destroyed": true,
- "directory": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "name": "server01::nfs::export01",
- "path": "string",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}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.
When server reference is not provided, the _array_server is set as effective default.
The API provides two options for identifying an export object. One option is to reference
it by its fully qualified export name, or alternatively, by a combination of
parameters-specifically, the server_names (or server_ids) and export_names. All
identifying parameters must always be provided, either explicitly or as part of the
fully qualified name.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| 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_names | Array of strings Performs the operation on the managed directory names specified.
Enter multiple full managed directory names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| export_names | Array of strings Performs the operation on the export names specified. Enter multiple names in comma-separated
format. For example, |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
Combines the export containment hierarchy (server), the protocol (smb or nfs)
and the export_name.
For example, |
| policy_ids | Array of strings Performs the operation on the unique policy IDs specified.
Enter multiple policy IDs in comma-separated format.
The |
| policy_names | Array of strings Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| server_ids | Array of strings A comma-separated list of server IDs. |
| server_names | Array of strings Server names for which the export object is going to be evaluated.
Names are expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
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.
When server reference is not provided, the _array_server is set as effective default.
The API provides two options for identifying an export object. One option is to reference
it by its fully qualified export name, or alternatively, by a combination of
parameters—specifically, the server and export_name. All identifying parameters must
always be provided, either explicitly or as part of the fully qualified name.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| 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_names | Array of strings Performs the operation on the managed directory names specified.
Enter multiple full managed directory names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| export_names | Array of strings Performs the operation on the export names specified. Enter multiple names in comma-separated
format. For example, |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
Combines the export containment hierarchy (server), the protocol (smb or nfs)
and the export_name.
For example, |
| policy_ids | Array of strings Performs the operation on the unique policy IDs specified.
Enter multiple policy IDs in comma-separated format.
The |
| policy_names | Array of strings Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| server_ids | Array of strings A comma-separated list of server IDs. |
| server_names | Array of strings Server names for which the export object is going to be evaluated.
Names are expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| export_enabled | boolean If set to |
| export_name | string The new name of the export. Export names must be unique within the same protocol. |
{- "export_enabled": false,
- "export_name": "string"
}{- "items": [
- {
- "enabled": true,
- "export_name": "string",
- "status": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "server": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "destroyed": true,
- "directory": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "name": "server01::nfs::export01",
- "path": "string",
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}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.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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_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, |
| 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 |
| 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_names | Array of strings Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
For example, |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "directory": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "enabled": true,
- "enforced": true,
- "path": "string",
- "percentage_used": 0,
- "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "quota_limit": 0,
- "rule_name": "string",
- "usage": 0
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Manages directory service configurations for integration with LDAP servers (e.g. Active Directory and OpenLDAP) in order to support various array services.
Displays the directory services configuration settings for manageability.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "base_dn": "DC=mycompany,DC=com",
- "bind_password": "****",
- "bind_user": "CN=John,OU=Users,DC=example,DC=com",
- "enabled": true,
- "services": [
- "data",
- "management"
], - "uris": [
- "ldaps://ad1.mycompany.com"
], - "ca_certificate": "string",
- "ca_certificate_ref": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "check_peer": false,
- "management": {
- "ssh_public_key_attribute": "sshPublicKey",
- "user_login_attribute": "email",
- "user_object_class": "inetOrgPerson"
}, - "sources": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
]
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Creates directory services configuration.
All directory services configuration created using this resource will have services
set to data.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| names required | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
object (FixedReferenceWithType) The context in which the operation was performed.
Valid values include a reference to any array which is a member of the same fleet.
If the array is not a member of a fleet, Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided | |
| 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. |
| enabled | boolean The directory service is either enabled or disabled. |
| uris | Array of strings List of URIs for the configured directory servers. |
Array of objects (_reference) List of network interfaces used for egress. For directory services at the array level, this list can be empty. If the list is empty, the system will use VIFs with the "ds" service (or if none, the "management" service) for egress. |
{- "context": { },
- "base_dn": "DC=mycompany,DC=com",
- "bind_password": "****",
- "bind_user": "CN=John,OU=Users,DC=example,DC=com",
- "enabled": true,
- "uris": [
- "ldaps://ad1.mycompany.com"
], - "sources": [
- {
- "id": "string",
- "name": "string"
}
]
}{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "base_dn": "DC=mycompany,DC=com",
- "bind_password": "****",
- "bind_user": "CN=John,OU=Users,DC=example,DC=com",
- "enabled": true,
- "services": [
- "data",
- "management"
], - "uris": [
- "ldaps://ad1.mycompany.com"
], - "ca_certificate": "string",
- "ca_certificate_ref": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "check_peer": false,
- "management": {
- "ssh_public_key_attribute": "sshPublicKey",
- "user_login_attribute": "email",
- "user_object_class": "inetOrgPerson"
}, - "sources": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
]
}
]
}Deletes directory services configuration. Directory service configuration must not be referenced by any server nor enabled to be deleted. The built-in "management" directory service cannot be deleted.
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Modifies the directory service configuration.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| name | string The new name for the resource.
The name is expected to be fully qualified, meaning if the object is contained in some
context, the corresponding name would provide complete information about the containment
hierarchy. For example, |
object (FixedReferenceWithType) The context in which the operation was performed.
Valid values include a reference to any array which is a member of the same fleet.
If the array is not a member of a fleet, Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided | |
| 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. |
| enabled | boolean The directory service is either enabled or disabled. |
| uris | Array of strings List of URIs for the configured directory servers. |
| 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.
Deprecated, please use ca_certificate_ref instead. Setting this field will result in
ca_certificate_ref being updated to legacy_ds_ca_certificate |
object (ReferenceWithType) Reference (ID, name, and resource type) 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 Determines whether or not server authenticity is enforced when a certificate is provided. |
object (_directoryServiceManagement) Properties specific to the management service. | |
Array of objects (_reference) List of network interfaces used for egress. For directory services at the array level, this list can be empty. If the list is empty, the system will use VIFs with the "ds" service (or if none, the "management" service) for egress. |
{- "name": "string",
- "context": { },
- "base_dn": "DC=mycompany,DC=com",
- "bind_password": "****",
- "bind_user": "CN=John,OU=Users,DC=example,DC=com",
- "enabled": true,
- "uris": [
- "ldaps://ad1.mycompany.com"
], - "ca_certificate": "string",
- "ca_certificate_ref": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "check_peer": false,
- "management": {
- "ssh_public_key_attribute": "sshPublicKey",
- "user_login_attribute": "email",
- "user_object_class": "inetOrgPerson"
}, - "sources": [
- {
- "id": "string",
- "name": "string"
}
]
}{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "base_dn": "DC=mycompany,DC=com",
- "bind_password": "****",
- "bind_user": "CN=John,OU=Users,DC=example,DC=com",
- "enabled": true,
- "services": [
- "data",
- "management"
], - "uris": [
- "ldaps://ad1.mycompany.com"
], - "ca_certificate": "string",
- "ca_certificate_ref": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "check_peer": false,
- "management": {
- "ssh_public_key_attribute": "sshPublicKey",
- "user_login_attribute": "email",
- "user_object_class": "inetOrgPerson"
}, - "sources": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
]
}
]
}Displays access control settings for remote groups.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique names specified.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "group": "groupOfUsers",
- "group_base": "OU=PureGroups,OU=SANManagers",
- "management_access_policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "role": {
- "name": "string"
}
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Creates one or more groups in management access policy mappings.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| names required | Array of strings Performs the operation on the unique names specified.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| 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. |
Array of objects (_referenceWithType) List of management access policies to associate with the group. | |
object (ReferenceNoId) 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. |
{- "group": "groupOfUsers",
- "group_base": "OU=PureGroups,OU=SANManagers",
- "management_access_policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "role": {
- "name": "string"
}
}{- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "group": "groupOfUsers",
- "group_base": "OU=PureGroups,OU=SANManagers",
- "management_access_policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "role": {
- "name": "string"
}
}
]
}Deletes one or more group to management access policy mappings.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| names required | Array of strings Performs the operation on the unique names specified.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| names required | Array of strings Performs the operation on the unique names specified.
For example, |
| role_names | Array of strings This field has been deprecated. |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
object (FixedReferenceWithType) The context in which the operation was performed.
Valid values include a reference to any array which is a member of the same fleet.
If the array is not a member of a fleet, Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided | |
| 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. |
object (ReferenceNoId) This field has been deprecated. Predecessor to management access policies. |
{- "context": { },
- "group": "groupOfUsers",
- "group_base": "OU=PureGroups,OU=SANManagers",
- "role": {
- "name": "string"
}
}{- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "group": "groupOfUsers",
- "group_base": "OU=PureGroups,OU=SANManagers",
- "management_access_policies": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "role": {
- "name": "string"
}
}
]
}Displays a list of management access policies that are attached to a group to management access policy mappings.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| 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_names | Array of strings Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
For example, |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Creates a membership between a group to management access policy mapping with one or more
management access policies. One of member_ids or member_names parameter is required.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Array of objects (PolicyAssignmentPostPolicy) A list of policies to apply to the resource.
One of |
{- "policies": [
- {
- "policy": {
- "id": "string",
- "name": "string"
}
}
]
}{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "policy": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}Deletes a membership between a group to management access policy mapping with one or more
management access policies. One of policy_ids or policy_names is required, and one of
member_ids or member_names is required.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| policy_ids | Array of strings Performs the operation on the unique policy IDs specified.
Enter multiple policy IDs in comma-separated format.
The |
| policy_names | Array of strings Performs the operation on the policy names specified.
Enter multiple policy names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
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.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| names required | Array of strings Performs the operation on the unique name specified.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "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",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "resource": {
- "name": "string"
}
}
]
}Displays a list of local directory services.
| 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 |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "domain": "domain"
}
]
}Creates a local directory service.
| names required | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| domain | string The name of the domain stored in this local directory service. All users and groups are going to be presented as being part of this domain name. When not set, it defaults to name of the Local Directory Service. For example, for object "mydomain" the domain name will be "mydomain" where domain name does not have any unique constraint (it can be the same for different local directory services within an array. |
{- "domain": "domain"
}{- "items": [
- {
- "id": "string",
- "name": "string",
- "domain": "domain"
}
]
}Deletes local directory services. Local directory service can't be deleted when referenced by any server.
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Modifies local directory services.
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| name | string A user-specified name. The name must be locally unique and can be changed. |
| domain | string The name of the domain stored in this local directory service. All users and groups are going to be presented as being part of this domain name. When not set, it defaults to name of the Local Directory Service. For example, for object "mydomain" the domain name will be "mydomain" where domain name does not have any unique constraint (it can be the same for different local directory services within an array. |
{- "name": "string",
- "domain": "domain"
}{- "items": [
- {
- "id": "string",
- "name": "string",
- "domain": "domain"
}
]
}Displays a list of local groups.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| gids | Array of integers <int32> Performs the operation on the specified GIDs.
Enter multiple GIDs in comma-separated format.
For example, |
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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. |
| sids | Array of strings Performs the operation on the object SID specified.
Enter multiple SIDs in comma-separated format.
For example, |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "local_directory_service": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "built_in": true,
- "email": "string",
- "gid": 0,
- "name": "string",
- "sid": "string"
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Creates a local group.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| local_directory_service_ids | Array of strings Performs the operation on the specified local directory service. Supports exactly one value.
When not specified, the local directory service connected to the |
| local_directory_service_names | Array of strings Performs the operation on the specified local directory service. Supports exactly one value.
When not specified, the local directory service connected to the |
| names required | Array of strings Performs the operation on the unique name specified.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
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. |
{- "email": "string",
- "gid": 0
}{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "local_directory_service": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "built_in": true,
- "email": "string",
- "gid": 0,
- "name": "string",
- "sid": "string"
}
]
}Deletes one or more local groups.
The gids, names, or sids parameter is required, but cannot be set together.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| gids | Array of integers <int32> Performs the operation on the specified GIDs.
Enter multiple GIDs in comma-separated format.
For example, |
| local_directory_service_ids | Array of strings Performs the operation on the specified local directory service. Supports exactly one value.
When not specified, the local directory service connected to the |
| local_directory_service_names | Array of strings Performs the operation on the specified local directory service. Supports exactly one value.
When not specified, the local directory service connected to the |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| sids | Array of strings Performs the operation on the object SID specified.
Enter multiple SIDs in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Modifies local groups.
The gids, names, or sids parameter is required, but cannot be set together.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| gids | Array of integers <int32> Performs the operation on the specified GIDs.
Enter multiple GIDs in comma-separated format.
For example, |
| local_directory_service_ids | Array of strings Performs the operation on the specified local directory service. Supports exactly one value.
When not specified, the local directory service connected to the |
| local_directory_service_names | Array of strings Performs the operation on the specified local directory service. Supports exactly one value.
When not specified, the local directory service connected to the |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| sids | Array of strings Performs the operation on the object SID specified.
Enter multiple SIDs in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
object (FixedReferenceWithType) The context in which the operation was performed.
Valid values include a reference to any array which is a member of the same fleet.
If the array is not a member of a fleet, Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided | |
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. |
{- "context": { },
- "email": "string",
- "gid": 0,
- "name": "string"
}{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "local_directory_service": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "built_in": true,
- "email": "string",
- "gid": 0,
- "name": "string",
- "sid": "string"
}
]
}Displays a list of local group memberships.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| group_gids | Array of integers <int32> Performs the operation on the specified GIDs.
Enter multiple GIDs in comma-separated format.
For example, |
| group_names | Array of strings Performs the operation on the group names specified.
Enter multiple group names in comma-separated format.
For example, |
| group_sids | Array of strings Performs the operation on the specified group SID.
Enter multiple group SIDs in comma-separated format.
For example, |
| 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 |
| 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_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, |
| member_sids | Array of strings Performs the operation on the specified member SID.
Enter multiple member SIDs in comma-separated format.
For example, |
| 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 |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "local_directory_service": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "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
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Creates a local group membership with a group.
The group_names, group_sids, or group_gids parameter is required, but cannot be set
together.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| group_gids | Array of integers <int32> Performs the operation on the specified GIDs.
Enter multiple GIDs in comma-separated format.
For example, |
| group_names | Array of strings Performs the operation on the group names specified.
Enter multiple group names in comma-separated format.
For example, |
| group_sids | Array of strings Performs the operation on the specified group SID.
Enter multiple group SIDs in comma-separated format.
For example, |
| local_directory_service_ids | Array of strings Performs the operation on the specified local directory service. Supports exactly one value.
When not specified, the local directory service connected to the |
| local_directory_service_names | Array of strings Performs the operation on the specified local directory service. Supports exactly one value.
When not specified, the local directory service connected to the |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
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. |
{- "members": [
- {
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "member_id": 0
}
]
}{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "local_directory_service": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "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
}
]
}Deletes one or more local group memberships.
The group_names, group_sids, or group_gids parameter is required, but cannot be set
together.
The member_names, member_sids, or member_gids parameter is required, but cannot be set
together.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| group_gids | Array of integers <int32> Performs the operation on the specified GIDs.
Enter multiple GIDs in comma-separated format.
For example, |
| group_names | Array of strings Performs the operation on the group names specified.
Enter multiple group names in comma-separated format.
For example, |
| group_sids | Array of strings Performs the operation on the specified group SID.
Enter multiple group SIDs in comma-separated format.
For example, |
| local_directory_service_ids | Array of strings Performs the operation on the specified local directory service. Supports exactly one value.
When not specified, the local directory service connected to the |
| local_directory_service_names | Array of strings Performs the operation on the specified local directory service. Supports exactly one value.
When not specified, the local directory service connected to the |
| 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_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, |
| member_sids | Array of strings Performs the operation on the specified member SID.
Enter multiple member SIDs in comma-separated format.
For example, |
| 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 |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Displays a list of local users.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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. |
| sids | Array of strings Performs the operation on the object SID specified.
Enter multiple SIDs in comma-separated format.
For example, |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| total_item_count | boolean If set to |
| 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, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "local_directory_service": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "built_in": true,
- "email": "string",
- "enabled": true,
- "name": "string",
- "primary_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "sid": "string",
- "uid": 0
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Creates a local user.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| local_directory_service_ids | Array of strings Performs the operation on the specified local directory service. Supports exactly one value.
When not specified, the local directory service connected to the |
| local_directory_service_names | Array of strings Performs the operation on the specified local directory service. Supports exactly one value.
When not specified, the local directory service connected to the |
| names required | Array of strings Performs the operation on the unique name specified.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
string Optional field to set the email of the local user. | |
| enabled | boolean If this field is |
| password | string The password of the local user. This field is only required if the |
object (ReferenceWithType) 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. |
{- "email": "string",
- "enabled": true,
- "password": "string",
- "primary_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "uid": 0
}{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "local_directory_service": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "built_in": true,
- "email": "string",
- "enabled": true,
- "name": "string",
- "primary_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "sid": "string",
- "uid": 0
}
]
}Deletes one or more local users.
The uids, names, or sids parameter is required, but cannot be set together.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| local_directory_service_ids | Array of strings Performs the operation on the specified local directory service. Supports exactly one value.
When not specified, the local directory service connected to the |
| local_directory_service_names | Array of strings Performs the operation on the specified local directory service. Supports exactly one value.
When not specified, the local directory service connected to the |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| sids | Array of strings Performs the operation on the object SID specified.
Enter multiple SIDs in comma-separated format.
For example, |
| 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, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Modifies a local user.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| keep_open_sessions | boolean If set to |
| local_directory_service_ids | Array of strings Performs the operation on the specified local directory service. Supports exactly one value.
When not specified, the local directory service connected to the |
| local_directory_service_names | Array of strings Performs the operation on the specified local directory service. Supports exactly one value.
When not specified, the local directory service connected to the |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| sids | Array of strings Performs the operation on the object SID specified.
Enter multiple SIDs in comma-separated format.
For example, |
| 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, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
string Optional field to set the email of the local user. | |
| enabled | boolean If this field is |
| name | string The local user name. |
| password | string The password of the local user. This field is only required if the |
object (ReferenceWithType) 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. |
{- "email": "string",
- "enabled": true,
- "name": "string",
- "password": "string",
- "primary_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "uid": 0
}{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "local_directory_service": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "built_in": true,
- "email": "string",
- "enabled": true,
- "name": "string",
- "primary_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "sid": "string",
- "uid": 0
}
]
}Displays a list of local user memberships.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| filter | string Narrows down the results to only the response objects that satisfy the filter criteria. |
| group_gids | Array of integers <int32> Performs the operation on the specified GIDs.
Enter multiple GIDs in comma-separated format.
For example, |
| group_names | Array of strings Performs the operation on the group names specified.
Enter multiple group names in comma-separated format.
For example, |
| group_sids | Array of strings Performs the operation on the specified group SID.
Enter multiple group SIDs in comma-separated format.
For example, |
| 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 |
| 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_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, |
| member_sids | Array of strings Performs the operation on the specified member SID.
Enter multiple member SIDs in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "local_directory_service": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "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
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| local_directory_service_ids | Array of strings Performs the operation on the specified local directory service. Supports exactly one value.
When not specified, the local directory service connected to the |
| local_directory_service_names | Array of strings Performs the operation on the specified local directory service. Supports exactly one value.
When not specified, the local directory service connected to the |
| 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_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, |
| member_sids | Array of strings Performs the operation on the specified member SID.
Enter multiple member SIDs in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
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. |
{- "groups": [
- {
- "group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "group_gid": 0
}
], - "is_primary": false
}{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "local_directory_service": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "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
}
]
}Deletes one or more local user memberships.
The member_names, member_sids, or member_ids parameter is required, but cannot be set
together.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| group_gids | Array of integers <int32> Performs the operation on the specified GIDs.
Enter multiple GIDs in comma-separated format.
For example, |
| group_names | Array of strings Performs the operation on the group names specified.
Enter multiple group names in comma-separated format.
For example, |
| group_sids | Array of strings Performs the operation on the specified group SID.
Enter multiple group SIDs in comma-separated format.
For example, |
| local_directory_service_ids | Array of strings Performs the operation on the specified local directory service. Supports exactly one value.
When not specified, the local directory service connected to the |
| local_directory_service_names | Array of strings Performs the operation on the specified local directory service. Supports exactly one value.
When not specified, the local directory service connected to the |
| 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_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, |
| member_sids | Array of strings Performs the operation on the specified member SID.
Enter multiple member SIDs in comma-separated format.
For example, |
| 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 |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Directory snapshots are created manually or by adding snapshot policies to managed directories. Each snapshot policy can be re-used for multiple directories.
Displays a list of directory snapshots, including those pending eradication.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| destroyed | boolean If set to If object name(s) or id(s) are specified, then each object referenced must exist.
If |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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, |
| total_item_count | boolean If set to |
| total_only | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "client_name": "string",
- "created": 0,
- "destroyed": true,
- "policy": {
- "id": "string",
- "name": "string"
}, - "source": {
- "id": "string",
- "name": "string"
}, - "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0
}, - "suffix": 0,
- "time_remaining": 0
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
], - "total": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "client_name": "string",
- "created": 0,
- "destroyed": true,
- "policy": {
- "id": "string",
- "name": "string"
}, - "source": {
- "id": "string",
- "name": "string"
}, - "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0
}, - "suffix": 0,
- "time_remaining": 0
}
]
}Creates a snapshot of the contents of a directory.
The source_ids or source_names parameter is required, but they cannot be set together.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| 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, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| client_name | string The client name portion of the client visible snapshot name.
A full snapshot name is constructed in the form of |
| 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 |
{- "client_name": "string",
- "keep_for": 0,
- "suffix": "string"
}{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "client_name": "string",
- "created": 0,
- "destroyed": true,
- "policy": {
- "id": "string",
- "name": "string"
}, - "source": {
- "id": "string",
- "name": "string"
}, - "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0
}, - "suffix": 0,
- "time_remaining": 0
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| destroyed | boolean If set to |
| client_name | string The client name portion of the client-visible snapshot name.
A full snapshot name is constructed in the form of |
| 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 |
| name | string The new name of a directory snapshot. The name of a directory snapshot managed by a snapshot policy is not changeable. |
object (Reference) The snapshot policy that manages this snapshot.
Set to | |
| suffix | string The suffix portion of the client-visible snapshot name.
A full snapshot name is constructed in the form of |
{- "destroyed": true,
- "client_name": "string",
- "keep_for": 0,
- "name": "string",
- "policy": {
- "id": "string",
- "name": "string"
}, - "suffix": "string"
}{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "client_name": "string",
- "created": 0,
- "destroyed": true,
- "policy": {
- "id": "string",
- "name": "string"
}, - "source": {
- "id": "string",
- "name": "string"
}, - "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0
}, - "suffix": 0,
- "time_remaining": 0
}
]
}DNS attributes include the domain suffix, static name servers, mode (static or DHCP), and search domain. The configured attributes can be listed.
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.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "ca_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "domain": "example.com",
- "nameservers": [
- "192.168.0.125"
], - "services": [
- "string"
], - "source": {
- "name": "string"
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
object (ReferenceWithType) A reference to the | |
object (ReferenceWithType) A reference to the | |
| domain | string The domain suffix to be appended by the appliance when performing DNS lookups. |
| nameservers | Array of strings The list of DNS servers either in the form of IP addresses or HTTPS endpoints.
Domain names in HTTPS endpoints are not supported. IP addresses must be used instead.
If nameservers begin with |
| services | Array of strings The list of services utilizing the DNS configuration. |
object (ReferenceNoId) The network interface used for communication with the DNS server. |
{- "ca_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "domain": "example.com",
- "nameservers": [
- "192.168.0.125"
], - "services": [
- "string"
], - "source": {
- "name": "string"
}
}{- "items": [
- {
- "name": "string",
- "ca_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "domain": "example.com",
- "nameservers": [
- "192.168.0.125"
], - "services": [
- "string"
], - "source": {
- "name": "string"
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}Deletes DNS configuration identified by configuration name.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
The name is expected to be fully qualified, meaning if the object is contained in some context,
the corresponding name would provide complete information about the containment hierarchy.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| name | string The new name for the resource. |
object (ReferenceWithType) A reference to the | |
object (ReferenceWithType) A reference to the | |
| domain | string The domain suffix to be appended by the appliance when performing DNS lookups. |
| nameservers | Array of strings The list of DNS servers either in the form of IP addresses or HTTPS endpoints.
Domain names in HTTPS endpoints are not supported. IP addresses must be used instead.
If nameservers begin with |
| services | Array of strings The list of services utilizing the DNS configuration. |
object (ReferenceNoId) The network interface used for communication with the DNS server. |
{- "name": "string",
- "ca_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "domain": "example.com",
- "nameservers": [
- "192.168.0.125"
], - "services": [
- "string"
], - "source": {
- "name": "string"
}
}{- "items": [
- {
- "name": "string",
- "ca_certificate": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "ca_certificate_group": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "domain": "example.com",
- "nameservers": [
- "192.168.0.125"
], - "services": [
- "string"
], - "source": {
- "name": "string"
}, - "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}Drive data includes the name, type, status, capacity, protocol and other information for all flash, NVRAM, and cache modules in an array.
Displays a list of flash, NVRAM, and cache modules that are installed in the array along with their attributes and status.
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "capacity": 10000000000000,
- "capacity_installed": 42000000000000,
- "details": "Cache module in wrong bay.",
- "protocol": "SAS",
- "status": "healthy",
- "type": "SSD"
}
]
}Modifies flash and NVRAM modules that have been added or connected but not yet admitted to the array.
| admit | boolean If |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "items": [
- {
- "name": "string",
- "capacity": 10000000000000,
- "capacity_installed": 42000000000000,
- "details": "Cache module in wrong bay.",
- "protocol": "SAS",
- "status": "healthy",
- "type": "SSD"
}
]
}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.
Displays a list of file systems, including those pending eradication.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| destroyed | boolean If set to If object name(s) or id(s) are specified, then each object referenced must exist.
If |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "created": 0,
- "destroyed": true,
- "pod": {
- "id": "string",
- "name": "string"
}, - "time_remaining": 0
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Creates one or more file systems.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| names required | Array of strings Performs the operation on the unique name specified.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "created": 0,
- "destroyed": true,
- "pod": {
- "id": "string",
- "name": "string"
}, - "time_remaining": 0
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| destroyed | boolean If set to |
| name | string The new name for the resource. |
object (Reference) The pod to move existing file systems into. |
{- "destroyed": true,
- "name": "string",
- "pod": {
- "id": "string",
- "name": "string"
}
}{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "created": 0,
- "destroyed": true,
- "pod": {
- "id": "string",
- "name": "string"
}, - "time_remaining": 0
}
]
}Displays information about the fleets known to the 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 |
| 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 |
| 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 |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "is_local": true
}
]
}Creates a fleet and adds the current array as its first member.
Additional arrays can be added to the fleet with POST /fleets/members.
| names | Array of strings Performs the operation on the unique resource names specified. Only one value is supported. |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "items": [
- {
- "id": "string",
- "name": "string",
- "is_local": true
}
]
}Deletes a fleet, permanently. A fleet can only be deleted if the current array is the only array in the fleet.
| ids | Array of strings Performs the operation on the unique resource IDs specified. Only one value is supported. |
| names | Array of strings Performs the operation on the unique resource names specified. Only one value is supported. |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Modifies a fleet, changing its name by passing the old name in name query parameter, and the
new name in the name parameter in the request body.
| ids | Array of strings Performs the operation on the unique resource IDs specified. Only one value is supported. |
| names | Array of strings Performs the operation on the unique resource names specified. Only one value is supported. |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| name | string The new name for the resource. |
{- "name": "string"
}{- "items": [
- {
- "id": "string",
- "name": "string",
- "is_local": true
}
]
}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.
| 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 |
| 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 |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "created": 1706850977,
- "expires": 1706854577,
- "fleet_key": "CAUSJDljMGM3MGY3LWFhZDEtNDRkZC05ZDQ2LTZlOTA3YzY3Yzg1YxokOWMwYzcwZjctYWFkMS00NGRkLTlkND"
}
]
}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.
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "items": [
- {
- "created": 1706850977,
- "expires": 1706854577,
- "fleet_key": "CAUSJDljMGM3MGY3LWFhZDEtNDRkZC05ZDQ2LTZlOTA3YzY3Yzg1YxokOWMwYzcwZjctYWFkMS00NGRkLTlkND"
}
]
}Displays the members in the current fleet.
| 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 |
| 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, |
| 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 |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "coordinator_of": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "fleet": {
- "id": "string",
- "name": "string",
- "is_local": true,
- "resource_type": "string"
}, - "member": {
- "id": "string",
- "name": "string",
- "is_local": true,
- "resource_type": "string"
}, - "status": "string",
- "status_details": "cannot reach array"
}
]
}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.
| 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, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Info about the members being added to fleet.
Array of objects (_fleetmemberpostMembers) Details about the members being added to fleet. |
{- "members": [
- {
- "key": "string",
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}{- "items": [
- {
- "coordinator_of": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "fleet": {
- "id": "string",
- "name": "string",
- "is_local": true,
- "resource_type": "string"
}, - "member": {
- "id": "string",
- "name": "string",
- "is_local": true,
- "resource_type": "string"
}, - "status": "string",
- "status_details": "cannot reach array"
}
]
}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.
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| unreachable | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Operational status is reported by most of the hardware components in an array, including the chassis, controller, and storage shelf.
Displays a list of hardware slots and bays and status of installed components.
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "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
}
]
}Modifies the visual identification of a specified hardware component, and causing the ID LED to turn on or off.
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| 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. |
{- "identify_enabled": true,
- "index": 1
}{- "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 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.
Displays a list of host groups.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| destroyed | boolean If set to If object name(s) or id(s) are specified, then each object referenced must exist.
If |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "connection_count": 3,
- "destroyed": true,
- "host_count": 3,
- "is_local": true,
- "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0
}, - "time_remaining": 0
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Creates a host group in which the names query parameter is required.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Array of objects (NonCopyableTag) The list of tags to be upserted with the object. |
{- "tags": [
- {
- "key": "environment",
- "namespace": "default",
- "resource": { },
- "value": "staging"
}
]
}{- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "connection_count": 3,
- "destroyed": true,
- "host_count": 3,
- "is_local": true,
- "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0
}, - "time_remaining": 0
}
]
}Deletes a host group in which the names query parameter is required.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Modifies a host group in which the names query parameter is required.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| 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. |
| modify_resource_access | string Describes how to modify a resource accesses of a resource when that resource is moved.
Possible values are: |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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. |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| name | string The new name for the resource. |
{- "name": "string"
}{- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "connection_count": 3,
- "destroyed": true,
- "host_count": 3,
- "is_local": true,
- "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0
}, - "time_remaining": 0
}
]
}Displays a list of host groups that are associated with hosts.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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, |
| 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 |
| 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, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "group": {
- "name": "string"
}, - "member": {
- "name": "string"
}
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Create a membership between a host and a host group. Adding a membership 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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| 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, |
| 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, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "group": {
- "name": "string"
}, - "member": {
- "name": "string"
}
}
]
}Deletes a membership from a host group. Removing a membership 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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| 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, |
| 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, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
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.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| end_time | integer <int64> Displays historical performance data for the specified time window,
where |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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. |
| resolution | integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data.
For array-wide performance metrics ( |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| start_time | integer <int64> Displays historical performance data for the specified time window,
where |
| total_item_count | boolean If set to |
| total_only | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
], - "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_read_op_cache_reduction": 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,
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "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_read_op_cache_reduction": 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,
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}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.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| end_time | integer <int64> Displays historical performance data for the specified time window,
where |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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. |
| resolution | integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data.
For array-wide performance metrics ( |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| start_time | integer <int64> Displays historical performance data for the specified time window,
where |
| total_item_count | boolean If set to |
| total_only | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
], - "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_read_op_cache_reduction": 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,
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "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_read_op_cache_reduction": 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,
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "array": {
- "id": "string",
- "name": "string"
}
}
]
}Displays a list of host group members that belong to one or more protection groups.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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, |
| 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 |
| 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, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "group": {
- "id": "string",
- "name": "string"
}, - "member": {
- "name": "string"
}
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| 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, |
| 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, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "group": {
- "id": "string",
- "name": "string"
}, - "member": {
- "name": "string"
}
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| 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, |
| 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, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Displays provisioned size and physical storage consumption data for each host group.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
], - "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0
}, - "time": 0
}
]
}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.
Displays a list of hosts.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| destroyed | boolean If set to If object name(s) or id(s) are specified, then each object referenced must exist.
If |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "chap": {
- "host_password": "string",
- "host_user": "string",
- "target_password": "string",
- "target_user": "string"
}, - "connection_count": 3,
- "destroyed": true,
- "host_group": {
- "name": "string"
}, - "iqns": [
- "iqn.2010-06.com.purestorage:linux.393d930077be2977"
], - "is_local": true,
- "nqns": [
- "nqn.2010-06.com.purestorage:flasharray.512f7bb185978505"
], - "personality": "string",
- "port_connectivity": {
- "details": "Redundant",
- "status": "healthy"
}, - "preferred_arrays": [
- {
- "id": "string",
- "name": "string"
}
], - "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0
}, - "time_remaining": 0,
- "vlan": "1",
- "wwns": [
- "52:4A:93:70:4E:E5:68:00"
]
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Creates a host for which the names query parameter is required.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
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 |
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, | |
Array of objects (NonCopyableTag) The list of tags to be upserted with the object. | |
| vlan | string The VLAN ID that the host is associated with.
If not set or set to |
| wwns | Array of strings The Fibre Channel World Wide Name (WWN) associated with the host. |
{- "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"
}
], - "tags": [
- {
- "key": "environment",
- "namespace": "default",
- "resource": { },
- "value": "staging"
}
], - "vlan": "1",
- "wwns": [
- "52:4A:93:70:4E:E5:68:00"
]
}{- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "chap": {
- "host_password": "string",
- "host_user": "string",
- "target_password": "string",
- "target_user": "string"
}, - "connection_count": 3,
- "destroyed": true,
- "host_group": {
- "name": "string"
}, - "iqns": [
- "iqn.2010-06.com.purestorage:linux.393d930077be2977"
], - "is_local": true,
- "nqns": [
- "nqn.2010-06.com.purestorage:flasharray.512f7bb185978505"
], - "personality": "string",
- "port_connectivity": {
- "details": "Redundant",
- "status": "healthy"
}, - "preferred_arrays": [
- {
- "id": "string",
- "name": "string"
}
], - "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0
}, - "time_remaining": 0,
- "vlan": "1",
- "wwns": [
- "52:4A:93:70:4E:E5:68:00"
]
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| 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. |
| modify_resource_access | string Describes how to modify a resource accesses of a resource when that resource is moved.
Possible values are: |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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. |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| 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 (ReferenceNoId) 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 |
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, | |
| 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. |
| vlan | string The VLAN ID that the host is associated with.
If not set, there is no change in VLAN.
If set to |
| wwns | Array of strings The Fibre Channel World Wide Name (WWN) associated with the host. |
{- "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"
], - "vlan": "1",
- "wwns": [
- "52:4A:93:70:4E:E5:68:00"
]
}{- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "chap": {
- "host_password": "string",
- "host_user": "string",
- "target_password": "string",
- "target_user": "string"
}, - "connection_count": 3,
- "destroyed": true,
- "host_group": {
- "name": "string"
}, - "iqns": [
- "iqn.2010-06.com.purestorage:linux.393d930077be2977"
], - "is_local": true,
- "nqns": [
- "nqn.2010-06.com.purestorage:flasharray.512f7bb185978505"
], - "personality": "string",
- "port_connectivity": {
- "details": "Redundant",
- "status": "healthy"
}, - "preferred_arrays": [
- {
- "id": "string",
- "name": "string"
}
], - "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0
}, - "time_remaining": 0,
- "vlan": "1",
- "wwns": [
- "52:4A:93:70:4E:E5:68:00"
]
}
]
}Displays a list of hosts that are associated with host groups.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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, |
| 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 |
| 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, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "group": {
- "name": "string"
}, - "member": {
- "name": "string"
}
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Creates a membership to a host group.
Creating a membership 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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| 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, |
| 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, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "group": {
- "name": "string"
}, - "member": {
- "name": "string"
}
}
]
}Deletes a membership from a host group.
Deleting a membership from a host group automatically
disconnects the host from all volumes associated with the group.
Hosts can be deleted 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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| 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, |
| 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, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
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.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| end_time | integer <int64> Displays historical performance data for the specified time window,
where |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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. |
| resolution | integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data.
For array-wide performance metrics ( |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| start_time | integer <int64> Displays historical performance data for the specified time window,
where |
| total_item_count | boolean If set to |
| total_only | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
], - "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_read_op_cache_reduction": 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,
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "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_read_op_cache_reduction": 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,
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}Displays the I/O balance statistics for host paths.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
], - "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "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"
}, - "op_count": 0,
- "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
}
]
}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.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| end_time | integer <int64> Displays historical performance data for the specified time window,
where |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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. |
| resolution | integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data.
For array-wide performance metrics ( |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| start_time | integer <int64> Displays historical performance data for the specified time window,
where |
| total_item_count | boolean If set to |
| total_only | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
], - "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_read_op_cache_reduction": 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,
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "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_read_op_cache_reduction": 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,
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "array": {
- "id": "string",
- "name": "string"
}
}
]
}Displays a list of host members that belong to one or more protection groups.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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, |
| 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 |
| 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, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "group": {
- "id": "string",
- "name": "string"
}, - "member": {
- "name": "string"
}
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| 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, |
| 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, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "group": {
- "id": "string",
- "name": "string"
}, - "member": {
- "name": "string"
}
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| 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, |
| 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, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Displays provisioned size and physical storage consumption data for each host.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
], - "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0
}, - "time": 0
}
]
}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.
Displays the list of KMIP server objects.
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "ca_certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
- "certificate": {
- "name": "string"
}, - "kmip_objects": [
- {
- "name": "string",
- "uid": "string"
}
], - "name": "string",
- "uris": [
- "1.1.1.1:8888",
- "2.2.2.2:9999"
]
}
]
}Creates KMIP server objects.
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| ca_certificate | string <= 3000 characters The text of the CA certificate for the KMIP server. |
object (ReferenceNoId) The certificate used to verify FlashArray authenticity to the KMIP servers. | |
| uris | Array of strings List of URIs for the configured KMIP servers. |
{- "ca_certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
- "certificate": {
- "name": "string"
}, - "uris": [
- "1.1.1.1:8888",
- "2.2.2.2:9999"
]
}{- "items": [
- {
- "ca_certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
- "certificate": {
- "name": "string"
}, - "kmip_objects": [
- {
- "name": "string",
- "uid": "string"
}
], - "name": "string",
- "uris": [
- "1.1.1.1:8888",
- "2.2.2.2:9999"
]
}
]
}Deletes KMIP server objects.
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Modifies one or more attributes of KMIP server objects.
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| ca_certificate | string <= 3000 characters The text of the CA certificate for the KMIP server. |
object (ReferenceNoId) The certificate used to verify FlashArray authenticity to the KMIP servers. | |
| uris | Array of strings List of URIs for the configured KMIP servers. |
{- "ca_certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
- "certificate": {
- "name": "string"
}, - "uris": [
- "1.1.1.1:8888",
- "2.2.2.2:9999"
]
}{- "items": [
- {
- "ca_certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
- "certificate": {
- "name": "string"
}, - "kmip_objects": [
- {
- "name": "string",
- "uid": "string"
}
], - "name": "string",
- "uris": [
- "1.1.1.1:8888",
- "2.2.2.2:9999"
]
}
]
}Displays communication data between a FlashArray and KMIP server.
| names required | Array of strings Performs the operation on the unique name specified.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "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"
}
]
}Displays a list of configured log targets.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "target_type": "syslog"
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Displays a list of configured file log targets.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "target_type": "syslog",
- "directory": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "keep_for": 86400000,
- "keep_size": 1000000
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Creates a new file log target.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
object (FixedReferenceWithType) The context in which the operation was performed.
Valid values include a reference to any array which is a member of the same fleet.
If the array is not a member of a fleet, Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided | |
object (ReferenceWithType) 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.
Default value is |
| 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.
Default value is |
{- "context": { },
- "directory": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "keep_for": 86400000,
- "keep_size": 1000000
}{- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "target_type": "syslog",
- "directory": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "keep_for": 86400000,
- "keep_size": 1000000
}
]
}Deletes a configured file log target.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Modifies the URI of a configured file log target.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
object (FixedReferenceWithType) The context in which the operation was performed.
Valid values include a reference to any array which is a member of the same fleet.
If the array is not a member of a fleet, Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided | |
object (ReferenceWithType) 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.
Default value is |
| 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.
Default value is |
{- "context": { },
- "directory": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "keep_for": 86400000,
- "keep_size": 1000000
}{- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "target_type": "syslog",
- "directory": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "keep_for": 86400000,
- "keep_size": 1000000
}
]
}Displays a list of configured syslog servers.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "target_type": "syslog",
- "services": [
- "string"
], - "uri": "tcp://my.syslogserver.com"
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Creates a new syslog server.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
object (FixedReferenceWithType) The context in which the operation was performed.
Valid values include a reference to any array which is a member of the same fleet.
If the array is not a member of a fleet, Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided | |
| services | Array of strings Valid values are |
| uri | string The URI of the syslog server in the format |
{- "context": { },
- "services": [
- "string"
], - "uri": "tcp://my.syslogserver.com"
}{- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "target_type": "syslog",
- "services": [
- "string"
], - "uri": "tcp://my.syslogserver.com"
}
]
}Deletes a configured syslog server and stop forwarding syslog messages.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Modifies the URI and services of a configured syslog server.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
object (FixedReferenceWithType) The context in which the operation was performed.
Valid values include a reference to any array which is a member of the same fleet.
If the array is not a member of a fleet, Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided | |
| services | Array of strings Valid values are |
| uri | string The URI of the syslog server in the format |
{- "context": { },
- "services": [
- "string"
], - "uri": "tcp://my.syslogserver.com"
}{- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "target_type": "syslog",
- "services": [
- "string"
], - "uri": "tcp://my.syslogserver.com"
}
]
}Displays syslog settings. Values include continuation_token, items,
more_items_remaining, and total_item_count.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "ca_certificate": "string",
- "logging_severity": "string",
- "tls_audit_enabled": true
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Modifies syslog settings. Values include continuation_token, items,
more_items_remaining, and total_item_count.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
object (FixedReferenceWithType) The context in which the operation was performed.
Valid values include a reference to any array which is a member of the same fleet.
If the array is not a member of a fleet, Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided | |
| 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. |
| 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 |
| tls_audit_enabled | boolean Returns a value of |
{- "context": { },
- "ca_certificate": "string",
- "logging_severity": "string",
- "tls_audit_enabled": true
}{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "ca_certificate": "string",
- "logging_severity": "string",
- "tls_audit_enabled": true
}
]
}Displays syslog server test results, which indicate whether the syslog is working and configured correctly.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "total_item_count": 0,
- "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
], - "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",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "resource": {
- "name": "string"
}
}
]
}During a maintenance window, alerts are suppressed that are related to connections, paths, ports, and other resources that are down during maintenance.
Displays maintenance window details, including start time, end time, and maintenance type.
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "created": 0,
- "expires": 0
}
]
}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.
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| 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 |
{- "timeout": 3600000
}{- "items": [
- {
- "name": "string",
- "created": 0,
- "expires": 0
}
]
}Deletes an open maintenance window before its scheduled end (expire) time.
The names parameter is required and must be set to environment.
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Displays all network interfaces for all controllers on the array.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "attached_servers": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "enabled": true,
- "eth": {
- "address": "string",
- "gateway": "string",
- "mac_address": "string",
- "mtu": 0,
- "netmask": "string",
- "subinterfaces": [
- {
- "name": "string"
}
], - "subnet": {
- "name": "string"
}, - "subtype": "string",
- "vlan": 0
}, - "fc": {
- "wwn": "string"
}, - "interface_type": "string",
- "services": [
- "string"
], - "speed": 0
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Creates a network interface on a controller on the array.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Array of objects (_reference) <= 1 items Applicable only to Ethernet interfaces.
List of servers to be associated with the specified network interface for data ingress.
At most one server can be specified for each interface. To attach the network
interface to a server, | |
object (_networkinterfacepostEth) Ethernet network interface properties. | |
| services | Array of strings The services provided by the specified network interface or Fibre Channel port. |
{- "attached_servers": [
- {
- "id": "string",
- "name": "string"
}
], - "eth": {
- "address": "string",
- "subinterfaces": [
- {
- "name": "string"
}
], - "subnet": {
- "name": "string"
}, - "subtype": "string"
}, - "services": [
- "string"
]
}{- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "attached_servers": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "enabled": true,
- "eth": {
- "address": "string",
- "gateway": "string",
- "mac_address": "string",
- "mtu": 0,
- "netmask": "string",
- "subinterfaces": [
- {
- "name": "string"
}
], - "subnet": {
- "name": "string"
}, - "subtype": "string",
- "vlan": 0
}, - "fc": {
- "wwn": "string"
}, - "interface_type": "string",
- "services": [
- "string"
], - "speed": 0
}
]
}Deletes a network interface on a controller.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Modifies a network interface on a controller.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Array of objects (_reference) <= 1 items Applicable only to Ethernet interfaces.
List of servers to be associated with the specified network interface for data ingress.
At most one server can be specified for each interface. To attach the network
interface to a server, | |
| enabled | boolean Returns a value of |
object (_networkinterfacepatchEth) Ethernet network interface properties. | |
| 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. |
{- "attached_servers": [
- {
- "id": "string",
- "name": "string"
}
], - "enabled": true,
- "eth": {
- "add_subinterfaces": [
- {
- "name": "string"
}
], - "address": "string",
- "gateway": "string",
- "mtu": 0,
- "netmask": "string",
- "remove_subinterfaces": [
- {
- "name": "string"
}
], - "subinterfaces": [
- {
- "name": "string"
}
], - "subnet": {
- "name": "string"
}
}, - "override_npiv_check": true,
- "services": [
- "string"
]
}{- "items": [
- {
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "attached_servers": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "enabled": true,
- "eth": {
- "address": "string",
- "gateway": "string",
- "mac_address": "string",
- "mtu": 0,
- "netmask": "string",
- "subinterfaces": [
- {
- "name": "string"
}
], - "subnet": {
- "name": "string"
}, - "subtype": "string",
- "vlan": 0
}, - "fc": {
- "wwn": "string"
}, - "interface_type": "string",
- "services": [
- "string"
], - "speed": 0
}
]
}Displays all neighbors for all network interfaces on the array.
| 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 |
| 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, |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "initial_ttl_in_sec": 120,
- "local_port": {
- "name": "string"
}, - "neighbor_chassis": {
- "addresses": [
- "10.202.101.70"
], - "bridge": {
- "enabled": false,
- "supported": false
}, - "description": "Example Switch iscsi-sw-100-b version 1.0",
- "docsis_cable_device": {
- "enabled": false,
- "supported": false
}, - "id": {
- "type": "mac",
- "value": "00:12:ab:cd:ab:cd"
}, - "name": "iscsi-sw-100-b.example.com",
- "repeater": {
- "enabled": false,
- "supported": false
}, - "router": {
- "enabled": false,
- "supported": false
}, - "station_only": {
- "enabled": false,
- "supported": false
}, - "telephone": {
- "enabled": false,
- "supported": false
}, - "wlan_access_point": {
- "enabled": false,
- "supported": false
}
}, - "neighbor_port": {
- "description": "eth7",
- "id": {
- "type": "ifname",
- "value": "Ethernet7"
}
}
}
]
}Displays network statistics, historical bandwidth, and error reporting for all specified network interfaces.
| end_time | integer <int64> Displays historical performance data for the specified time window,
where |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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. |
| resolution | integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data.
For array-wide performance metrics ( |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| start_time | integer <int64> Displays historical performance data for the specified time window,
where |
| total_item_count | boolean If set to |
| total_only | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "eth": {
- "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,
- "other_errors_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,
- "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
}, - "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
}, - "interface_type": "string",
- "time": 0
}
], - "total": [
- {
- "name": "string",
- "eth": {
- "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,
- "other_errors_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,
- "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
}, - "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
}, - "interface_type": "string",
- "time": 0
}
]
}Displays Ethernet and Fibre Channel SFP details.
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "name": "string",
- "interface_type": "string",
- "rx_los": [
- {
- "channel": 0,
- "flag": true
}
], - "rx_power": [
- {
- "channel": 0,
- "measurement": 0,
- "status": "ok"
}
], - "static": {
- "cable_technology": [
- "Active Cable"
], - "connector_type": "LC",
- "encoding": "64B/66B",
- "extended_identifier": "GBIC/SFP function is defined by 2-wire interface ID only",
- "fc_link_lengths": [
- "short distance (S)"
], - "fc_speeds": "16|32|64 Gb/s",
- "fc_technology": [
- "Electrical intra-enclosure (EL)"
], - "fc_transmission_media": [
- "Multimode, 62.5um (M6)"
], - "identifier": "SFP or SFP+",
- "link_length": "OM2: 40 m, OM1: 20 m, OM3: 100 m",
- "rate_identifier": "FC-PI-5 (16/8/4G Independent Rx, Tx Rate_select)",
- "rx_power_thresholds": {
- "alarm_high": 0,
- "alarm_low": 0,
- "warn_high": 0,
- "warn_low": 0
}, - "signaling_rate": "14000 MBd",
- "signaling_rate_max": "1%",
- "signaling_rate_min": "1%",
- "specifications": [
- "1000BASE-T"
], - "temperature_thresholds": {
- "alarm_high": 0,
- "alarm_low": 0,
- "warn_high": 0,
- "warn_low": 0
}, - "tx_bias_thresholds": {
- "alarm_high": 0,
- "alarm_low": 0,
- "warn_high": 0,
- "warn_low": 0
}, - "tx_power_thresholds": {
- "alarm_high": 0,
- "alarm_low": 0,
- "warn_high": 0,
- "warn_low": 0
}, - "vendor_date_code": "190221",
- "vendor_name": "EMULEX",
- "vendor_oui": "00-17-6A",
- "vendor_part_number": "ABCD-12E3FG-ELX",
- "vendor_revision": "stri",
- "vendor_serial_number": "AB1234C56DE",
- "voltage_thresholds": {
- "alarm_high": 0,
- "alarm_low": 0,
- "warn_high": 0,
- "warn_low": 0
}, - "wavelength": "850 nm"
}, - "temperature": [
- {
- "channel": 0,
- "measurement": 0,
- "status": "ok"
}
], - "tx_bias": [
- {
- "channel": 0,
- "measurement": 0,
- "status": "ok"
}
], - "tx_fault": [
- {
- "channel": 0,
- "flag": true
}
], - "tx_power": [
- {
- "channel": 0,
- "measurement": 0,
- "status": "ok"
}
], - "voltage": [
- {
- "channel": 0,
- "measurement": 0,
- "status": "ok"
}
]
}
]
}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.
Displays a list of offload targets that are connected to the array.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| total_item_count | boolean If set to |
| total_only | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "azure": {
- "account_name": "string",
- "container_name": "string",
- "profile": "string",
- "secret_access_key": "string"
}, - "google-cloud": {
- "access_key_id": "string",
- "bucket": "string",
- "profile": "string",
- "secret_access_key": "string"
}, - "nfs": {
- "address": "string",
- "mount_options": "string",
- "mount_point": "string",
- "profile": "string"
}, - "s3": {
- "access_key_id": "string",
- "auth_region": "string",
- "bucket": "string",
- "placement_strategy": "string",
- "profile": "string",
- "secret_access_key": "string",
- "uri": "string"
}, - "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "protocol": "string",
- "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0
}, - "status": "string",
- "target_id": "string"
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
], - "total": [
- {
- "azure": {
- "account_name": "string",
- "container_name": "string",
- "profile": "string",
- "secret_access_key": "string"
}, - "google-cloud": {
- "access_key_id": "string",
- "bucket": "string",
- "profile": "string",
- "secret_access_key": "string"
}, - "nfs": {
- "address": "string",
- "mount_options": "string",
- "mount_point": "string",
- "profile": "string"
}, - "s3": {
- "access_key_id": "string",
- "auth_region": "string",
- "bucket": "string",
- "placement_strategy": "string",
- "profile": "string",
- "secret_access_key": "string",
- "uri": "string"
}, - "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "protocol": "string",
- "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0
}, - "status": "string",
- "target_id": "string"
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| initialize | boolean If set to |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
object (Offload_azure) Microsoft Azure Blob storage settings. | |
object (OffloadGoogleCloud) Google Cloud Storage settings. | |
object (Offload_nfs) NFS settings. Deprecated from version 6.6.0 onwards - Contact support for additional information. | |
object (Offload_s3) S3 settings. |
{- "azure": {
- "account_name": "string",
- "container_name": "string",
- "profile": "string",
- "secret_access_key": "string"
}, - "google-cloud": {
- "access_key_id": "string",
- "bucket": "string",
- "profile": "string",
- "secret_access_key": "string"
}, - "nfs": {
- "address": "string",
- "mount_options": "string",
- "mount_point": "string",
- "profile": "string"
}, - "s3": {
- "access_key_id": "string",
- "auth_region": "string",
- "bucket": "string",
- "placement_strategy": "string",
- "profile": "string",
- "secret_access_key": "string",
- "uri": "string"
}
}{- "items": [
- {
- "azure": {
- "account_name": "string",
- "container_name": "string",
- "profile": "string",
- "secret_access_key": "string"
}, - "google-cloud": {
- "access_key_id": "string",
- "bucket": "string",
- "profile": "string",
- "secret_access_key": "string"
}, - "nfs": {
- "address": "string",
- "mount_options": "string",
- "mount_point": "string",
- "profile": "string"
}, - "s3": {
- "access_key_id": "string",
- "auth_region": "string",
- "bucket": "string",
- "placement_strategy": "string",
- "profile": "string",
- "secret_access_key": "string",
- "uri": "string"
}, - "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "protocol": "string",
- "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0
}, - "status": "string",
- "target_id": "string"
}
]
}Deletes an offload target.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Displays a list of workload presets.
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "description": "string",
- "parameters": [
- {
- "constraints": {
- "boolean": {
- "default": true
}, - "integer": {
- "allowed_values": [
- 0
], - "default": 0,
- "maximum": 0,
- "minimum": 0
}, - "resource_reference": {
- "allowed_values": [
- {
- "resource_type": "string"
}
], - "default": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "string": {
- "allowed_values": [
- "string"
], - "default": "string"
}
}, - "metadata": {
- "description": "string",
- "display_name": "Billing ID",
- "subtype": "string"
}, - "name": "billing-id",
- "type": "string"
}
], - "periodic_replication_configurations": [
- {
- "name": "string",
- "remote_targets": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "rules": [
- {
- "at": "string",
- "every": "string",
- "keep_for": "string"
}
]
}
], - "placement_configurations": [
- {
- "name": "string",
- "qos_configurations": [
- "string"
], - "storage_class": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "qos_configurations": [
- {
- "bandwidth_limit": "string",
- "iops_limit": "string",
- "name": "string"
}
], - "revision": 0,
- "snapshot_configurations": [
- {
- "name": "string",
- "rules": [
- {
- "at": "string",
- "every": "string",
- "keep_for": "string"
}
]
}
], - "volume_configurations": [
- {
- "count": "string",
- "name": "string",
- "periodic_replication_configurations": [
- "string"
], - "placement_configurations": [
- "string"
], - "provisioned_size": "string",
- "snapshot_configurations": [
- "string"
]
}
], - "workload_tags": [
- {
- "copyable": "true",
- "key": "environment",
- "namespace": "default",
- "value": "staging"
}
], - "workload_type": "string"
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Updates a workload preset by replacing it with the new contents in preset.
The ids or names parameter is required, but they cannot be set together.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| ids | Array of strings Performs the operation on the unique resource IDs specified. Only one value is supported. |
| names | Array of strings Performs the operation on the unique resource names specified. Only one value is supported. |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| name | string A user-specified name. The name must be locally unique and can be changed. |
object (FixedReferenceWithType) The context in which the operation was performed.
Valid values include a reference to any array which is a member of the same fleet.
If the array is not a member of a fleet, Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided | |
| description | string A brief description of the workload the preset will configure. Supports up to 1KB of unicode characters. |
Array of objects (_presetWorkloadParameter) The parameters to prompt the user when they deploy workloads from the preset. | |
Array of objects (_presetWorkloadPeriodicReplicationConfiguration) <= 2 items The periodic replication configurations that can be applied to storage resources (such as volumes) within the preset. | |
required | Array of objects (_presetWorkloadPlacementConfiguration) 1 items The placement configurations that can be applied to storage resources (such as volumes) within the preset. All storage resources associated with the same placement will be colocated on the same array. |
Array of objects (_presetWorkloadQosConfiguration) <= 5 items The QoS configurations that can be applied to storage resources (such as volumes) within the preset. | |
Array of objects (_presetWorkloadSnapshotConfiguration) <= 2 items The snapshot configurations that can be applied to storage resources (such as volumes) within the preset. | |
required | Array of objects (_presetWorkloadVolumeConfiguration) [ 1 .. 5 ] items The volumes that will be provisioned by the preset. |
Array of objects (_presetWorkloadWorkloadTag) The tags that will be associated with workloads provisioned by the preset. | |
| workload_type required | string The type of workload the preset will configure. Valid values include |
{- "name": "string",
- "context": { },
- "description": "string",
- "parameters": [
- {
- "constraints": {
- "boolean": {
- "default": true
}, - "integer": {
- "allowed_values": [
- 0
], - "default": 0,
- "maximum": 0,
- "minimum": 0
}, - "resource_reference": {
- "allowed_values": [
- {
- "resource_type": "string"
}
], - "default": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "string": {
- "allowed_values": [
- "string"
], - "default": "string"
}
}, - "metadata": {
- "description": "string",
- "display_name": "Billing ID",
- "subtype": "string"
}, - "name": "billing-id",
- "type": "string"
}
], - "periodic_replication_configurations": [
- {
- "name": "string",
- "remote_targets": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "rules": [
- {
- "at": "string",
- "every": "string",
- "keep_for": "string"
}
]
}
], - "placement_configurations": [
- {
- "name": "string",
- "qos_configurations": [
- "string"
], - "storage_class": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "qos_configurations": [
- {
- "bandwidth_limit": "string",
- "iops_limit": "string",
- "name": "string"
}
], - "snapshot_configurations": [
- {
- "name": "string",
- "rules": [
- {
- "at": "string",
- "every": "string",
- "keep_for": "string"
}
]
}
], - "volume_configurations": [
- {
- "count": "string",
- "name": "string",
- "periodic_replication_configurations": [
- "string"
], - "placement_configurations": [
- "string"
], - "provisioned_size": "string",
- "snapshot_configurations": [
- "string"
]
}
], - "workload_tags": [
- {
- "copyable": "true",
- "key": "environment",
- "namespace": "default",
- "value": "staging"
}
], - "workload_type": "string"
}{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "description": "string",
- "parameters": [
- {
- "constraints": {
- "boolean": {
- "default": true
}, - "integer": {
- "allowed_values": [
- 0
], - "default": 0,
- "maximum": 0,
- "minimum": 0
}, - "resource_reference": {
- "allowed_values": [
- {
- "resource_type": "string"
}
], - "default": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "string": {
- "allowed_values": [
- "string"
], - "default": "string"
}
}, - "metadata": {
- "description": "string",
- "display_name": "Billing ID",
- "subtype": "string"
}, - "name": "billing-id",
- "type": "string"
}
], - "periodic_replication_configurations": [
- {
- "name": "string",
- "remote_targets": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "rules": [
- {
- "at": "string",
- "every": "string",
- "keep_for": "string"
}
]
}
], - "placement_configurations": [
- {
- "name": "string",
- "qos_configurations": [
- "string"
], - "storage_class": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "qos_configurations": [
- {
- "bandwidth_limit": "string",
- "iops_limit": "string",
- "name": "string"
}
], - "revision": 0,
- "snapshot_configurations": [
- {
- "name": "string",
- "rules": [
- {
- "at": "string",
- "every": "string",
- "keep_for": "string"
}
]
}
], - "volume_configurations": [
- {
- "count": "string",
- "name": "string",
- "periodic_replication_configurations": [
- "string"
], - "placement_configurations": [
- "string"
], - "provisioned_size": "string",
- "snapshot_configurations": [
- "string"
]
}
], - "workload_tags": [
- {
- "copyable": "true",
- "key": "environment",
- "namespace": "default",
- "value": "staging"
}
], - "workload_type": "string"
}
]
}Creates one workload preset.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| names required | Array of strings Performs the operation on the unique resource names specified. Only one value is supported. |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| description | string A brief description of the workload the preset will configure. Supports up to 1KB of unicode characters. |
Array of objects (_presetWorkloadParameter) The parameters to prompt the user when they deploy workloads from the preset. | |
Array of objects (_presetWorkloadPeriodicReplicationConfiguration) <= 2 items The periodic replication configurations that can be applied to storage resources (such as volumes) within the preset. | |
required | Array of objects (_presetWorkloadPlacementConfiguration) 1 items The placement configurations that can be applied to storage resources (such as volumes) within the preset. All storage resources associated with the same placement will be colocated on the same array. |
Array of objects (_presetWorkloadQosConfiguration) <= 5 items The QoS configurations that can be applied to storage resources (such as volumes) within the preset. | |
Array of objects (_presetWorkloadSnapshotConfiguration) <= 2 items The snapshot configurations that can be applied to storage resources (such as volumes) within the preset. | |
required | Array of objects (_presetWorkloadVolumeConfiguration) [ 1 .. 5 ] items The volumes that will be provisioned by the preset. |
Array of objects (_presetWorkloadWorkloadTag) The tags that will be associated with workloads provisioned by the preset. | |
| workload_type required | string The type of workload the preset will configure. Valid values include |
{- "description": "string",
- "parameters": [
- {
- "constraints": {
- "boolean": {
- "default": true
}, - "integer": {
- "allowed_values": [
- 0
], - "default": 0,
- "maximum": 0,
- "minimum": 0
}, - "resource_reference": {
- "allowed_values": [
- {
- "resource_type": "string"
}
], - "default": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "string": {
- "allowed_values": [
- "string"
], - "default": "string"
}
}, - "metadata": {
- "description": "string",
- "display_name": "Billing ID",
- "subtype": "string"
}, - "name": "billing-id",
- "type": "string"
}
], - "periodic_replication_configurations": [
- {
- "name": "string",
- "remote_targets": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "rules": [
- {
- "at": "string",
- "every": "string",
- "keep_for": "string"
}
]
}
], - "placement_configurations": [
- {
- "name": "string",
- "qos_configurations": [
- "string"
], - "storage_class": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "qos_configurations": [
- {
- "bandwidth_limit": "string",
- "iops_limit": "string",
- "name": "string"
}
], - "snapshot_configurations": [
- {
- "name": "string",
- "rules": [
- {
- "at": "string",
- "every": "string",
- "keep_for": "string"
}
]
}
], - "volume_configurations": [
- {
- "count": "string",
- "name": "string",
- "periodic_replication_configurations": [
- "string"
], - "placement_configurations": [
- "string"
], - "provisioned_size": "string",
- "snapshot_configurations": [
- "string"
]
}
], - "workload_tags": [
- {
- "copyable": "true",
- "key": "environment",
- "namespace": "default",
- "value": "staging"
}
], - "workload_type": "string"
}{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "description": "string",
- "parameters": [
- {
- "constraints": {
- "boolean": {
- "default": true
}, - "integer": {
- "allowed_values": [
- 0
], - "default": 0,
- "maximum": 0,
- "minimum": 0
}, - "resource_reference": {
- "allowed_values": [
- {
- "resource_type": "string"
}
], - "default": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "string": {
- "allowed_values": [
- "string"
], - "default": "string"
}
}, - "metadata": {
- "description": "string",
- "display_name": "Billing ID",
- "subtype": "string"
}, - "name": "billing-id",
- "type": "string"
}
], - "periodic_replication_configurations": [
- {
- "name": "string",
- "remote_targets": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "rules": [
- {
- "at": "string",
- "every": "string",
- "keep_for": "string"
}
]
}
], - "placement_configurations": [
- {
- "name": "string",
- "qos_configurations": [
- "string"
], - "storage_class": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "qos_configurations": [
- {
- "bandwidth_limit": "string",
- "iops_limit": "string",
- "name": "string"
}
], - "revision": 0,
- "snapshot_configurations": [
- {
- "name": "string",
- "rules": [
- {
- "at": "string",
- "every": "string",
- "keep_for": "string"
}
]
}
], - "volume_configurations": [
- {
- "count": "string",
- "name": "string",
- "periodic_replication_configurations": [
- "string"
], - "placement_configurations": [
- "string"
], - "provisioned_size": "string",
- "snapshot_configurations": [
- "string"
]
}
], - "workload_tags": [
- {
- "copyable": "true",
- "key": "environment",
- "namespace": "default",
- "value": "staging"
}
], - "workload_type": "string"
}
]
}Deletes a workload preset permanently.
The ids or names parameter is required, but they cannot be set together.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| ids | Array of strings Performs the operation on the unique resource IDs specified. Only one value is supported. |
| names | Array of strings Performs the operation on the unique resource names specified. Only one value is supported. |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Modifies a workload preset by overriding the fields specified in preset.
To rename a workload preset, set name to the new name.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| ids | Array of strings Performs the operation on the unique resource IDs specified. Only one value is supported. |
| names | Array of strings Performs the operation on the unique resource names specified. Only one value is supported. |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| name | string The new name for the resource. |
{- "name": "string"
}{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "description": "string",
- "parameters": [
- {
- "constraints": {
- "boolean": {
- "default": true
}, - "integer": {
- "allowed_values": [
- 0
], - "default": 0,
- "maximum": 0,
- "minimum": 0
}, - "resource_reference": {
- "allowed_values": [
- {
- "resource_type": "string"
}
], - "default": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}, - "string": {
- "allowed_values": [
- "string"
], - "default": "string"
}
}, - "metadata": {
- "description": "string",
- "display_name": "Billing ID",
- "subtype": "string"
}, - "name": "billing-id",
- "type": "string"
}
], - "periodic_replication_configurations": [
- {
- "name": "string",
- "remote_targets": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "rules": [
- {
- "at": "string",
- "every": "string",
- "keep_for": "string"
}
]
}
], - "placement_configurations": [
- {
- "name": "string",
- "qos_configurations": [
- "string"
], - "storage_class": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "qos_configurations": [
- {
- "bandwidth_limit": "string",
- "iops_limit": "string",
- "name": "string"
}
], - "revision": 0,
- "snapshot_configurations": [
- {
- "name": "string",
- "rules": [
- {
- "at": "string",
- "every": "string",
- "keep_for": "string"
}
]
}
], - "volume_configurations": [
- {
- "count": "string",
- "name": "string",
- "periodic_replication_configurations": [
- "string"
], - "placement_configurations": [
- "string"
], - "provisioned_size": "string",
- "snapshot_configurations": [
- "string"
]
}
], - "workload_tags": [
- {
- "copyable": "true",
- "key": "environment",
- "namespace": "default",
- "value": "staging"
}
], - "workload_type": "string"
}
]
}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.
Displays a list of pods that are stretched to this array.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| destroyed | boolean If set to If object name(s) or id(s) are specified, then each object referenced must exist.
If |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| total_item_count | boolean If set to |
| total_only | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "array_count": 1,
- "arrays": [
- {
- "id": "string",
- "name": "string",
- "frozen_at": 1492662000,
- "mediator_status": "string",
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "pre_elected": true,
- "progress": 0.66,
- "status": "resyncing"
}
], - "destroyed": true,
- "eradication_config": {
- "manual_eradication": "all-enabled"
}, - "failover_preferences": [
- {
- "id": "string",
- "name": "string"
}
], - "footprint": 0,
- "link_source_count": 1,
- "link_target_count": 1,
- "mediator_version": "1.0.0",
- "members": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "promotion_status": "string",
- "quota_limit": 0,
- "requested_promotion_state": "string",
- "source": {
- "id": "string",
- "name": "string"
}, - "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0,
- "replication": 0,
- "replication_effective": 0,
- "shared_effective": 0
}, - "time_remaining": 0
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
], - "total": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "array_count": 1,
- "arrays": [
- {
- "id": "string",
- "name": "string",
- "frozen_at": 1492662000,
- "mediator_status": "string",
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "pre_elected": true,
- "progress": 0.66,
- "status": "resyncing"
}
], - "destroyed": true,
- "eradication_config": {
- "manual_eradication": "all-enabled"
}, - "failover_preferences": [
- {
- "id": "string",
- "name": "string"
}
], - "footprint": 0,
- "link_source_count": 1,
- "link_target_count": 1,
- "mediator_version": "1.0.0",
- "members": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "promotion_status": "string",
- "quota_limit": 0,
- "requested_promotion_state": "string",
- "source": {
- "id": "string",
- "name": "string"
}, - "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0,
- "replication": 0,
- "replication_effective": 0,
- "shared_effective": 0
}, - "time_remaining": 0
}
]
}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.
| allow_throttle | boolean If set to |
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
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, | |
| quota_limit | integer <int64> [ 1048576 .. 4503599627370496 ] The logical quota limit of the pod, measured in bytes. Must be a multiple of 512. |
object (Reference) The source pod from where data is cloned to create the new pod. | |
Array of objects (Tag) The list of tags to be upserted with the object. |
{- "failover_preferences": [
- {
- "id": "string",
- "name": "string"
}
], - "quota_limit": 1048576,
- "source": {
- "id": "string",
- "name": "string"
}, - "tags": [
- {
- "context": { },
- "copyable": true,
- "key": "environment",
- "namespace": "default",
- "resource": { },
- "value": "staging"
}
]
}{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "array_count": 1,
- "arrays": [
- {
- "id": "string",
- "name": "string",
- "frozen_at": 1492662000,
- "mediator_status": "string",
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "pre_elected": true,
- "progress": 0.66,
- "status": "resyncing"
}
], - "destroyed": true,
- "eradication_config": {
- "manual_eradication": "all-enabled"
}, - "failover_preferences": [
- {
- "id": "string",
- "name": "string"
}
], - "footprint": 0,
- "link_source_count": 1,
- "link_target_count": 1,
- "mediator_version": "1.0.0",
- "members": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "promotion_status": "string",
- "quota_limit": 0,
- "requested_promotion_state": "string",
- "source": {
- "id": "string",
- "name": "string"
}, - "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0,
- "replication": 0,
- "replication_effective": 0,
- "shared_effective": 0
}, - "time_remaining": 0
}
]
}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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| eradicate_contents | boolean Set to |
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
Modifies pod details.
| abort_quiesce | boolean Set to |
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| destroy_contents | boolean Set to |
| 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. |
| ids | Array of strings Performs the operation on the unique resource IDs specified.
Enter multiple resource IDs in comma-separated format.
The |
| 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. |
| 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. |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| promote_from | string The |
| quiesce | boolean Set to |
| skip_quiesce | boolean Set to |
| 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. |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
| name | string A user-specified name. The name must be locally unique and can be changed. |
| destroyed | boolean If set to |
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, | |
| ignore_usage | boolean Set to |
| mediator | string Sets the URL of the mediator for this pod, replacing the URL of the current mediator.
By default, the Pure1 Cloud Mediator ( |
| quota_limit | integer <int64> [ 1048576 .. 4503599627370496 ] The logical quota limit of the pod, measured in bytes. Must be a multiple of 512. |
| requested_promotion_state | string Patch |
{- "name": "string",
- "destroyed": true,
- "failover_preferences": [
- {
- "id": "string",
- "name": "string"
}
], - "ignore_usage": true,
- "quota_limit": 1048576,
- "requested_promotion_state": "string"
}{- "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "array_count": 1,
- "arrays": [
- {
- "id": "string",
- "name": "string",
- "frozen_at": 1492662000,
- "mediator_status": "string",
- "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "pre_elected": true,
- "progress": 0.66,
- "status": "resyncing"
}
], - "destroyed": true,
- "eradication_config": {
- "manual_eradication": "all-enabled"
}, - "failover_preferences": [
- {
- "id": "string",
- "name": "string"
}
], - "footprint": 0,
- "link_source_count": 1,
- "link_target_count": 1,
- "mediator_version": "1.0.0",
- "members": [
- {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
], - "promotion_status": "string",
- "quota_limit": 0,
- "requested_promotion_state": "string",
- "source": {
- "id": "string",
- "name": "string"
}, - "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0,
- "replication": 0,
- "replication_effective": 0,
- "shared_effective": 0
}, - "time_remaining": 0
}
]
}Displays 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.
(Deprecated) Use pods/members instead.)
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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, |
| 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 |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| 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 |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "group": {
- "id": "string",
- "name": "string"
}, - "member": {
- "id": "string",
- "name": "string"
}
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Creates a pod to be stretched 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.
(Deprecated) Use pods/members instead.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| 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, |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "group": {
- "id": "string",
- "name": "string"
}, - "member": {
- "id": "string",
- "name": "string"
}
}
]
}Deletes a pod that was stretchd to 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 restretched 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 restretched 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.
(Deprecated) Use pods/members instead.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| 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, |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| with_unknown | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
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.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| 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 |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| 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_ids | Array of strings A comma-separated list of pod IDs. |
| pod_names | Array of strings Performs the operation on the unique pod name specified.
Enter multiple names in comma-separated format. For example, |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| total_item_count | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "pod": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Creates a pod to be stretched to a member.
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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| pod_ids | Array of strings A comma-separated list of pod IDs. |
| pod_names | Array of strings Performs the operation on the unique pod name specified.
Enter multiple names in comma-separated format. For example, |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "member": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "pod": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}
}
]
}Deletes a stretched 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 restretched pod represents a point-in-time snapshot of the pod,
just before it was unstretched.
The restretched pod enters an eradication pending period
starting from the time that the pod was unstretched.
A restretched 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.
| context_names | Array of strings Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided |
| member_ids | Array of strings Performs the operation on the unique member IDs specified.
Enter multiple member IDs in comma-separated format.
The |
| 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, |
| pod_ids | Array of strings A comma-separated list of pod IDs. |
| pod_names | Array of strings Performs the operation on the unique pod name specified.
Enter multiple names in comma-separated format. For example, |
| with_unknown | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
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.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| destroyed | boolean If set to If object name(s) or id(s) are specified, then each object referenced must exist.
If |
| end_time | integer <int64> Displays historical performance data for the specified time window,
where |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| protocol_group | string Protocol group type. Valid values are |
| resolution | integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data.
For array-wide performance metrics ( |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| start_time | integer <int64> Displays historical performance data for the specified time window,
where |
| total_item_count | boolean If set to |
| total_only | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
], - "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_read_op_cache_reduction": 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,
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "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_read_op_cache_reduction": 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,
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "others_per_sec": 0,
- "usec_per_other_op": 0
}
]
}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.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| destroyed | boolean If set to If object name(s) or id(s) are specified, then each object referenced must exist.
If |
| end_time | integer <int64> Displays historical performance data for the specified time window,
where |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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 |
| protocol_group | string Protocol group type. Valid values are |
| resolution | integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data.
For array-wide performance metrics ( |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| start_time | integer <int64> Displays historical performance data for the specified time window,
where |
| total_item_count | boolean If set to |
| total_only | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
], - "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_read_op_cache_reduction": 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,
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "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_read_op_cache_reduction": 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,
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "others_per_sec": 0,
- "usec_per_other_op": 0,
- "array": {
- "id": "string",
- "name": "string"
}
}
]
}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.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| destroyed | boolean If set to If object name(s) or id(s) are specified, then each object referenced must exist.
If |
| end_time | integer <int64> Displays historical performance data for the specified time window,
where |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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. |
| resolution | integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data.
For array-wide performance metrics ( |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| start_time | integer <int64> Displays historical performance data for the specified time window,
where |
| total_item_count | boolean If set to |
| total_only | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "continuous_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
}, - "pod": {
- "id": "string",
- "name": "string"
}, - "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
}, - "time": 0,
- "total_bytes_per_sec": 0
}
], - "total": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "continuous_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
}, - "pod": {
- "id": "string",
- "name": "string"
}, - "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
}, - "time": 0,
- "total_bytes_per_sec": 0
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}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.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| destroyed | boolean If set to If object name(s) or id(s) are specified, then each object referenced must exist.
If |
| end_time | integer <int64> Displays historical performance data for the specified time window,
where |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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. |
| resolution | integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data.
For array-wide performance metrics ( |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| start_time | integer <int64> Displays historical performance data for the specified time window,
where |
| total_item_count | boolean If set to |
| total_only | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "items": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "continuous_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
}, - "pod": {
- "id": "string",
- "name": "string"
}, - "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
}, - "time": 0,
- "total_bytes_per_sec": 0,
- "array": {
- "id": "string",
- "name": "string"
}
}
], - "total": [
- {
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "continuous_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
}, - "pod": {
- "id": "string",
- "name": "string"
}, - "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
}, - "time": 0,
- "total_bytes_per_sec": 0,
- "array": {
- "id": "string",
- "name": "string"
}
}
], - "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
]
}Displays provisioned size and physical storage consumption data for each pod on the local array.
| allow_errors | boolean Default: false If set to |
| context_names | Array of strings Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots,
are resolved relative to the provided Enter multiple names in comma-separated format.
For example, |
| 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 |
| destroyed | boolean If set to If object name(s) or id(s) are specified, then each object referenced must exist.
If |
| end_time | integer <int64> Displays historical performance data for the specified time window,
where |
| 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 |
| 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 |
| names | Array of strings Performs the operation on the unique name specified.
Enter multiple names in comma-separated format.
For example, |
| 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. |
| resolution | integer <int64> >= 0 Example: resolution=30000 The number of milliseconds between samples of historical data.
For array-wide performance metrics ( |
| sort | Array of strings Returns the response objects in the order specified.
Set |
| start_time | integer <int64> Displays historical performance data for the specified time window,
where |
| total_item_count | boolean If set to |
| total_only | boolean If set to |
| Authorization | string Access token (in JWT format) required to use any API
endpoint (except |
| X-Request-ID | string Supplied by client during request or generated by server. |
{- "continuation_token": "string",
- "more_items_remaining": false,
- "total_item_count": 0,
- "errors": [
- {
- "context": "<object_name>",
- "location_context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "message": "Object does not exist."
}
], - "items": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0,
- "replication": 0,
- "replication_effective": 0,
- "shared_effective": 0
}, - "time": 0
}
], - "total": [
- {
- "id": "string",
- "name": "string",
- "context": {
- "id": "string",
- "name": "string",
- "resource_type": "string"
}, - "space": {
- "data_reduction": 0,
- "footprint": 0,
- "shared": 111863360624,
- "snapshots": 0,
- "system": 0,
- "thin_provisioning": 0,
- "total_physical": 0,
- "total_provisioned": 19937690345472,
- "total_reduction": 0,
- "total_used": 0,
- "unique": 0,
- "used_provisioned": 19937690345472,
- "virtual": 0,
- "replication": 0,
- "replication_effective": 0,
- "shared_effective": 0
}, - "time": 0
}
]
}